5311c8c2afca15036c061919b2a7d08b1c4fe3b3
[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.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be 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 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "SUPPORT_TLS"
1890 .cindex "OpenSSL" "building Exim with"
1891 .cindex "GnuTLS" "building Exim with"
1892 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1893 command as per RFC 2487. It can also support legacy clients that expect to
1894 start a TLS session immediately on connection to a non-standard port (see the
1895 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1896 line option).
1897
1898 If you want to build Exim with TLS support, you must first install either the
1899 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1900 implementing SSL.
1901
1902 If OpenSSL is installed, you should set
1903 .code
1904 SUPPORT_TLS=yes
1905 TLS_LIBS=-lssl -lcrypto
1906 .endd
1907 in &_Local/Makefile_&. You may also need to specify the locations of the
1908 OpenSSL library and include files. For example:
1909 .code
1910 SUPPORT_TLS=yes
1911 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1912 TLS_INCLUDE=-I/usr/local/openssl/include/
1913 .endd
1914 .cindex "pkg-config" "OpenSSL"
1915 If you have &'pkg-config'& available, then instead you can just use:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_OPENSSL_PC=openssl
1919 .endd
1920 .cindex "USE_GNUTLS"
1921 If GnuTLS is installed, you should set
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1926 .endd
1927 in &_Local/Makefile_&, and again you may need to specify the locations of the
1928 library and include files. For example:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1933 TLS_INCLUDE=-I/usr/gnu/include
1934 .endd
1935 .cindex "pkg-config" "GnuTLS"
1936 If you have &'pkg-config'& available, then instead you can just use:
1937 .code
1938 SUPPORT_TLS=yes
1939 USE_GNUTLS=yes
1940 USE_GNUTLS_PC=gnutls
1941 .endd
1942
1943 You do not need to set TLS_INCLUDE if the relevant directory is already
1944 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1945 given in chapter &<<CHAPTLS>>&.
1946
1947
1948
1949
1950 .section "Use of tcpwrappers" "SECID27"
1951
1952 .cindex "tcpwrappers, building Exim to support"
1953 .cindex "USE_TCP_WRAPPERS"
1954 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1955 .cindex "tcp_wrappers_daemon_name"
1956 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1957 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1958 alternative to Exim's own checking facilities for installations that are
1959 already making use of &'tcpwrappers'& for other purposes. To do this, you
1960 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1961 &_tcpd.h_& to be available at compile time, and also ensure that the library
1962 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1963 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1964 you might have
1965 .code
1966 USE_TCP_WRAPPERS=yes
1967 CFLAGS=-O -I/usr/local/include
1968 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1969 .endd
1970 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1971 files is &"exim"&. For example, the line
1972 .code
1973 exim : LOCAL  192.168.1.  .friendly.domain.example
1974 .endd
1975 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1976 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1977 All other connections are denied. The daemon name used by &'tcpwrappers'&
1978 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1979 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1980 configure file. Consult the &'tcpwrappers'& documentation for
1981 further details.
1982
1983
1984 .section "Including support for IPv6" "SECID28"
1985 .cindex "IPv6" "including support for"
1986 Exim contains code for use on systems that have IPv6 support. Setting
1987 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1988 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1989 where the IPv6 support is not fully integrated into the normal include and
1990 library files.
1991
1992 Two different types of DNS record for handling IPv6 addresses have been
1993 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1994 currently seen as the mainstream. Another record type called A6 was proposed
1995 as better than AAAA because it had more flexibility. However, it was felt to be
1996 over-complex, and its status was reduced to &"experimental"&.
1997 Exim used to
1998 have a compile option for including A6 record support but this has now been
1999 withdrawn.
2000
2001
2002
2003 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2004 .cindex "lookup modules"
2005 .cindex "dynamic modules"
2006 .cindex ".so building"
2007 On some platforms, Exim supports not compiling all lookup types directly into
2008 the main binary, instead putting some into external modules which can be loaded
2009 on demand.
2010 This permits packagers to build Exim with support for lookups with extensive
2011 library dependencies without requiring all users to install all of those
2012 dependencies.
2013 Most, but not all, lookup types can be built this way.
2014
2015 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2016 installed; Exim will only load modules from that directory, as a security
2017 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2018 for your OS; see &_OS/Makefile-Linux_& for an example.
2019 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2020 see &_src/EDITME_& for details.
2021
2022 Then, for each module to be loaded dynamically, define the relevant
2023 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2024 For example, this will build in lsearch but load sqlite and mysql support
2025 on demand:
2026 .code
2027 LOOKUP_LSEARCH=yes
2028 LOOKUP_SQLITE=2
2029 LOOKUP_MYSQL=2
2030 .endd
2031
2032
2033 .section "The building process" "SECID29"
2034 .cindex "build directory"
2035 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2036 created, run &'make'& at the top level. It determines the architecture and
2037 operating system types, and creates a build directory if one does not exist.
2038 For example, on a Sun system running Solaris 8, the directory
2039 &_build-SunOS5-5.8-sparc_& is created.
2040 .cindex "symbolic link" "to source files"
2041 Symbolic links to relevant source files are installed in the build directory.
2042
2043 If this is the first time &'make'& has been run, it calls a script that builds
2044 a make file inside the build directory, using the configuration files from the
2045 &_Local_& directory. The new make file is then passed to another instance of
2046 &'make'&. This does the real work, building a number of utility scripts, and
2047 then compiling and linking the binaries for the Exim monitor (if configured), a
2048 number of utility programs, and finally Exim itself. The command &`make
2049 makefile`& can be used to force a rebuild of the make file in the build
2050 directory, should this ever be necessary.
2051
2052 If you have problems building Exim, check for any comments there may be in the
2053 &_README_& file concerning your operating system, and also take a look at the
2054 FAQ, where some common problems are covered.
2055
2056
2057
2058 .section 'Output from &"make"&' "SECID283"
2059 The output produced by the &'make'& process for compile lines is often very
2060 unreadable, because these lines can be very long. For this reason, the normal
2061 output is suppressed by default, and instead output similar to that which
2062 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2063 each module that is being compiled or linked. However, it is still possible to
2064 get the full output, by calling &'make'& like this:
2065 .code
2066 FULLECHO='' make -e
2067 .endd
2068 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2069 command reflection in &'make'&. When you ask for the full output, it is
2070 given in addition to the short output.
2071
2072
2073
2074 .section "Overriding build-time options for Exim" "SECToverride"
2075 .cindex "build-time options, overriding"
2076 The main make file that is created at the beginning of the building process
2077 consists of the concatenation of a number of files which set configuration
2078 values, followed by a fixed set of &'make'& instructions. If a value is set
2079 more than once, the last setting overrides any previous ones. This provides a
2080 convenient way of overriding defaults. The files that are concatenated are, in
2081 order:
2082 .display
2083 &_OS/Makefile-Default_&
2084 &_OS/Makefile-_&<&'ostype'&>
2085 &_Local/Makefile_&
2086 &_Local/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile-_&<&'archtype'&>
2088 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2089 &_OS/Makefile-Base_&
2090 .endd
2091 .cindex "&_Local/Makefile_&"
2092 .cindex "building Exim" "operating system type"
2093 .cindex "building Exim" "architecture type"
2094 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2095 architecture type. &_Local/Makefile_& is required to exist, and the building
2096 process fails if it is absent. The other three &_Local_& files are optional,
2097 and are often not needed.
2098
2099 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2100 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2101 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2102 values are used, thereby providing a means of forcing particular settings.
2103 Otherwise, the scripts try to get values from the &%uname%& command. If this
2104 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2105 of &'ad hoc'& transformations are then applied, to produce the standard names
2106 that Exim expects. You can run these scripts directly from the shell in order
2107 to find out what values are being used on your system.
2108
2109
2110 &_OS/Makefile-Default_& contains comments about the variables that are set
2111 therein. Some (but not all) are mentioned below. If there is something that
2112 needs changing, review the contents of this file and the contents of the make
2113 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2114 default values are.
2115
2116
2117 .cindex "building Exim" "overriding default settings"
2118 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2119 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2120 need to change the original files. Instead, you should make the changes by
2121 putting the new values in an appropriate &_Local_& file. For example,
2122 .cindex "Tru64-Unix build-time settings"
2123 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2124 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2125 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2126 called with the option &%-std1%&, to make it recognize some of the features of
2127 Standard C that Exim uses. (Most other compilers recognize Standard C by
2128 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2129 containing the lines
2130 .code
2131 CC=cc
2132 CFLAGS=-std1
2133 .endd
2134 If you are compiling for just one operating system, it may be easier to put
2135 these lines directly into &_Local/Makefile_&.
2136
2137 Keeping all your local configuration settings separate from the distributed
2138 files makes it easy to transfer them to new versions of Exim simply by copying
2139 the contents of the &_Local_& directory.
2140
2141
2142 .cindex "NIS lookup type" "including support for"
2143 .cindex "NIS+ lookup type" "including support for"
2144 .cindex "LDAP" "including support for"
2145 .cindex "lookup" "inclusion in binary"
2146 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2147 lookup, but not all systems have these components installed, so the default is
2148 not to include the relevant code in the binary. All the different kinds of file
2149 and database lookup that Exim supports are implemented as separate code modules
2150 which are included only if the relevant compile-time options are set. In the
2151 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2152 .code
2153 LOOKUP_LDAP=yes
2154 LOOKUP_NIS=yes
2155 LOOKUP_NISPLUS=yes
2156 .endd
2157 and similar settings apply to the other lookup types. They are all listed in
2158 &_src/EDITME_&. In many cases the relevant include files and interface
2159 libraries need to be installed before compiling Exim.
2160 .cindex "cdb" "including support for"
2161 However, there are some optional lookup types (such as cdb) for which
2162 the code is entirely contained within Exim, and no external include
2163 files or libraries are required. When a lookup type is not included in the
2164 binary, attempts to configure Exim to use it cause runtime configuration
2165 errors.
2166
2167 .cindex "pkg-config" "lookups"
2168 .cindex "pkg-config" "authenticators"
2169 Many systems now use a tool called &'pkg-config'& to encapsulate information
2170 about how to compile against a library; Exim has some initial support for
2171 being able to use pkg-config for lookups and authenticators.  For any given
2172 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2173 variable with the &`_PC`& suffix in the name and assign as the value the
2174 name of the package to be queried.  The results of querying via the
2175 &'pkg-config'& command will be added to the appropriate Makefile variables
2176 with &`+=`& directives, so your version of &'make'& will need to support that
2177 syntax.  For instance:
2178 .code
2179 LOOKUP_SQLITE=yes
2180 LOOKUP_SQLITE_PC=sqlite3
2181 AUTH_GSASL=yes
2182 AUTH_GSASL_PC=libgsasl
2183 AUTH_HEIMDAL_GSSAPI=yes
2184 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2185 .endd
2186
2187 .cindex "Perl" "including support for"
2188 Exim can be linked with an embedded Perl interpreter, allowing Perl
2189 subroutines to be called during string expansion. To enable this facility,
2190 .code
2191 EXIM_PERL=perl.o
2192 .endd
2193 must be defined in &_Local/Makefile_&. Details of this facility are given in
2194 chapter &<<CHAPperl>>&.
2195
2196 .cindex "X11 libraries, location of"
2197 The location of the X11 libraries is something that varies a lot between
2198 operating systems, and there may be different versions of X11 to cope
2199 with. Exim itself makes no use of X11, but if you are compiling the Exim
2200 monitor, the X11 libraries must be available.
2201 The following three variables are set in &_OS/Makefile-Default_&:
2202 .code
2203 X11=/usr/X11R6
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib
2206 .endd
2207 These are overridden in some of the operating-system configuration files. For
2208 example, in &_OS/Makefile-SunOS5_& there is
2209 .code
2210 X11=/usr/openwin
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2213 .endd
2214 If you need to override the default setting for your operating system, place a
2215 definition of all three of these variables into your
2216 &_Local/Makefile-<ostype>_& file.
2217
2218 .cindex "EXTRALIBS"
2219 If you need to add any extra libraries to the link steps, these can be put in a
2220 variable called EXTRALIBS, which appears in all the link commands, but by
2221 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2222 command for linking the main Exim binary, and not for any associated utilities.
2223
2224 .cindex "DBM libraries" "configuration for building"
2225 There is also DBMLIB, which appears in the link commands for binaries that
2226 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2227 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2228 binary, and which can be used, for example, to include additional X11
2229 libraries.
2230
2231 .cindex "configuration file" "editing"
2232 The make file copes with rebuilding Exim correctly if any of the configuration
2233 files are edited. However, if an optional configuration file is deleted, it is
2234 necessary to touch the associated non-optional file (that is,
2235 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2236
2237
2238 .section "OS-specific header files" "SECID30"
2239 .cindex "&_os.h_&"
2240 .cindex "building Exim" "OS-specific C header files"
2241 The &_OS_& directory contains a number of files with names of the form
2242 &_os.h-<ostype>_&. These are system-specific C header files that should not
2243 normally need to be changed. There is a list of macro settings that are
2244 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2245 are porting Exim to a new operating system.
2246
2247
2248
2249 .section "Overriding build-time options for the monitor" "SECID31"
2250 .cindex "building Eximon"
2251 A similar process is used for overriding things when building the Exim monitor,
2252 where the files that are involved are
2253 .display
2254 &_OS/eximon.conf-Default_&
2255 &_OS/eximon.conf-_&<&'ostype'&>
2256 &_Local/eximon.conf_&
2257 &_Local/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf-_&<&'archtype'&>
2259 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2260 .endd
2261 .cindex "&_Local/eximon.conf_&"
2262 As with Exim itself, the final three files need not exist, and in this case the
2263 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2264 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2265 variables of the same name, preceded by EXIMON_. For example, setting
2266 EXIMON_LOG_DEPTH in the environment overrides the value of
2267 LOG_DEPTH at runtime.
2268 .ecindex IIDbuex
2269
2270
2271 .section "Installing Exim binaries and scripts" "SECID32"
2272 .cindex "installing Exim"
2273 .cindex "BIN_DIRECTORY"
2274 The command &`make install`& runs the &(exim_install)& script with no
2275 arguments. The script copies binaries and utility scripts into the directory
2276 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2277 .cindex "setuid" "installing Exim with"
2278 The install script copies files only if they are newer than the files they are
2279 going to replace. The Exim binary is required to be owned by root and have the
2280 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2281 install`& as root so that it can set up the Exim binary in this way. However, in
2282 some special situations (for example, if a host is doing no local deliveries)
2283 it may be possible to run Exim without making the binary setuid root (see
2284 chapter &<<CHAPsecurity>>& for details).
2285
2286 .cindex "CONFIGURE_FILE"
2287 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2288 in &_Local/Makefile_&. If this names a single file, and the file does not
2289 exist, the default configuration file &_src/configure.default_& is copied there
2290 by the installation script. If a runtime configuration file already exists, it
2291 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2292 alternative files, no default is installed.
2293
2294 .cindex "system aliases file"
2295 .cindex "&_/etc/aliases_&"
2296 One change is made to the default configuration file when it is installed: the
2297 default configuration contains a router that references a system aliases file.
2298 The path to this file is set to the value specified by
2299 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2300 If the system aliases file does not exist, the installation script creates it,
2301 and outputs a comment to the user.
2302
2303 The created file contains no aliases, but it does contain comments about the
2304 aliases a site should normally have. Mail aliases have traditionally been
2305 kept in &_/etc/aliases_&. However, some operating systems are now using
2306 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2307 Exim's configuration if necessary.
2308
2309 The default configuration uses the local host's name as the only local domain,
2310 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2311 running as the local user. System aliases and &_.forward_& files in users' home
2312 directories are supported, but no NIS or NIS+ support is configured. Domains
2313 other than the name of the local host are routed using the DNS, with delivery
2314 over SMTP.
2315
2316 It is possible to install Exim for special purposes (such as building a binary
2317 distribution) in a private part of the file system. You can do this by a
2318 command such as
2319 .code
2320 make DESTDIR=/some/directory/ install
2321 .endd
2322 This has the effect of pre-pending the specified directory to all the file
2323 paths, except the name of the system aliases file that appears in the default
2324 configuration. (If a default alias file is created, its name &'is'& modified.)
2325 For backwards compatibility, ROOT is used if DESTDIR is not set,
2326 but this usage is deprecated.
2327
2328 .cindex "installing Exim" "what is not installed"
2329 Running &'make install'& does not copy the Exim 4 conversion script
2330 &'convert4r4'&. You will probably run this only once if you are
2331 upgrading from Exim 3. None of the documentation files in the &_doc_&
2332 directory are copied, except for the info files when you have set
2333 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2334
2335 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2336 to their names. The Exim binary itself, however, is handled differently. It is
2337 installed under a name that includes the version number and the compile number,
2338 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2339 called &_exim_& to point to the binary. If you are updating a previous version
2340 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2341 from the directory (as seen by other processes).
2342
2343 .cindex "installing Exim" "testing the script"
2344 If you want to see what the &'make install'& will do before running it for
2345 real, you can pass the &%-n%& option to the installation script by this
2346 command:
2347 .code
2348 make INSTALL_ARG=-n install
2349 .endd
2350 The contents of the variable INSTALL_ARG are passed to the installation
2351 script. You do not need to be root to run this test. Alternatively, you can run
2352 the installation script directly, but this must be from within the build
2353 directory. For example, from the top-level Exim directory you could use this
2354 command:
2355 .code
2356 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2357 .endd
2358 .cindex "installing Exim" "install script options"
2359 There are two other options that can be supplied to the installation script.
2360
2361 .ilist
2362 &%-no_chown%& bypasses the call to change the owner of the installed binary
2363 to root, and the call to make it a setuid binary.
2364 .next
2365 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2366 installed binary.
2367 .endlist
2368
2369 INSTALL_ARG can be used to pass these options to the script. For example:
2370 .code
2371 make INSTALL_ARG=-no_symlink install
2372 .endd
2373 The installation script can also be given arguments specifying which files are
2374 to be copied. For example, to install just the Exim binary, and nothing else,
2375 without creating the symbolic link, you could use:
2376 .code
2377 make INSTALL_ARG='-no_symlink exim' install
2378 .endd
2379
2380
2381
2382 .section "Installing info documentation" "SECTinsinfdoc"
2383 .cindex "installing Exim" "&'info'& documentation"
2384 Not all systems use the GNU &'info'& system for documentation, and for this
2385 reason, the Texinfo source of Exim's documentation is not included in the main
2386 distribution. Instead it is available separately from the FTP site (see section
2387 &<<SECTavail>>&).
2388
2389 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2390 source of the documentation is found in the source tree, running &`make
2391 install`& automatically builds the info files and installs them.
2392
2393
2394
2395 .section "Setting up the spool directory" "SECID33"
2396 .cindex "spool directory" "creating"
2397 When it starts up, Exim tries to create its spool directory if it does not
2398 exist. The Exim uid and gid are used for the owner and group of the spool
2399 directory. Sub-directories are automatically created in the spool directory as
2400 necessary.
2401
2402
2403
2404
2405 .section "Testing" "SECID34"
2406 .cindex "testing" "installation"
2407 Having installed Exim, you can check that the runtime configuration file is
2408 syntactically valid by running the following command, which assumes that the
2409 Exim binary directory is within your PATH environment variable:
2410 .code
2411 exim -bV
2412 .endd
2413 If there are any errors in the configuration file, Exim outputs error messages.
2414 Otherwise it outputs the version number and build date,
2415 the DBM library that is being used, and information about which drivers and
2416 other optional code modules are included in the binary.
2417 Some simple routing tests can be done by using the address testing option. For
2418 example,
2419 .display
2420 &`exim -bt`& <&'local username'&>
2421 .endd
2422 should verify that it recognizes a local mailbox, and
2423 .display
2424 &`exim -bt`& <&'remote address'&>
2425 .endd
2426 a remote one. Then try getting it to deliver mail, both locally and remotely.
2427 This can be done by passing messages directly to Exim, without going through a
2428 user agent. For example:
2429 .code
2430 exim -v postmaster@your.domain.example
2431 From: user@your.domain.example
2432 To: postmaster@your.domain.example
2433 Subject: Testing Exim
2434
2435 This is a test message.
2436 ^D
2437 .endd
2438 The &%-v%& option causes Exim to output some verification of what it is doing.
2439 In this case you should see copies of three log lines, one for the message's
2440 arrival, one for its delivery, and one containing &"Completed"&.
2441
2442 .cindex "delivery" "problems with"
2443 If you encounter problems, look at Exim's log files (&'mainlog'& and
2444 &'paniclog'&) to see if there is any relevant information there. Another source
2445 of information is running Exim with debugging turned on, by specifying the
2446 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2447 with debugging turned on by a command of the form
2448 .display
2449 &`exim -d -M`& <&'exim-message-id'&>
2450 .endd
2451 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2452 produces rather a lot of output, but you can cut this down to specific areas.
2453 For example, if you use &%-d-all+route%& only the debugging information
2454 relevant to routing is included. (See the &%-d%& option in chapter
2455 &<<CHAPcommandline>>& for more details.)
2456
2457 .cindex '&"sticky"& bit'
2458 .cindex "lock files"
2459 One specific problem that has shown up on some sites is the inability to do
2460 local deliveries into a shared mailbox directory, because it does not have the
2461 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2462 writing to a mailbox file, and if it cannot create the lock file, the delivery
2463 is deferred. You can get round this either by setting the &"sticky bit"& on the
2464 directory, or by setting a specific group for local deliveries and allowing
2465 that group to create files in the directory (see the comments above the
2466 &(local_delivery)& transport in the default configuration file). Another
2467 approach is to configure Exim not to use lock files, but just to rely on
2468 &[fcntl()]& locking instead. However, you should do this only if all user
2469 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2470 see chapter &<<CHAPappendfile>>&.
2471
2472 One thing that cannot be tested on a system that is already running an MTA is
2473 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2474 &%-oX%& option can be used to run an Exim daemon that listens on some other
2475 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2476 &'exim_checkaccess'& utility can be used to check out policy controls on
2477 incoming SMTP mail.
2478
2479 Testing a new version on a system that is already running Exim can most easily
2480 be done by building a binary with a different CONFIGURE_FILE setting. From
2481 within the runtime configuration, all other file and directory names
2482 that Exim uses can be altered, in order to keep it entirely clear of the
2483 production version.
2484
2485
2486 .section "Replacing another MTA with Exim" "SECID35"
2487 .cindex "replacing another MTA"
2488 Building and installing Exim for the first time does not of itself put it in
2489 general use. The name by which the system's MTA is called by mail user agents
2490 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2491 operating system), and it is necessary to make this name point to the &'exim'&
2492 binary in order to get the user agents to pass messages to Exim. This is
2493 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2494 or &_/usr/lib/sendmail_&
2495 .cindex "symbolic link" "to &'exim'& binary"
2496 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2497 privilege and executable status from the old MTA. It is then necessary to stop
2498 and restart the mailer daemon, if one is running.
2499
2500 .cindex "FreeBSD, MTA indirection"
2501 .cindex "&_/etc/mail/mailer.conf_&"
2502 Some operating systems have introduced alternative ways of switching MTAs. For
2503 example, if you are running FreeBSD, you need to edit the file
2504 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2505 described. A typical example of the contents of this file for running Exim is
2506 as follows:
2507 .code
2508 sendmail            /usr/exim/bin/exim
2509 send-mail           /usr/exim/bin/exim
2510 mailq               /usr/exim/bin/exim -bp
2511 newaliases          /usr/bin/true
2512 .endd
2513 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2514 your Exim installation is &"live"&. Check it by sending a message from your
2515 favourite user agent.
2516
2517 You should consider what to tell your users about the change of MTA. Exim may
2518 have different capabilities to what was previously running, and there are
2519 various operational differences such as the text of messages produced by
2520 command line options and in bounce messages. If you allow your users to make
2521 use of Exim's filtering capabilities, you should make the document entitled
2522 &'Exim's interface to mail filtering'& available to them.
2523
2524
2525
2526 .section "Upgrading Exim" "SECID36"
2527 .cindex "upgrading Exim"
2528 If you are already running Exim on your host, building and installing a new
2529 version automatically makes it available to MUAs, or any other programs that
2530 call the MTA directly. However, if you are running an Exim daemon, you do need
2531 .cindex restart "on HUP signal"
2532 .cindex signal "HUP, to restart"
2533 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2534 new binary. You do not need to stop processing mail in order to install a new
2535 version of Exim. The install script does not modify an existing runtime
2536 configuration file.
2537
2538
2539
2540
2541 .section "Stopping the Exim daemon on Solaris" "SECID37"
2542 .cindex "Solaris" "stopping Exim on"
2543 The standard command for stopping the mailer daemon on Solaris is
2544 .code
2545 /etc/init.d/sendmail stop
2546 .endd
2547 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2548 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2549 for the text &"sendmail"&; this is not present because the actual program name
2550 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2551 solution is to replace the line that finds the process id with something like
2552 .code
2553 pid=`cat /var/spool/exim/exim-daemon.pid`
2554 .endd
2555 to obtain the daemon's pid directly from the file that Exim saves it in.
2556
2557 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2558 still be received from local processes, and if automatic delivery is configured
2559 (the normal case), deliveries will still occur.
2560
2561
2562
2563
2564 . ////////////////////////////////////////////////////////////////////////////
2565 . ////////////////////////////////////////////////////////////////////////////
2566
2567 .chapter "The Exim command line" "CHAPcommandline"
2568 .scindex IIDclo1 "command line" "options"
2569 .scindex IIDclo2 "options" "command line"
2570 Exim's command line takes the standard Unix form of a sequence of options,
2571 each starting with a hyphen character, followed by a number of arguments. The
2572 options are compatible with the main options of Sendmail, and there are also
2573 some additional options, some of which are compatible with Smail 3. Certain
2574 combinations of options do not make sense, and provoke an error if used.
2575 The form of the arguments depends on which options are set.
2576
2577
2578 .section "Setting options by program name" "SECID38"
2579 .cindex "&'mailq'&"
2580 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2581 were present before any other options.
2582 The &%-bp%& option requests a listing of the contents of the mail queue on the
2583 standard output.
2584 This feature is for compatibility with some systems that contain a command of
2585 that name in one of the standard libraries, symbolically linked to
2586 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2587
2588 .cindex "&'rsmtp'&"
2589 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2590 were present before any other options, for compatibility with Smail. The
2591 &%-bS%& option is used for reading in a number of messages in batched SMTP
2592 format.
2593
2594 .cindex "&'rmail'&"
2595 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2596 &%-oee%& options were present before any other options, for compatibility with
2597 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2598
2599 .cindex "&'runq'&"
2600 .cindex "queue runner"
2601 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2602 were present before any other options, for compatibility with Smail. The &%-q%&
2603 option causes a single queue runner process to be started.
2604
2605 .cindex "&'newaliases'&"
2606 .cindex "alias file" "building"
2607 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2608 If Exim is called under the name &'newaliases'& it behaves as if the option
2609 &%-bi%& were present before any other options, for compatibility with Sendmail.
2610 This option is used for rebuilding Sendmail's alias file. Exim does not have
2611 the concept of a single alias file, but can be configured to run a given
2612 command if called with the &%-bi%& option.
2613
2614
2615 .section "Trusted and admin users" "SECTtrustedadmin"
2616 Some Exim options are available only to &'trusted users'& and others are
2617 available only to &'admin users'&. In the description below, the phrases &"Exim
2618 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2619 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2620 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2621
2622 .ilist
2623 .cindex "trusted users" "definition of"
2624 .cindex "user" "trusted definition of"
2625 The trusted users are root, the Exim user, any user listed in the
2626 &%trusted_users%& configuration option, and any user whose current group or any
2627 supplementary group is one of those listed in the &%trusted_groups%&
2628 configuration option. Note that the Exim group is not automatically trusted.
2629
2630 .cindex '&"From"& line'
2631 .cindex "envelope from"
2632 .cindex "envelope sender"
2633 Trusted users are always permitted to use the &%-f%& option or a leading
2634 &"From&~"& line to specify the envelope sender of a message that is passed to
2635 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2636 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2637 users to set envelope senders.
2638
2639 .cindex "&'From:'& header line"
2640 .cindex "&'Sender:'& header line"
2641 .cindex "header lines" "From:"
2642 .cindex "header lines" "Sender:"
2643 For a trusted user, there is never any check on the contents of the &'From:'&
2644 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2645 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2646
2647 Trusted users may also specify a host name, host address, interface address,
2648 protocol name, ident value, and authentication data when submitting a message
2649 locally. Thus, they are able to insert messages into Exim's queue locally that
2650 have the characteristics of messages received from a remote host. Untrusted
2651 users may in some circumstances use &%-f%&, but can never set the other values
2652 that are available to trusted users.
2653 .next
2654 .cindex "user" "admin definition of"
2655 .cindex "admin user" "definition of"
2656 The admin users are root, the Exim user, and any user that is a member of the
2657 Exim group or of any group listed in the &%admin_groups%& configuration option.
2658 The current group does not have to be one of these groups.
2659
2660 Admin users are permitted to list the queue, and to carry out certain
2661 operations on messages, for example, to force delivery failures. It is also
2662 necessary to be an admin user in order to see the full information provided by
2663 the Exim monitor, and full debugging output.
2664
2665 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2666 Exim to attempt delivery of messages on its queue is restricted to admin users.
2667 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2668 option false (that is, specifying &%no_prod_requires_admin%&).
2669
2670 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2671 is restricted to admin users unless &%queue_list_requires_admin%& is set
2672 false.
2673 .endlist
2674
2675
2676 &*Warning*&: If you configure your system so that admin users are able to
2677 edit Exim's configuration file, you are giving those users an easy way of
2678 getting root. There is further discussion of this issue at the start of chapter
2679 &<<CHAPconf>>&.
2680
2681
2682
2683
2684 .section "Command line options" "SECID39"
2685 Exim's command line options are described in alphabetical order below. If none
2686 of the options that specifies a specific action (such as starting the daemon or
2687 a queue runner, or testing an address, or receiving a message in a specific
2688 format, or listing the queue) are present, and there is at least one argument
2689 on the command line, &%-bm%& (accept a local message on the standard input,
2690 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2691 outputs a brief message about itself and exits.
2692
2693 . ////////////////////////////////////////////////////////////////////////////
2694 . Insert a stylized XML comment here, to identify the start of the command line
2695 . options. This is for the benefit of the Perl script that automatically
2696 . creates a man page for the options.
2697 . ////////////////////////////////////////////////////////////////////////////
2698
2699 .literal xml
2700 <!-- === Start of command line options === -->
2701 .literal off
2702
2703
2704 .vlist
2705 .vitem &%--%&
2706 .oindex "--"
2707 .cindex "options" "command line; terminating"
2708 This is a pseudo-option whose only purpose is to terminate the options and
2709 therefore to cause subsequent command line items to be treated as arguments
2710 rather than options, even if they begin with hyphens.
2711
2712 .vitem &%--help%&
2713 .oindex "&%--help%&"
2714 This option causes Exim to output a few sentences stating what it is.
2715 The same output is generated if the Exim binary is called with no options and
2716 no arguments.
2717
2718 .vitem &%--version%&
2719 .oindex "&%--version%&"
2720 This option is an alias for &%-bV%& and causes version information to be
2721 displayed.
2722
2723 .vitem &%-Ac%& &&&
2724        &%-Am%&
2725 .oindex "&%-Ac%&"
2726 .oindex "&%-Am%&"
2727 These options are used by Sendmail for selecting configuration files and are
2728 ignored by Exim.
2729
2730 .vitem &%-B%&<&'type'&>
2731 .oindex "&%-B%&"
2732 .cindex "8-bit characters"
2733 .cindex "Sendmail compatibility" "8-bit characters"
2734 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2735 clean; it ignores this option.
2736
2737 .vitem &%-bd%&
2738 .oindex "&%-bd%&"
2739 .cindex "daemon"
2740 .cindex "SMTP" "listener"
2741 .cindex "queue runner"
2742 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2743 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2744 that the daemon should also initiate periodic queue runs.
2745
2746 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2747 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2748 disconnect from the controlling terminal. When running this way, it can be
2749 stopped by pressing ctrl-C.
2750
2751 By default, Exim listens for incoming connections to the standard SMTP port on
2752 all the host's running interfaces. However, it is possible to listen on other
2753 ports, on multiple ports, and only on specific interfaces. Chapter
2754 &<<CHAPinterfaces>>& contains a description of the options that control this.
2755
2756 When a listening daemon
2757 .cindex "daemon" "process id (pid)"
2758 .cindex "pid (process id)" "of daemon"
2759 is started without the use of &%-oX%& (that is, without overriding the normal
2760 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2761 in Exim's spool directory. This location can be overridden by setting
2762 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2763 running as root.
2764
2765 When &%-oX%& is used on the command line to start a listening daemon, the
2766 process id is not written to the normal pid file path. However, &%-oP%& can be
2767 used to specify a path on the command line if a pid file is required.
2768
2769 The SIGHUP signal
2770 .cindex "SIGHUP"
2771 .cindex restart "on HUP signal"
2772 .cindex signal "HUP, to restart"
2773 .cindex "daemon" "restarting"
2774 .cindex signal "to reload configuration"
2775 .cindex daemon "reload configuration"
2776 .cindex reload configuration
2777 can be used to cause the daemon to re-execute itself. This should be done
2778 whenever Exim's configuration file, or any file that is incorporated into it by
2779 means of the &%.include%& facility, is changed, and also whenever a new version
2780 of Exim is installed. It is not necessary to do this when other files that are
2781 referenced from the configuration (for example, alias files) are changed,
2782 because these are reread each time they are used.
2783
2784 .vitem &%-bdf%&
2785 .oindex "&%-bdf%&"
2786 This option has the same effect as &%-bd%& except that it never disconnects
2787 from the controlling terminal, even when no debugging is specified.
2788
2789 .vitem &%-be%&
2790 .oindex "&%-be%&"
2791 .cindex "testing" "string expansion"
2792 .cindex "expansion" "testing"
2793 Run Exim in expansion testing mode. Exim discards its root privilege, to
2794 prevent ordinary users from using this mode to read otherwise inaccessible
2795 files. If no arguments are given, Exim runs interactively, prompting for lines
2796 of data. Otherwise, it processes each argument in turn.
2797
2798 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2799 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2800 used without command line arguments. If successful, it uses the &[readline()]&
2801 function, which provides extensive line-editing facilities, for reading the
2802 test data. A line history is supported.
2803
2804 Long expansion expressions can be split over several lines by using backslash
2805 continuations. As in Exim's runtime configuration, white space at the start of
2806 continuation lines is ignored. Each argument or data line is passed through the
2807 string expansion mechanism, and the result is output. Variable values from the
2808 configuration file (for example, &$qualify_domain$&) are available, but no
2809 message-specific values (such as &$message_exim_id$&) are set, because no message
2810 is being processed (but see &%-bem%& and &%-Mset%&).
2811
2812 &*Note*&: If you use this mechanism to test lookups, and you change the data
2813 files or databases you are using, you must exit and restart Exim before trying
2814 the same lookup again. Otherwise, because each Exim process caches the results
2815 of lookups, you will just get the same result as before.
2816
2817 Macro processing is done on lines before string-expansion: new macros can be
2818 defined and macros will be expanded.
2819 Because macros in the config file are often used for secrets, those are only
2820 available to admin users.
2821
2822 .vitem &%-bem%&&~<&'filename'&>
2823 .oindex "&%-bem%&"
2824 .cindex "testing" "string expansion"
2825 .cindex "expansion" "testing"
2826 This option operates like &%-be%& except that it must be followed by the name
2827 of a file. For example:
2828 .code
2829 exim -bem /tmp/testmessage
2830 .endd
2831 The file is read as a message (as if receiving a locally-submitted non-SMTP
2832 message) before any of the test expansions are done. Thus, message-specific
2833 variables such as &$message_size$& and &$header_from:$& are available. However,
2834 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2835 recipients are read from the headers in the normal way, and are shown in the
2836 &$recipients$& variable. Note that recipients cannot be given on the command
2837 line, because further arguments are taken as strings to expand (just like
2838 &%-be%&).
2839
2840 .vitem &%-bF%&&~<&'filename'&>
2841 .oindex "&%-bF%&"
2842 .cindex "system filter" "testing"
2843 .cindex "testing" "system filter"
2844 This option is the same as &%-bf%& except that it assumes that the filter being
2845 tested is a system filter. The additional commands that are available only in
2846 system filters are recognized.
2847
2848 .vitem &%-bf%&&~<&'filename'&>
2849 .oindex "&%-bf%&"
2850 .cindex "filter" "testing"
2851 .cindex "testing" "filter file"
2852 .cindex "forward file" "testing"
2853 .cindex "testing" "forward file"
2854 .cindex "Sieve filter" "testing"
2855 This option runs Exim in user filter testing mode; the file is the filter file
2856 to be tested, and a test message must be supplied on the standard input. If
2857 there are no message-dependent tests in the filter, an empty file can be
2858 supplied.
2859
2860 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2861 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2862 filter and a user filter in the same run. For example:
2863 .code
2864 exim -bF /system/filter -bf /user/filter </test/message
2865 .endd
2866 This is helpful when the system filter adds header lines or sets filter
2867 variables that are used by the user filter.
2868
2869 If the test filter file does not begin with one of the special lines
2870 .code
2871 # Exim filter
2872 # Sieve filter
2873 .endd
2874 it is taken to be a normal &_.forward_& file, and is tested for validity under
2875 that interpretation. See sections &<<SECTitenonfilred>>& to
2876 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2877 redirection lists.
2878
2879 The result of an Exim command that uses &%-bf%&, provided no errors are
2880 detected, is a list of the actions that Exim would try to take if presented
2881 with the message for real. More details of filter testing are given in the
2882 separate document entitled &'Exim's interfaces to mail filtering'&.
2883
2884 When testing a filter file,
2885 .cindex "&""From""& line"
2886 .cindex "envelope from"
2887 .cindex "envelope sender"
2888 .oindex "&%-f%&" "for filter testing"
2889 the envelope sender can be set by the &%-f%& option,
2890 or by a &"From&~"& line at the start of the test message. Various parameters
2891 that would normally be taken from the envelope recipient address of the message
2892 can be set by means of additional command line options (see the next four
2893 options).
2894
2895 .vitem &%-bfd%&&~<&'domain'&>
2896 .oindex "&%-bfd%&"
2897 .vindex "&$qualify_domain$&"
2898 This sets the domain of the recipient address when a filter file is being
2899 tested by means of the &%-bf%& option. The default is the value of
2900 &$qualify_domain$&.
2901
2902 .vitem &%-bfl%&&~<&'local&~part'&>
2903 .oindex "&%-bfl%&"
2904 This sets the local part of the recipient address when a filter file is being
2905 tested by means of the &%-bf%& option. The default is the username of the
2906 process that calls Exim. A local part should be specified with any prefix or
2907 suffix stripped, because that is how it appears to the filter when a message is
2908 actually being delivered.
2909
2910 .vitem &%-bfp%&&~<&'prefix'&>
2911 .oindex "&%-bfp%&"
2912 .cindex affix "filter testing"
2913 This sets the prefix of the local part of the recipient address when a filter
2914 file is being tested by means of the &%-bf%& option. The default is an empty
2915 prefix.
2916
2917 .vitem &%-bfs%&&~<&'suffix'&>
2918 .oindex "&%-bfs%&"
2919 .cindex affix "filter testing"
2920 This sets the suffix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 suffix.
2923
2924 .vitem &%-bh%&&~<&'IP&~address'&>
2925 .oindex "&%-bh%&"
2926 .cindex "testing" "incoming SMTP"
2927 .cindex "SMTP" "testing incoming"
2928 .cindex "testing" "relay control"
2929 .cindex "relaying" "testing configuration"
2930 .cindex "policy control" "testing"
2931 .cindex "debugging" "&%-bh%& option"
2932 This option runs a fake SMTP session as if from the given IP address, using the
2933 standard input and output. The IP address may include a port number at the end,
2934 after a full stop. For example:
2935 .code
2936 exim -bh 10.9.8.7.1234
2937 exim -bh fe80::a00:20ff:fe86:a061.5678
2938 .endd
2939 When an IPv6 address is given, it is converted into canonical form. In the case
2940 of the second example above, the value of &$sender_host_address$& after
2941 conversion to the canonical form is
2942 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2943
2944 Comments as to what is going on are written to the standard error file. These
2945 include lines beginning with &"LOG"& for anything that would have been logged.
2946 This facility is provided for testing configuration options for incoming
2947 messages, to make sure they implement the required policy. For example, you can
2948 test your relay controls using &%-bh%&.
2949
2950 &*Warning 1*&:
2951 .cindex "RFC 1413"
2952 You can test features of the configuration that rely on ident (RFC 1413)
2953 information by using the &%-oMt%& option. However, Exim cannot actually perform
2954 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2955 connection.
2956
2957 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2958 are also skipped when testing using &%-bh%&. If you want these callouts to
2959 occur, use &%-bhc%& instead.
2960
2961 Messages supplied during the testing session are discarded, and nothing is
2962 written to any of the real log files. There may be pauses when DNS (and other)
2963 lookups are taking place, and of course these may time out. The &%-oMi%& option
2964 can be used to specify a specific IP interface and port if this is important,
2965 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2966 session were authenticated.
2967
2968 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2969 output just states whether a given recipient address from a given host is
2970 acceptable or not. See section &<<SECTcheckaccess>>&.
2971
2972 Features such as authentication and encryption, where the client input is not
2973 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2974 specialized SMTP test program such as
2975 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2976
2977 .vitem &%-bhc%&&~<&'IP&~address'&>
2978 .oindex "&%-bhc%&"
2979 This option operates in the same way as &%-bh%&, except that address
2980 verification callouts are performed if required. This includes consulting and
2981 updating the callout cache database.
2982
2983 .vitem &%-bi%&
2984 .oindex "&%-bi%&"
2985 .cindex "alias file" "building"
2986 .cindex "building alias file"
2987 .cindex "Sendmail compatibility" "&%-bi%& option"
2988 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2989 Exim does not have the concept of a single alias file, and so it cannot mimic
2990 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2991 tend to appear in various scripts such as NIS make files, so the option must be
2992 recognized.
2993
2994 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2995 configuration option is run, under the uid and gid of the caller of Exim. If
2996 the &%-oA%& option is used, its value is passed to the command as an argument.
2997 The command set by &%bi_command%& may not contain arguments. The command can
2998 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2999 if this is required. If the &%bi_command%& option is not set, calling Exim with
3000 &%-bi%& is a no-op.
3001
3002 . // Keep :help first, then the rest in alphabetical order
3003 .vitem &%-bI:help%&
3004 .oindex "&%-bI:help%&"
3005 .cindex "querying exim information"
3006 We shall provide various options starting &`-bI:`& for querying Exim for
3007 information.  The output of many of these will be intended for machine
3008 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3009 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3010 options shall cause Exim to exit after producing the requested output.
3011
3012 .vitem &%-bI:dscp%&
3013 .oindex "&%-bI:dscp%&"
3014 .cindex "DSCP" "values"
3015 This option causes Exim to emit an alphabetically sorted list of all
3016 recognised DSCP names.
3017
3018 .vitem &%-bI:sieve%&
3019 .oindex "&%-bI:sieve%&"
3020 .cindex "Sieve filter" "capabilities"
3021 This option causes Exim to emit an alphabetically sorted list of all supported
3022 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3023 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3024 &`SIEVE`& capability response line.  As the precise list may depend upon
3025 compile-time build options, which this option will adapt to, this is the only
3026 way to guarantee a correct response.
3027
3028 .vitem &%-bm%&
3029 .oindex "&%-bm%&"
3030 .cindex "local message reception"
3031 This option runs an Exim receiving process that accepts an incoming,
3032 locally-generated message on the standard input. The recipients are given as the
3033 command arguments (except when &%-t%& is also present &-- see below). Each
3034 argument can be a comma-separated list of RFC 2822 addresses. This is the
3035 default option for selecting the overall action of an Exim call; it is assumed
3036 if no other conflicting option is present.
3037
3038 If any addresses in the message are unqualified (have no domain), they are
3039 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3040 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3041 suppressing this for special cases.
3042
3043 Policy checks on the contents of local messages can be enforced by means of
3044 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3045
3046 .cindex "return code" "for &%-bm%&"
3047 The return code is zero if the message is successfully accepted. Otherwise, the
3048 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3049
3050 The format
3051 .cindex "message" "format"
3052 .cindex "format" "message"
3053 .cindex "&""From""& line"
3054 .cindex "UUCP" "&""From""& line"
3055 .cindex "Sendmail compatibility" "&""From""& line"
3056 of the message must be as defined in RFC 2822, except that, for
3057 compatibility with Sendmail and Smail, a line in one of the forms
3058 .code
3059 From sender Fri Jan  5 12:55 GMT 1997
3060 From sender Fri, 5 Jan 97 12:55:01
3061 .endd
3062 (with the weekday optional, and possibly with additional text after the date)
3063 is permitted to appear at the start of the message. There appears to be no
3064 authoritative specification of the format of this line. Exim recognizes it by
3065 matching against the regular expression defined by the &%uucp_from_pattern%&
3066 option, which can be changed if necessary.
3067
3068 .oindex "&%-f%&" "overriding &""From""& line"
3069 The specified sender is treated as if it were given as the argument to the
3070 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3071 preference to the address taken from the message. The caller of Exim must be a
3072 trusted user for the sender of a message to be set in this way.
3073
3074 .vitem &%-bmalware%&&~<&'filename'&>
3075 .oindex "&%-bmalware%&"
3076 .cindex "testing", "malware"
3077 .cindex "malware scan test"
3078 This debugging option causes Exim to scan the given file or directory
3079 (depending on the used scanner interface),
3080 using the malware scanning framework.  The option of &%av_scanner%& influences
3081 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3082 the expansion should have defaults which apply to this invocation.  ACLs are
3083 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3084 will never be populated and &%-bmalware%& will fail.
3085
3086 Exim will have changed working directory before resolving the filename, so
3087 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3088 user when it tries to open the file, rather than as the invoking user.
3089 This option requires admin privileges.
3090
3091 The &%-bmalware%& option will not be extended to be more generally useful,
3092 there are better tools for file-scanning.  This option exists to help
3093 administrators verify their Exim and AV scanner configuration.
3094
3095 .vitem &%-bnq%&
3096 .oindex "&%-bnq%&"
3097 .cindex "address qualification, suppressing"
3098 By default, Exim automatically qualifies unqualified addresses (those
3099 without domains) that appear in messages that are submitted locally (that
3100 is, not over TCP/IP). This qualification applies both to addresses in
3101 envelopes, and addresses in header lines. Sender addresses are qualified using
3102 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3103 defaults to the value of &%qualify_domain%&).
3104
3105 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3106 being used to re-submit messages that originally came from remote hosts after
3107 content scanning, you probably do not want to qualify unqualified addresses in
3108 header lines. (Such lines will be present only if you have not enabled a header
3109 syntax check in the appropriate ACL.)
3110
3111 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3112 messages that originate on the local host. When this is used, unqualified
3113 addresses in the envelope provoke errors (causing message rejection) and
3114 unqualified addresses in header lines are left alone.
3115
3116
3117 .vitem &%-bP%&
3118 .oindex "&%-bP%&"
3119 .cindex "configuration options" "extracting"
3120 .cindex "options" "configuration &-- extracting"
3121 If this option is given with no arguments, it causes the values of all Exim's
3122 main configuration options to be written to the standard output. The values
3123 of one or more specific options can be requested by giving their names as
3124 arguments, for example:
3125 .code
3126 exim -bP qualify_domain hold_domains
3127 .endd
3128 .cindex "hiding configuration option values"
3129 .cindex "configuration options" "hiding value of"
3130 .cindex "options" "hiding value of"
3131 However, any option setting that is preceded by the word &"hide"& in the
3132 configuration file is not shown in full, except to an admin user. For other
3133 users, the output is as in this example:
3134 .code
3135 mysql_servers = <value not displayable>
3136 .endd
3137 If &%config%& is given as an argument, the config is
3138 output, as it was parsed, any include file resolved, any comment removed.
3139
3140 If &%config_file%& is given as an argument, the name of the runtime
3141 configuration file is output. (&%configure_file%& works too, for
3142 backward compatibility.)
3143 If a list of configuration files was supplied, the value that is output here
3144 is the name of the file that was actually used.
3145
3146 .cindex "options" "hiding name of"
3147 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3148 name will not be output.
3149
3150 .cindex "daemon" "process id (pid)"
3151 .cindex "pid (process id)" "of daemon"
3152 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3153 directories where log files and daemon pid files are written are output,
3154 respectively. If these values are unset, log files are written in a
3155 sub-directory of the spool directory called &%log%&, and the pid file is
3156 written directly into the spool directory.
3157
3158 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3159 .code
3160 exim -bP +local_domains
3161 .endd
3162 it searches for a matching named list of any type (domain, host, address, or
3163 local part) and outputs what it finds.
3164
3165 .cindex "options" "router &-- extracting"
3166 .cindex "options" "transport &-- extracting"
3167 .cindex "options" "authenticator &-- extracting"
3168 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3169 followed by the name of an appropriate driver instance, the option settings for
3170 that driver are output. For example:
3171 .code
3172 exim -bP transport local_delivery
3173 .endd
3174 The generic driver options are output first, followed by the driver's private
3175 options. A list of the names of drivers of a particular type can be obtained by
3176 using one of the words &%router_list%&, &%transport_list%&, or
3177 &%authenticator_list%&, and a complete list of all drivers with their option
3178 settings can be obtained by using &%routers%&, &%transports%&, or
3179 &%authenticators%&.
3180
3181 .cindex "environment"
3182 If &%environment%& is given as an argument, the set of environment
3183 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3184 variables.
3185
3186 .cindex "options" "macro &-- extracting"
3187 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3188 are available, similarly to the drivers.  Because macros are sometimes used
3189 for storing passwords, this option is restricted.
3190 The output format is one item per line.
3191 For the "-bP macro <name>" form, if no such macro is found
3192 the exit status will be nonzero.
3193
3194 .vitem &%-bp%&
3195 .oindex "&%-bp%&"
3196 .cindex "queue" "listing messages in"
3197 .cindex "listing" "messages in the queue"
3198 This option requests a listing of the contents of the mail queue on the
3199 standard output. If the &%-bp%& option is followed by a list of message ids,
3200 just those messages are listed. By default, this option can be used only by an
3201 admin user. However, the &%queue_list_requires_admin%& option can be set false
3202 to allow any user to see the queue.
3203
3204 Each message in the queue is displayed as in the following example:
3205 .code
3206 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3207           red.king@looking-glass.fict.example
3208           <other addresses>
3209 .endd
3210 .cindex "message" "size in queue listing"
3211 .cindex "size" "of message"
3212 The first line contains the length of time the message has been in the queue
3213 (in this case 25 minutes), the size of the message (2.9K), the unique local
3214 identifier for the message, and the message sender, as contained in the
3215 envelope. For bounce messages, the sender address is empty, and appears as
3216 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3217 the default sender address, the user's login name is shown in parentheses
3218 before the sender address.
3219
3220 .cindex "frozen messages" "in queue listing"
3221 If the message is frozen (attempts to deliver it are suspended) then the text
3222 &"*** frozen ***"& is displayed at the end of this line.
3223
3224 The recipients of the message (taken from the envelope, not the headers) are
3225 displayed on subsequent lines. Those addresses to which the message has already
3226 been delivered are marked with the letter D. If an original address gets
3227 expanded into several addresses via an alias or forward file, the original is
3228 displayed with a D only when deliveries for all of its child addresses are
3229 complete.
3230
3231
3232 .vitem &%-bpa%&
3233 .oindex "&%-bpa%&"
3234 This option operates like &%-bp%&, but in addition it shows delivered addresses
3235 that were generated from the original top level address(es) in each message by
3236 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3237 of just &"D"&.
3238
3239
3240 .vitem &%-bpc%&
3241 .oindex "&%-bpc%&"
3242 .cindex "queue" "count of messages on"
3243 This option counts the number of messages in the queue, and writes the total
3244 to the standard output. It is restricted to admin users, unless
3245 &%queue_list_requires_admin%& is set false.
3246
3247
3248 .vitem &%-bpr%&
3249 .oindex "&%-bpr%&"
3250 This option operates like &%-bp%&, but the output is not sorted into
3251 chronological order of message arrival. This can speed it up when there are
3252 lots of messages in the queue, and is particularly useful if the output is
3253 going to be post-processed in a way that doesn't need the sorting.
3254
3255 .vitem &%-bpra%&
3256 .oindex "&%-bpra%&"
3257 This option is a combination of &%-bpr%& and &%-bpa%&.
3258
3259 .vitem &%-bpru%&
3260 .oindex "&%-bpru%&"
3261 This option is a combination of &%-bpr%& and &%-bpu%&.
3262
3263
3264 .vitem &%-bpu%&
3265 .oindex "&%-bpu%&"
3266 This option operates like &%-bp%& but shows only undelivered top-level
3267 addresses for each message displayed. Addresses generated by aliasing or
3268 forwarding are not shown, unless the message was deferred after processing by a
3269 router with the &%one_time%& option set.
3270
3271
3272 .vitem &%-brt%&
3273 .oindex "&%-brt%&"
3274 .cindex "testing" "retry configuration"
3275 .cindex "retry" "configuration testing"
3276 This option is for testing retry rules, and it must be followed by up to three
3277 arguments. It causes Exim to look for a retry rule that matches the values
3278 and to write it to the standard output. For example:
3279 .code
3280 exim -brt bach.comp.mus.example
3281 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3282 .endd
3283 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3284 argument, which is required, can be a complete address in the form
3285 &'local_part@domain'&, or it can be just a domain name. If the second argument
3286 contains a dot, it is interpreted as an optional second domain name; if no
3287 retry rule is found for the first argument, the second is tried. This ties in
3288 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3289 rule is found that matches the host, one that matches the mail domain is
3290 sought. Finally, an argument that is the name of a specific delivery error, as
3291 used in setting up retry rules, can be given. For example:
3292 .code
3293 exim -brt haydn.comp.mus.example quota_3d
3294 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3295 .endd
3296
3297 .vitem &%-brw%&
3298 .oindex "&%-brw%&"
3299 .cindex "testing" "rewriting"
3300 .cindex "rewriting" "testing"
3301 This option is for testing address rewriting rules, and it must be followed by
3302 a single argument, consisting of either a local part without a domain, or a
3303 complete address with a fully qualified domain. Exim outputs how this address
3304 would be rewritten for each possible place it might appear. See chapter
3305 &<<CHAPrewrite>>& for further details.
3306
3307 .vitem &%-bS%&
3308 .oindex "&%-bS%&"
3309 .cindex "SMTP" "batched incoming"
3310 .cindex "batched SMTP input"
3311 This option is used for batched SMTP input, which is an alternative interface
3312 for non-interactive local message submission. A number of messages can be
3313 submitted in a single run. However, despite its name, this is not really SMTP
3314 input. Exim reads each message's envelope from SMTP commands on the standard
3315 input, but generates no responses. If the caller is trusted, or
3316 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3317 believed; otherwise the sender is always the caller of Exim.
3318
3319 The message itself is read from the standard input, in SMTP format (leading
3320 dots doubled), terminated by a line containing just a single dot. An error is
3321 provoked if the terminating dot is missing. A further message may then follow.
3322
3323 As for other local message submissions, the contents of incoming batch SMTP
3324 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3325 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3326 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3327
3328 Some other SMTP commands are recognized in the input. HELO and EHLO act
3329 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3330 QUIT quits, ignoring the rest of the standard input.
3331
3332 .cindex "return code" "for &%-bS%&"
3333 If any error is encountered, reports are written to the standard output and
3334 error streams, and Exim gives up immediately. The return code is 0 if no error
3335 was detected; it is 1 if one or more messages were accepted before the error
3336 was detected; otherwise it is 2.
3337
3338 More details of input using batched SMTP are given in section
3339 &<<SECTincomingbatchedSMTP>>&.
3340
3341 .vitem &%-bs%&
3342 .oindex "&%-bs%&"
3343 .cindex "SMTP" "local input"
3344 .cindex "local SMTP input"
3345 This option causes Exim to accept one or more messages by reading SMTP commands
3346 on the standard input, and producing SMTP replies on the standard output. SMTP
3347 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3348 Some user agents use this interface as a way of passing locally-generated
3349 messages to the MTA.
3350
3351 In
3352 .cindex "sender" "source of"
3353 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3354 set, the senders of messages are taken from the SMTP MAIL commands.
3355 Otherwise the content of these commands is ignored and the sender is set up as
3356 the calling user. Unqualified addresses are automatically qualified using
3357 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3358 &%-bnq%& option is used.
3359
3360 .cindex "inetd"
3361 The
3362 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3363 using a listening daemon. Exim can distinguish the two cases by checking
3364 whether the standard input is a TCP/IP socket. When Exim is called from
3365 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3366 above concerning senders and qualification do not apply. In this situation,
3367 Exim behaves in exactly the same way as it does when receiving a message via
3368 the listening daemon.
3369
3370 .vitem &%-bt%&
3371 .oindex "&%-bt%&"
3372 .cindex "testing" "addresses"
3373 .cindex "address" "testing"
3374 This option runs Exim in address testing mode, in which each argument is taken
3375 as a recipient address to be tested for deliverability. The results are
3376 written to the standard output. If a test fails, and the caller is not an admin
3377 user, no details of the failure are output, because these might contain
3378 sensitive information such as usernames and passwords for database lookups.
3379
3380 If no arguments are given, Exim runs in an interactive manner, prompting with a
3381 right angle bracket for addresses to be tested.
3382
3383 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3384 &[readline()]& function, because it is running as &'root'& and there are
3385 security issues.
3386
3387 Each address is handled as if it were the recipient address of a message
3388 (compare the &%-bv%& option). It is passed to the routers and the result is
3389 written to the standard output. However, any router that has
3390 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3391 genuine routing tests if your first router passes everything to a scanner
3392 program.
3393
3394 .cindex "return code" "for &%-bt%&"
3395 The return code is 2 if any address failed outright; it is 1 if no address
3396 failed outright but at least one could not be resolved for some reason. Return
3397 code 0 is given only when all addresses succeed.
3398
3399 .cindex "duplicate addresses"
3400 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3401 addresses after routing is complete, so that only one delivery takes place.
3402 This does not happen when testing with &%-bt%&; the full results of routing are
3403 always shown.
3404
3405 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3406 routers in the configuration makes any tests on the sender address of a
3407 message,
3408 .oindex "&%-f%&" "for address testing"
3409 you can use the &%-f%& option to set an appropriate sender when running
3410 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3411 default qualifying domain. However, if you have set up (for example) routers
3412 whose behaviour depends on the contents of an incoming message, you cannot test
3413 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3414 doing such tests.
3415
3416 .vitem &%-bV%&
3417 .oindex "&%-bV%&"
3418 .cindex "version number of Exim"
3419 This option causes Exim to write the current version number, compilation
3420 number, and compilation date of the &'exim'& binary to the standard output.
3421 It also lists the DBM library that is being used, the optional modules (such as
3422 specific lookup types), the drivers that are included in the binary, and the
3423 name of the runtime configuration file that is in use.
3424
3425 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3426 configuration file. However, this is a static check only. It cannot check
3427 values that are to be expanded. For example, although a misspelt ACL verb is
3428 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3429 alone to discover (for example) all the typos in the configuration; some
3430 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3431 dynamic testing facilities.
3432
3433 .vitem &%-bv%&
3434 .oindex "&%-bv%&"
3435 .cindex "verifying address" "using &%-bv%&"
3436 .cindex "address" "verification"
3437 This option runs Exim in address verification mode, in which each argument is
3438 taken as a recipient address to be verified by the routers. (This does
3439 not involve any verification callouts). During normal operation, verification
3440 happens mostly as a consequence processing a &%verify%& condition in an ACL
3441 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3442 including callouts, see the &%-bh%& and &%-bhc%& options.
3443
3444 If verification fails, and the caller is not an admin user, no details of the
3445 failure are output, because these might contain sensitive information such as
3446 usernames and passwords for database lookups.
3447
3448 If no arguments are given, Exim runs in an interactive manner, prompting with a
3449 right angle bracket for addresses to be verified.
3450
3451 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3452 &[readline()]& function, because it is running as &'exim'& and there are
3453 security issues.
3454
3455 Verification differs from address testing (the &%-bt%& option) in that routers
3456 that have &%no_verify%& set are skipped, and if the address is accepted by a
3457 router that has &%fail_verify%& set, verification fails. The address is
3458 verified as a recipient if &%-bv%& is used; to test verification for a sender
3459 address, &%-bvs%& should be used.
3460
3461 If the &%-v%& option is not set, the output consists of a single line for each
3462 address, stating whether it was verified or not, and giving a reason in the
3463 latter case. Without &%-v%&, generating more than one address by redirection
3464 causes verification to end successfully, without considering the generated
3465 addresses. However, if just one address is generated, processing continues,
3466 and the generated address must verify successfully for the overall verification
3467 to succeed.
3468
3469 When &%-v%& is set, more details are given of how the address has been handled,
3470 and in the case of address redirection, all the generated addresses are also
3471 considered. Verification may succeed for some and fail for others.
3472
3473 The
3474 .cindex "return code" "for &%-bv%&"
3475 return code is 2 if any address failed outright; it is 1 if no address
3476 failed outright but at least one could not be resolved for some reason. Return
3477 code 0 is given only when all addresses succeed.
3478
3479 If any of the routers in the configuration makes any tests on the sender
3480 address of a message, you should use the &%-f%& option to set an appropriate
3481 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3482 calling user at the default qualifying domain.
3483
3484 .vitem &%-bvs%&
3485 .oindex "&%-bvs%&"
3486 This option acts like &%-bv%&, but verifies the address as a sender rather
3487 than a recipient address. This affects any rewriting and qualification that
3488 might happen.
3489
3490 .vitem &%-bw%&
3491 .oindex "&%-bw%&"
3492 .cindex "daemon"
3493 .cindex "inetd"
3494 .cindex "inetd" "wait mode"
3495 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3496 similarly to the &%-bd%& option.  All port specifications on the command-line
3497 and in the configuration file are ignored.  Queue-running may not be specified.
3498
3499 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3500 listening for connections.  This permits the system to start up and have
3501 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3502 each port only when the first connection is received.
3503
3504 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3505 which the daemon will exit, which should cause inetd to listen once more.
3506
3507 .vitem &%-C%&&~<&'filelist'&>
3508 .oindex "&%-C%&"
3509 .cindex "configuration file" "alternate"
3510 .cindex "CONFIGURE_FILE"
3511 .cindex "alternate configuration file"
3512 This option causes Exim to find the runtime configuration file from the given
3513 list instead of from the list specified by the CONFIGURE_FILE
3514 compile-time setting. Usually, the list will consist of just a single filename,
3515 but it can be a colon-separated list of names. In this case, the first
3516 file that exists is used. Failure to open an existing file stops Exim from
3517 proceeding any further along the list, and an error is generated.
3518
3519 When this option is used by a caller other than root, and the list is different
3520 from the compiled-in list, Exim gives up its root privilege immediately, and
3521 runs with the real and effective uid and gid set to those of the caller.
3522 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3523 file contains a list of full pathnames, one per line, for configuration files
3524 which are trusted. Root privilege is retained for any configuration file so
3525 listed, as long as the caller is the Exim user (or the user specified in the
3526 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3527 not writeable by inappropriate users or groups.
3528
3529 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3530 configuration using &%-C%& right through message reception and delivery,
3531 even if the caller is root. The reception works, but by that time, Exim is
3532 running as the Exim user, so when it re-executes to regain privilege for the
3533 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3534 test reception and delivery using two separate commands (one to put a message
3535 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3536
3537 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3538 prefix string with which any file named in a &%-C%& command line option
3539 must start. In addition, the filename must not contain the sequence &`/../`&.
3540 However, if the value of the &%-C%& option is identical to the value of
3541 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3542 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3543 unset, any filename can be used with &%-C%&.
3544
3545 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3546 to a directory to which only root has access. This prevents someone who has
3547 broken into the Exim account from running a privileged Exim with an arbitrary
3548 configuration file.
3549
3550 The &%-C%& facility is useful for ensuring that configuration files are
3551 syntactically correct, but cannot be used for test deliveries, unless the
3552 caller is privileged, or unless it is an exotic configuration that does not
3553 require privilege. No check is made on the owner or group of the files
3554 specified by this option.
3555
3556
3557 .vitem &%-D%&<&'macro'&>=<&'value'&>
3558 .oindex "&%-D%&"
3559 .cindex "macro" "setting on command line"
3560 This option can be used to override macro definitions in the configuration file
3561 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3562 unprivileged caller, it causes Exim to give up its root privilege.
3563 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3564 completely disabled, and its use causes an immediate error exit.
3565
3566 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3567 colon-separated list of macros which are considered safe and, if &%-D%& only
3568 supplies macros from this list, and the values are acceptable, then Exim will
3569 not give up root privilege if the caller is root, the Exim run-time user, or
3570 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3571 to be removed in the future.  Acceptable values for the macros satisfy the
3572 regexp: &`^[A-Za-z0-9_/.-]*$`&
3573
3574 The entire option (including equals sign if present) must all be within one
3575 command line item. &%-D%& can be used to set the value of a macro to the empty
3576 string, in which case the equals sign is optional. These two commands are
3577 synonymous:
3578 .code
3579 exim -DABC  ...
3580 exim -DABC= ...
3581 .endd
3582 To include spaces in a macro definition item, quotes must be used. If you use
3583 quotes, spaces are permitted around the macro name and the equals sign. For
3584 example:
3585 .code
3586 exim '-D ABC = something' ...
3587 .endd
3588 &%-D%& may be repeated up to 10 times on a command line.
3589 Only macro names up to 22 letters long can be set.
3590
3591
3592 .vitem &%-d%&<&'debug&~options'&>
3593 .oindex "&%-d%&"
3594 .cindex "debugging" "list of selectors"
3595 .cindex "debugging" "&%-d%& option"
3596 This option causes debugging information to be written to the standard
3597 error stream. It is restricted to admin users because debugging output may show
3598 database queries that contain password information. Also, the details of users'
3599 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3600 writes an error message to the standard error stream and exits with a non-zero
3601 return code.
3602
3603 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3604 standard debugging data is output. This can be reduced, or increased to include
3605 some more rarely needed information, by directly following &%-d%& with a string
3606 made up of names preceded by plus or minus characters. These add or remove sets
3607 of debugging data, respectively. For example, &%-d+filter%& adds filter
3608 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3609 no spaces are allowed in the debug setting. The available debugging categories
3610 are:
3611 .display
3612 &`acl            `& ACL interpretation
3613 &`auth           `& authenticators
3614 &`deliver        `& general delivery logic
3615 &`dns            `& DNS lookups (see also resolver)
3616 &`dnsbl          `& DNS black list (aka RBL) code
3617 &`exec           `& arguments for &[execv()]& calls
3618 &`expand         `& detailed debugging for string expansions
3619 &`filter         `& filter handling
3620 &`hints_lookup   `& hints data lookups
3621 &`host_lookup    `& all types of name-to-IP address handling
3622 &`ident          `& ident lookup
3623 &`interface      `& lists of local interfaces
3624 &`lists          `& matching things in lists
3625 &`load           `& system load checks
3626 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3627                     &<<CHAPlocalscan>>&)
3628 &`lookup         `& general lookup code and all lookups
3629 &`memory         `& memory handling
3630 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3631 &`pid            `& modifier: add pid to debug output lines
3632 &`process_info   `& setting info for the process log
3633 &`queue_run      `& queue runs
3634 &`receive        `& general message reception logic
3635 &`resolver       `& turn on the DNS resolver's debugging output
3636 &`retry          `& retry handling
3637 &`rewrite        `& address rewriting
3638 &`route          `& address routing
3639 &`timestamp      `& modifier: add timestamp to debug output lines
3640 &`tls            `& TLS logic
3641 &`transport      `& transports
3642 &`uid            `& changes of uid/gid and looking up uid/gid
3643 &`verify         `& address verification logic
3644 &`all            `& almost all of the above (see below), and also &%-v%&
3645 .endd
3646 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3647 for &`-all`&. The reason for this is that &`+all`& is something that people
3648 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3649 is included, an awful lot of output that is very rarely of interest is
3650 generated, so it now has to be explicitly requested. However, &`-all`& does
3651 turn everything off.
3652
3653 .cindex "resolver, debugging output"
3654 .cindex "DNS resolver, debugging output"
3655 The &`resolver`& option produces output only if the DNS resolver was compiled
3656 with DEBUG enabled. This is not the case in some operating systems. Also,
3657 unfortunately, debugging output from the DNS resolver is written to stdout
3658 rather than stderr.
3659
3660 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3661 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3662 However, the &`pid`& selector is forced when debugging is turned on for a
3663 daemon, which then passes it on to any re-executed Exims. Exim also
3664 automatically adds the pid to debug lines when several remote deliveries are
3665 run in parallel.
3666
3667 The &`timestamp`& selector causes the current time to be inserted at the start
3668 of all debug output lines. This can be useful when trying to track down delays
3669 in processing.
3670
3671 .cindex debugging "UTF-8 in"
3672 .cindex UTF-8 "in debug output"
3673 The &`noutf8`& selector disables the use of
3674 UTF-8 line-drawing characters to group related information.
3675 When disabled. ascii-art is used instead.
3676 Using the &`+all`& option does not set this modifier,
3677
3678 If the &%debug_print%& option is set in any driver, it produces output whenever
3679 any debugging is selected, or if &%-v%& is used.
3680
3681 .vitem &%-dd%&<&'debug&~options'&>
3682 .oindex "&%-dd%&"
3683 This option behaves exactly like &%-d%& except when used on a command that
3684 starts a daemon process. In that case, debugging is turned off for the
3685 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3686 behaviour of the daemon without creating as much output as full debugging does.
3687
3688 .vitem &%-dropcr%&
3689 .oindex "&%-dropcr%&"
3690 This is an obsolete option that is now a no-op. It used to affect the way Exim
3691 handled CR and LF characters in incoming messages. What happens now is
3692 described in section &<<SECTlineendings>>&.
3693
3694 .vitem &%-E%&
3695 .oindex "&%-E%&"
3696 .cindex "bounce message" "generating"
3697 This option specifies that an incoming message is a locally-generated delivery
3698 failure report. It is used internally by Exim when handling delivery failures
3699 and is not intended for external use. Its only effect is to stop Exim
3700 generating certain messages to the postmaster, as otherwise message cascades
3701 could occur in some situations. As part of the same option, a message id may
3702 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3703 new message contains the id, following &"R="&, as a cross-reference.
3704
3705 .vitem &%-e%&&'x'&
3706 .oindex "&%-e%&&'x'&"
3707 There are a number of Sendmail options starting with &%-oe%& which seem to be
3708 called by various programs without the leading &%o%& in the option. For
3709 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3710 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3711
3712 .vitem &%-F%&&~<&'string'&>
3713 .oindex "&%-F%&"
3714 .cindex "sender" "name"
3715 .cindex "name" "of sender"
3716 This option sets the sender's full name for use when a locally-generated
3717 message is being accepted. In the absence of this option, the user's &'gecos'&
3718 entry from the password data is used. As users are generally permitted to alter
3719 their &'gecos'& entries, no security considerations are involved. White space
3720 between &%-F%& and the <&'string'&> is optional.
3721
3722 .vitem &%-f%&&~<&'address'&>
3723 .oindex "&%-f%&"
3724 .cindex "sender" "address"
3725 .cindex "address" "sender"
3726 .cindex "trusted users"
3727 .cindex "envelope from"
3728 .cindex "envelope sender"
3729 .cindex "user" "trusted"
3730 This option sets the address of the envelope sender of a locally-generated
3731 message (also known as the return path). The option can normally be used only
3732 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3733 users to use it.
3734
3735 Processes running as root or the Exim user are always trusted. Other
3736 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3737 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3738 of a local message is set to the caller's login name at the default qualify
3739 domain.
3740
3741 There is one exception to the restriction on the use of &%-f%&: an empty sender
3742 can be specified by any user, trusted or not, to create a message that can
3743 never provoke a bounce. An empty sender can be specified either as an empty
3744 string, or as a pair of angle brackets with nothing between them, as in these
3745 examples of shell commands:
3746 .code
3747 exim -f '<>' user@domain
3748 exim -f "" user@domain
3749 .endd
3750 In addition, the use of &%-f%& is not restricted when testing a filter file
3751 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3752 &%-bv%& options.
3753
3754 Allowing untrusted users to change the sender address does not of itself make
3755 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3756 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3757 though this can be overridden by setting &%no_local_from_check%&.
3758
3759 White
3760 .cindex "&""From""& line"
3761 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3762 given as two arguments or one combined argument). The sender of a
3763 locally-generated message can also be set (when permitted) by an initial
3764 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3765 if &%-f%& is also present, it overrides &"From&~"&.
3766
3767 .vitem &%-G%&
3768 .oindex "&%-G%&"
3769 .cindex "submission fixups, suppressing (command-line)"
3770 This option is equivalent to an ACL applying:
3771 .code
3772 control = suppress_local_fixups
3773 .endd
3774 for every message received.  Note that Sendmail will complain about such
3775 bad formatting, where Exim silently just does not fix it up.  This may change
3776 in future.
3777
3778 As this affects audit information, the caller must be a trusted user to use
3779 this option.
3780
3781 .vitem &%-h%&&~<&'number'&>
3782 .oindex "&%-h%&"
3783 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3784 This option is accepted for compatibility with Sendmail, but has no effect. (In
3785 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3786 headers.)
3787
3788 .vitem &%-i%&
3789 .oindex "&%-i%&"
3790 .cindex "Solaris" "&'mail'& command"
3791 .cindex "dot" "in incoming non-SMTP message"
3792 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3793 line by itself should not terminate an incoming, non-SMTP message. I can find
3794 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3795 command in Solaris 2.4 uses it. See also &%-ti%&.
3796
3797 .vitem &%-L%&&~<&'tag'&>
3798 .oindex "&%-L%&"
3799 .cindex "syslog" "process name; set with flag"
3800 This option is equivalent to setting &%syslog_processname%& in the config
3801 file and setting &%log_file_path%& to &`syslog`&.
3802 Its use is restricted to administrators.  The configuration file has to be
3803 read and parsed, to determine access rights, before this is set and takes
3804 effect, so early configuration file errors will not honour this flag.
3805
3806 The tag should not be longer than 32 characters.
3807
3808 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3809 .oindex "&%-M%&"
3810 .cindex "forcing delivery"
3811 .cindex "delivery" "forcing attempt"
3812 .cindex "frozen messages" "forcing delivery"
3813 This option requests Exim to run a delivery attempt on each message in turn. If
3814 any of the messages are frozen, they are automatically thawed before the
3815 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3816 and &%hold_domains%& are ignored.
3817
3818 Retry
3819 .cindex "hints database" "overriding retry hints"
3820 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3821 the normal retry time has not yet been reached. This option requires the caller
3822 to be an admin user. However, there is an option called &%prod_requires_admin%&
3823 which can be set false to relax this restriction (and also the same requirement
3824 for the &%-q%&, &%-R%&, and &%-S%& options).
3825
3826 The deliveries happen synchronously, that is, the original Exim process does
3827 not terminate until all the delivery attempts have finished. No output is
3828 produced unless there is a serious error. If you want to see what is happening,
3829 use the &%-v%& option as well, or inspect Exim's main log.
3830
3831 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3832 .oindex "&%-Mar%&"
3833 .cindex "message" "adding recipients"
3834 .cindex "recipient" "adding"
3835 This option requests Exim to add the addresses to the list of recipients of the
3836 message (&"ar"& for &"add recipients"&). The first argument must be a message
3837 id, and the remaining ones must be email addresses. However, if the message is
3838 active (in the middle of a delivery attempt), it is not altered. This option
3839 can be used only by an admin user.
3840
3841 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3842         &~<&'message&~id'&>"
3843 .oindex "&%-MC%&"
3844 .cindex "SMTP" "passed connection"
3845 .cindex "SMTP" "multiple deliveries"
3846 .cindex "multiple SMTP deliveries"
3847 This option is not intended for use by external callers. It is used internally
3848 by Exim to invoke another instance of itself to deliver a waiting message using
3849 an existing SMTP connection, which is passed as the standard input. Details are
3850 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3851 must be root or the Exim user in order to use it.
3852
3853 .vitem &%-MCA%&
3854 .oindex "&%-MCA%&"
3855 This option is not intended for use by external callers. It is used internally
3856 by Exim in conjunction with the &%-MC%& option. It signifies that the
3857 connection to the remote host has been authenticated.
3858
3859 .vitem &%-MCD%&
3860 .oindex "&%-MCD%&"
3861 This option is not intended for use by external callers. It is used internally
3862 by Exim in conjunction with the &%-MC%& option. It signifies that the
3863 remote host supports the ESMTP &_DSN_& extension.
3864
3865 .vitem &%-MCG%&&~<&'queue&~name'&>
3866 .oindex "&%-MCG%&"
3867 This option is not intended for use by external callers. It is used internally
3868 by Exim in conjunction with the &%-MC%& option. It signifies that an
3869 alternate queue is used, named by the following argument.
3870
3871 .vitem &%-MCK%&
3872 .oindex "&%-MCK%&"
3873 This option is not intended for use by external callers. It is used internally
3874 by Exim in conjunction with the &%-MC%& option. It signifies that a
3875 remote host supports the ESMTP &_CHUNKING_& extension.
3876
3877 .vitem &%-MCP%&
3878 .oindex "&%-MCP%&"
3879 This option is not intended for use by external callers. It is used internally
3880 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3881 which Exim is connected supports pipelining.
3882
3883 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3884 .oindex "&%-MCQ%&"
3885 This option is not intended for use by external callers. It is used internally
3886 by Exim in conjunction with the &%-MC%& option when the original delivery was
3887 started by a queue runner. It passes on the process id of the queue runner,
3888 together with the file descriptor number of an open pipe. Closure of the pipe
3889 signals the final completion of the sequence of processes that are passing
3890 messages through the same SMTP connection.
3891
3892 .vitem &%-MCS%&
3893 .oindex "&%-MCS%&"
3894 This option is not intended for use by external callers. It is used internally
3895 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3896 SMTP SIZE option should be used on messages delivered down the existing
3897 connection.
3898
3899 .vitem &%-MCT%&
3900 .oindex "&%-MCT%&"
3901 This option is not intended for use by external callers. It is used internally
3902 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3903 host to which Exim is connected supports TLS encryption.
3904
3905 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3906 .oindex "&%-MCt%&"
3907 This option is not intended for use by external callers. It is used internally
3908 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3909 connection is being proxied by a parent process for handling TLS encryption.
3910 The arguments give the local address and port being proxied, and the TLS cipher.
3911
3912 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3913 .oindex "&%-Mc%&"
3914 .cindex "hints database" "not overridden by &%-Mc%&"
3915 .cindex "delivery" "manually started &-- not forced"
3916 This option requests Exim to run a delivery attempt on each message, in turn,
3917 but unlike the &%-M%& option, it does check for retry hints, and respects any
3918 that are found. This option is not very useful to external callers. It is
3919 provided mainly for internal use by Exim when it needs to re-invoke itself in
3920 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3921 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3922 respects retry times and other options such as &%hold_domains%& that are
3923 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3924 If you want to run a specific delivery as if in a queue run, you should use
3925 &%-q%& with a message id argument. A distinction between queue run deliveries
3926 and other deliveries is made in one or two places.
3927
3928 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3929 .oindex "&%-Mes%&"
3930 .cindex "message" "changing sender"
3931 .cindex "sender" "changing"
3932 This option requests Exim to change the sender address in the message to the
3933 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3934 &"edit sender"&). There must be exactly two arguments. The first argument must
3935 be a message id, and the second one an email address. However, if the message
3936 is active (in the middle of a delivery attempt), its status is not altered.
3937 This option can be used only by an admin user.
3938
3939 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3940 .oindex "&%-Mf%&"
3941 .cindex "freezing messages"
3942 .cindex "message" "manually freezing"
3943 This option requests Exim to mark each listed message as &"frozen"&. This
3944 prevents any delivery attempts taking place until the message is &"thawed"&,
3945 either manually or as a result of the &%auto_thaw%& configuration option.
3946 However, if any of the messages are active (in the middle of a delivery
3947 attempt), their status is not altered. This option can be used only by an admin
3948 user.
3949
3950 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3951 .oindex "&%-Mg%&"
3952 .cindex "giving up on messages"
3953 .cindex "message" "abandoning delivery attempts"
3954 .cindex "delivery" "abandoning further attempts"
3955 This option requests Exim to give up trying to deliver the listed messages,
3956 including any that are frozen. However, if any of the messages are active,
3957 their status is not altered. For non-bounce messages, a delivery error message
3958 is sent to the sender, containing the text &"cancelled by administrator"&.
3959 Bounce messages are just discarded. This option can be used only by an admin
3960 user.
3961
3962 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3963 .oindex "&%-Mmad%&"
3964 .cindex "delivery" "cancelling all"
3965 This option requests Exim to mark all the recipient addresses in the messages
3966 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3967 message is active (in the middle of a delivery attempt), its status is not
3968 altered. This option can be used only by an admin user.
3969
3970 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3971 .oindex "&%-Mmd%&"
3972 .cindex "delivery" "cancelling by address"
3973 .cindex "recipient" "removing"
3974 .cindex "removing recipients"
3975 This option requests Exim to mark the given addresses as already delivered
3976 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3977 the remaining ones must be email addresses. These are matched to recipient
3978 addresses in the message in a case-sensitive manner. If the message is active
3979 (in the middle of a delivery attempt), its status is not altered. This option
3980 can be used only by an admin user.
3981
3982 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-Mrm%&"
3984 .cindex "removing messages"
3985 .cindex "abandoning mail"
3986 .cindex "message" "manually discarding"
3987 This option requests Exim to remove the given messages from the queue. No
3988 bounce messages are sent; each message is simply forgotten. However, if any of
3989 the messages are active, their status is not altered. This option can be used
3990 only by an admin user or by the user who originally caused the message to be
3991 placed in the queue.
3992
3993 . .new
3994 . .vitem &%-MS%&
3995 . .oindex "&%-MS%&"
3996 . .cindex REQUIRETLS
3997 . This option is used to request REQUIRETLS processing on the message.
3998 . It is used internally by Exim in conjunction with -E when generating
3999 . a bounce message.
4000 . .wen
4001
4002 .vitem &%-Mset%&&~<&'message&~id'&>
4003 .oindex "&%-Mset%&"
4004 .cindex "testing" "string expansion"
4005 .cindex "expansion" "testing"
4006 This option is useful only in conjunction with &%-be%& (that is, when testing
4007 string expansions). Exim loads the given message from its spool before doing
4008 the test expansions, thus setting message-specific variables such as
4009 &$message_size$& and the header variables. The &$recipients$& variable is made
4010 available. This feature is provided to make it easier to test expansions that
4011 make use of these variables. However, this option can be used only by an admin
4012 user. See also &%-bem%&.
4013
4014 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mt%&"
4016 .cindex "thawing messages"
4017 .cindex "unfreezing messages"
4018 .cindex "frozen messages" "thawing"
4019 .cindex "message" "thawing frozen"
4020 This option requests Exim to &"thaw"& any of the listed messages that are
4021 &"frozen"&, so that delivery attempts can resume. However, if any of the
4022 messages are active, their status is not altered. This option can be used only
4023 by an admin user.
4024
4025 .vitem &%-Mvb%&&~<&'message&~id'&>
4026 .oindex "&%-Mvb%&"
4027 .cindex "listing" "message body"
4028 .cindex "message" "listing body of"
4029 This option causes the contents of the message body (-D) spool file to be
4030 written to the standard output. This option can be used only by an admin user.
4031
4032 .vitem &%-Mvc%&&~<&'message&~id'&>
4033 .oindex "&%-Mvc%&"
4034 .cindex "message" "listing in RFC 2822 format"
4035 .cindex "listing" "message in RFC 2822 format"
4036 This option causes a copy of the complete message (header lines plus body) to
4037 be written to the standard output in RFC 2822 format. This option can be used
4038 only by an admin user.
4039
4040 .vitem &%-Mvh%&&~<&'message&~id'&>
4041 .oindex "&%-Mvh%&"
4042 .cindex "listing" "message headers"
4043 .cindex "header lines" "listing"
4044 .cindex "message" "listing header lines"
4045 This option causes the contents of the message headers (-H) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvl%&&~<&'message&~id'&>
4049 .oindex "&%-Mvl%&"
4050 .cindex "listing" "message log"
4051 .cindex "message" "listing message log"
4052 This option causes the contents of the message log spool file to be written to
4053 the standard output. This option can be used only by an admin user.
4054
4055 .vitem &%-m%&
4056 .oindex "&%-m%&"
4057 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4058 treats it that way too.
4059
4060 .vitem &%-N%&
4061 .oindex "&%-N%&"
4062 .cindex "debugging" "&%-N%& option"
4063 .cindex "debugging" "suppressing delivery"
4064 This is a debugging option that inhibits delivery of a message at the transport
4065 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4066 it just doesn't actually transport the message, but instead behaves as if it
4067 had successfully done so. However, it does not make any updates to the retry
4068 database, and the log entries for deliveries are flagged with &"*>"& rather
4069 than &"=>"&.
4070
4071 Because &%-N%& discards any message to which it applies, only root or the Exim
4072 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4073 words, an ordinary user can use it only when supplying an incoming message to
4074 which it will apply. Although transportation never fails when &%-N%& is set, an
4075 address may be deferred because of a configuration problem on a transport, or a
4076 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4077 the message, and applies to any subsequent delivery attempts that may happen
4078 for that message.
4079
4080 .vitem &%-n%&
4081 .oindex "&%-n%&"
4082 This option is interpreted by Sendmail to mean &"no aliasing"&.
4083 For normal modes of operation, it is ignored by Exim.
4084 When combined with &%-bP%& it makes the output more terse (suppresses
4085 option names, environment values and config pretty printing).
4086
4087 .vitem &%-O%&&~<&'data'&>
4088 .oindex "&%-O%&"
4089 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4090 Exim.
4091
4092 .vitem &%-oA%&&~<&'file&~name'&>
4093 .oindex "&%-oA%&"
4094 .cindex "Sendmail compatibility" "&%-oA%& option"
4095 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4096 alternative alias filename. Exim handles &%-bi%& differently; see the
4097 description above.
4098
4099 .vitem &%-oB%&&~<&'n'&>
4100 .oindex "&%-oB%&"
4101 .cindex "SMTP" "passed connection"
4102 .cindex "SMTP" "multiple deliveries"
4103 .cindex "multiple SMTP deliveries"
4104 This is a debugging option which limits the maximum number of messages that can
4105 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4106 transport. If <&'n'&> is omitted, the limit is set to 1.
4107
4108 .vitem &%-odb%&
4109 .oindex "&%-odb%&"
4110 .cindex "background delivery"
4111 .cindex "delivery" "in the background"
4112 This option applies to all modes in which Exim accepts incoming messages,
4113 including the listening daemon. It requests &"background"& delivery of such
4114 messages, which means that the accepting process automatically starts a
4115 delivery process for each message received, but does not wait for the delivery
4116 processes to finish.
4117
4118 When all the messages have been received, the reception process exits,
4119 leaving the delivery processes to finish in their own time. The standard output
4120 and error streams are closed at the start of each delivery process.
4121 This is the default action if none of the &%-od%& options are present.
4122
4123 If one of the queueing options in the configuration file
4124 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4125 overrides it if &%queue_only_override%& is set true, which is the default
4126 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4127
4128 .vitem &%-odf%&
4129 .oindex "&%-odf%&"
4130 .cindex "foreground delivery"
4131 .cindex "delivery" "in the foreground"
4132 This option requests &"foreground"& (synchronous) delivery when Exim has
4133 accepted a locally-generated message. (For the daemon it is exactly the same as
4134 &%-odb%&.) A delivery process is automatically started to deliver the message,
4135 and Exim waits for it to complete before proceeding.
4136
4137 The original Exim reception process does not finish until the delivery
4138 process for the final message has ended. The standard error stream is left open
4139 during deliveries.
4140
4141 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4142 false and one of the queueing options in the configuration file is in effect.
4143
4144 If there is a temporary delivery error during foreground delivery, the
4145 message is left in the queue for later delivery, and the original reception
4146 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4147 restricted configuration that never queues messages.
4148
4149
4150 .vitem &%-odi%&
4151 .oindex "&%-odi%&"
4152 This option is synonymous with &%-odf%&. It is provided for compatibility with
4153 Sendmail.
4154
4155 .vitem &%-odq%&
4156 .oindex "&%-odq%&"
4157 .cindex "non-immediate delivery"
4158 .cindex "delivery" "suppressing immediate"
4159 .cindex "queueing incoming messages"
4160 This option applies to all modes in which Exim accepts incoming messages,
4161 including the listening daemon. It specifies that the accepting process should
4162 not automatically start a delivery process for each message received. Messages
4163 are placed in the queue, and remain there until a subsequent queue runner
4164 process encounters them. There are several configuration options (such as
4165 &%queue_only%&) that can be used to queue incoming messages under certain
4166 conditions. This option overrides all of them and also &%-odqs%&. It always
4167 forces queueing.
4168
4169 .vitem &%-odqs%&
4170 .oindex "&%-odqs%&"
4171 .cindex "SMTP" "delaying delivery"
4172 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4173 However, like &%-odb%& and &%-odi%&, this option has no effect if
4174 &%queue_only_override%& is false and one of the queueing options in the
4175 configuration file is in effect.
4176
4177 When &%-odqs%& does operate, a delivery process is started for each incoming
4178 message, in the background by default, but in the foreground if &%-odi%& is
4179 also present. The recipient addresses are routed, and local deliveries are done
4180 in the normal way. However, if any SMTP deliveries are required, they are not
4181 done at this time, so the message remains in the queue until a subsequent queue
4182 runner process encounters it. Because routing was done, Exim knows which
4183 messages are waiting for which hosts, and so a number of messages for the same
4184 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4185 configuration option has the same effect for specific domains. See also the
4186 &%-qq%& option.
4187
4188 .vitem &%-oee%&
4189 .oindex "&%-oee%&"
4190 .cindex "error" "reporting"
4191 If an error is detected while a non-SMTP message is being received (for
4192 example, a malformed address), the error is reported to the sender in a mail
4193 message.
4194
4195 .cindex "return code" "for &%-oee%&"
4196 Provided
4197 this error message is successfully sent, the Exim receiving process
4198 exits with a return code of zero. If not, the return code is 2 if the problem
4199 is that the original message has no recipients, or 1 for any other error.
4200 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4201
4202 .vitem &%-oem%&
4203 .oindex "&%-oem%&"
4204 .cindex "error" "reporting"
4205 .cindex "return code" "for &%-oem%&"
4206 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4207 return code, whether or not the error message was successfully sent.
4208 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4209
4210 .vitem &%-oep%&
4211 .oindex "&%-oep%&"
4212 .cindex "error" "reporting"
4213 If an error is detected while a non-SMTP message is being received, the
4214 error is reported by writing a message to the standard error file (stderr).
4215 .cindex "return code" "for &%-oep%&"
4216 The return code is 1 for all errors.
4217
4218 .vitem &%-oeq%&
4219 .oindex "&%-oeq%&"
4220 .cindex "error" "reporting"
4221 This option is supported for compatibility with Sendmail, but has the same
4222 effect as &%-oep%&.
4223
4224 .vitem &%-oew%&
4225 .oindex "&%-oew%&"
4226 .cindex "error" "reporting"
4227 This option is supported for compatibility with Sendmail, but has the same
4228 effect as &%-oem%&.
4229
4230 .vitem &%-oi%&
4231 .oindex "&%-oi%&"
4232 .cindex "dot" "in incoming non-SMTP message"
4233 This option, which has the same effect as &%-i%&, specifies that a dot on a
4234 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4235 single dot does terminate, though Exim does no special processing for other
4236 lines that start with a dot. This option is set by default if Exim is called as
4237 &'rmail'&. See also &%-ti%&.
4238
4239 .vitem &%-oitrue%&
4240 .oindex "&%-oitrue%&"
4241 This option is treated as synonymous with &%-oi%&.
4242
4243 .vitem &%-oMa%&&~<&'host&~address'&>
4244 .oindex "&%-oMa%&"
4245 .cindex "sender" "host address, specifying for local message"
4246 A number of options starting with &%-oM%& can be used to set values associated
4247 with remote hosts on locally-submitted messages (that is, messages not received
4248 over TCP/IP). These options can be used by any caller in conjunction with the
4249 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4250 other circumstances, they are ignored unless the caller is trusted.
4251
4252 The &%-oMa%& option sets the sender host address. This may include a port
4253 number at the end, after a full stop (period). For example:
4254 .code
4255 exim -bs -oMa 10.9.8.7.1234
4256 .endd
4257 An alternative syntax is to enclose the IP address in square brackets,
4258 followed by a colon and the port number:
4259 .code
4260 exim -bs -oMa [10.9.8.7]:1234
4261 .endd
4262 The IP address is placed in the &$sender_host_address$& variable, and the
4263 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4264 are present on the command line, the sender host IP address is taken from
4265 whichever one is last.
4266
4267 .vitem &%-oMaa%&&~<&'name'&>
4268 .oindex "&%-oMaa%&"
4269 .cindex "authentication" "name, specifying for local message"
4270 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4271 option sets the value of &$sender_host_authenticated$& (the authenticator
4272 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4273 This option can be used with &%-bh%& and &%-bs%& to set up an
4274 authenticated SMTP session without actually using the SMTP AUTH command.
4275
4276 .vitem &%-oMai%&&~<&'string'&>
4277 .oindex "&%-oMai%&"
4278 .cindex "authentication" "id, specifying for local message"
4279 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4280 option sets the value of &$authenticated_id$& (the id that was authenticated).
4281 This overrides the default value (the caller's login id, except with &%-bh%&,
4282 where there is no default) for messages from local sources. See chapter
4283 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4284
4285 .vitem &%-oMas%&&~<&'address'&>
4286 .oindex "&%-oMas%&"
4287 .cindex "authentication" "sender, specifying for local message"
4288 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4289 option sets the authenticated sender value in &$authenticated_sender$&. It
4290 overrides the sender address that is created from the caller's login id for
4291 messages from local sources, except when &%-bh%& is used, when there is no
4292 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4293 specified on a MAIL command overrides this value. See chapter
4294 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4295
4296 .vitem &%-oMi%&&~<&'interface&~address'&>
4297 .oindex "&%-oMi%&"
4298 .cindex "interface" "address, specifying for local message"
4299 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4300 option sets the IP interface address value. A port number may be included,
4301 using the same syntax as for &%-oMa%&. The interface address is placed in
4302 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4303
4304 .vitem &%-oMm%&&~<&'message&~reference'&>
4305 .oindex "&%-oMm%&"
4306 .cindex "message reference" "message reference, specifying for local message"
4307 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4308 option sets the message reference, e.g. message-id, and is logged during
4309 delivery. This is useful when some kind of audit trail is required to tie
4310 messages together. The format of the message reference is checked and will
4311 abort if the format is invalid. The option will only be accepted if exim is
4312 running in trusted mode, not as any regular user.
4313
4314 The best example of a message reference is when Exim sends a bounce message.
4315 The message reference is the message-id of the original message for which Exim
4316 is sending the bounce.
4317
4318 .vitem &%-oMr%&&~<&'protocol&~name'&>
4319 .oindex "&%-oMr%&"
4320 .cindex "protocol, specifying for local message"
4321 .vindex "&$received_protocol$&"
4322 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4323 option sets the received protocol value that is stored in
4324 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4325 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4326 SMTP protocol names (see the description of &$received_protocol$& in section
4327 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4328 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4329 be set by &%-oMr%&. Repeated use of this option is not supported.
4330
4331 .vitem &%-oMs%&&~<&'host&~name'&>
4332 .oindex "&%-oMs%&"
4333 .cindex "sender" "host name, specifying for local message"
4334 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4335 option sets the sender host name in &$sender_host_name$&. When this option is
4336 present, Exim does not attempt to look up a host name from an IP address; it
4337 uses the name it is given.
4338
4339 .vitem &%-oMt%&&~<&'ident&~string'&>
4340 .oindex "&%-oMt%&"
4341 .cindex "sender" "ident string, specifying for local message"
4342 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4343 option sets the sender ident value in &$sender_ident$&. The default setting for
4344 local callers is the login id of the calling process, except when &%-bh%& is
4345 used, when there is no default.
4346
4347 .vitem &%-om%&
4348 .oindex "&%-om%&"
4349 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4350 In Sendmail, this option means &"me too"&, indicating that the sender of a
4351 message should receive a copy of the message if the sender appears in an alias
4352 expansion. Exim always does this, so the option does nothing.
4353
4354 .vitem &%-oo%&
4355 .oindex "&%-oo%&"
4356 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4357 This option is ignored. In Sendmail it specifies &"old style headers"&,
4358 whatever that means.
4359
4360 .vitem &%-oP%&&~<&'path'&>
4361 .oindex "&%-oP%&"
4362 .cindex "pid (process id)" "of daemon"
4363 .cindex "daemon" "process id (pid)"
4364 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4365 value. The option specifies the file to which the process id of the daemon is
4366 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4367 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4368 because in those cases, the normal pid file is not used.
4369
4370 .vitem &%-or%&&~<&'time'&>
4371 .oindex "&%-or%&"
4372 .cindex "timeout" "for non-SMTP input"
4373 This option sets a timeout value for incoming non-SMTP messages. If it is not
4374 set, Exim will wait forever for the standard input. The value can also be set
4375 by the &%receive_timeout%& option. The format used for specifying times is
4376 described in section &<<SECTtimeformat>>&.
4377
4378 .vitem &%-os%&&~<&'time'&>
4379 .oindex "&%-os%&"
4380 .cindex "timeout" "for SMTP input"
4381 .cindex "SMTP" "input timeout"
4382 This option sets a timeout value for incoming SMTP messages. The timeout
4383 applies to each SMTP command and block of data. The value can also be set by
4384 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4385 for specifying times is described in section &<<SECTtimeformat>>&.
4386
4387 .vitem &%-ov%&
4388 .oindex "&%-ov%&"
4389 This option has exactly the same effect as &%-v%&.
4390
4391 .vitem &%-oX%&&~<&'number&~or&~string'&>
4392 .oindex "&%-oX%&"
4393 .cindex "TCP/IP" "setting listening ports"
4394 .cindex "TCP/IP" "setting listening interfaces"
4395 .cindex "port" "receiving TCP/IP"
4396 This option is relevant only when the &%-bd%& (start listening daemon) option
4397 is also given. It controls which ports and interfaces the daemon uses. Details
4398 of the syntax, and how it interacts with configuration file options, are given
4399 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4400 file is written unless &%-oP%& is also present to specify a pid filename.
4401
4402 .vitem &%-pd%&
4403 .oindex "&%-pd%&"
4404 .cindex "Perl" "starting the interpreter"
4405 This option applies when an embedded Perl interpreter is linked with Exim (see
4406 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4407 option, forcing the starting of the interpreter to be delayed until it is
4408 needed.
4409
4410 .vitem &%-ps%&
4411 .oindex "&%-ps%&"
4412 .cindex "Perl" "starting the interpreter"
4413 This option applies when an embedded Perl interpreter is linked with Exim (see
4414 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4415 option, forcing the starting of the interpreter to occur as soon as Exim is
4416 started.
4417
4418 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4419 .oindex "&%-p%&"
4420 For compatibility with Sendmail, this option is equivalent to
4421 .display
4422 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4423 .endd
4424 It sets the incoming protocol and host name (for trusted callers). The
4425 host name and its colon can be omitted when only the protocol is to be set.
4426 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4427 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4428 or &`s`& using this option (but that does not seem a real limitation).
4429 Repeated use of this option is not supported.
4430
4431 .vitem &%-q%&
4432 .oindex "&%-q%&"
4433 .cindex "queue runner" "starting manually"
4434 This option is normally restricted to admin users. However, there is a
4435 configuration option called &%prod_requires_admin%& which can be set false to
4436 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4437 and &%-S%& options).
4438
4439 .cindex "queue runner" "description of operation"
4440 If other commandline options do not specify an action,
4441 the &%-q%& option starts one queue runner process. This scans the queue of
4442 waiting messages, and runs a delivery process for each one in turn. It waits
4443 for each delivery process to finish before starting the next one. A delivery
4444 process may not actually do any deliveries if the retry times for the addresses
4445 have not been reached. Use &%-qf%& (see below) if you want to override this.
4446
4447 If
4448 .cindex "SMTP" "passed connection"
4449 .cindex "SMTP" "multiple deliveries"
4450 .cindex "multiple SMTP deliveries"
4451 the delivery process spawns other processes to deliver other messages down
4452 passed SMTP connections, the queue runner waits for these to finish before
4453 proceeding.
4454
4455 When all the queued messages have been considered, the original queue runner
4456 process terminates. In other words, a single pass is made over the waiting
4457 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4458 this to be repeated periodically.
4459
4460 Exim processes the waiting messages in an unpredictable order. It isn't very
4461 random, but it is likely to be different each time, which is all that matters.
4462 If one particular message screws up a remote MTA, other messages to the same
4463 MTA have a chance of getting through if they get tried first.
4464
4465 It is possible to cause the messages to be processed in lexical message id
4466 order, which is essentially the order in which they arrived, by setting the
4467 &%queue_run_in_order%& option, but this is not recommended for normal use.
4468
4469 .vitem &%-q%&<&'qflags'&>
4470 The &%-q%& option may be followed by one or more flag letters that change its
4471 behaviour. They are all optional, but if more than one is present, they must
4472 appear in the correct order. Each flag is described in a separate item below.
4473
4474 .vitem &%-qq...%&
4475 .oindex "&%-qq%&"
4476 .cindex "queue" "double scanning"
4477 .cindex "queue" "routing"
4478 .cindex "routing" "whole queue before delivery"
4479 An option starting with &%-qq%& requests a two-stage queue run. In the first
4480 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4481 every domain. Addresses are routed, local deliveries happen, but no remote
4482 transports are run.
4483
4484 .cindex "hints database" "remembering routing"
4485 The hints database that remembers which messages are waiting for specific hosts
4486 is updated, as if delivery to those hosts had been deferred. After this is
4487 complete, a second, normal queue scan happens, with routing and delivery taking
4488 place as normal. Messages that are routed to the same host should mostly be
4489 delivered down a single SMTP
4490 .cindex "SMTP" "passed connection"
4491 .cindex "SMTP" "multiple deliveries"
4492 .cindex "multiple SMTP deliveries"
4493 connection because of the hints that were set up during the first queue scan.
4494 This option may be useful for hosts that are connected to the Internet
4495 intermittently.
4496
4497 .vitem &%-q[q]i...%&
4498 .oindex "&%-qi%&"
4499 .cindex "queue" "initial delivery"
4500 If the &'i'& flag is present, the queue runner runs delivery processes only for
4501 those messages that haven't previously been tried. (&'i'& stands for &"initial
4502 delivery"&.) This can be helpful if you are putting messages in the queue using
4503 &%-odq%& and want a queue runner just to process the new messages.
4504
4505 .vitem &%-q[q][i]f...%&
4506 .oindex "&%-qf%&"
4507 .cindex "queue" "forcing delivery"
4508 .cindex "delivery" "forcing in queue run"
4509 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4510 message, whereas without &'f'& only those non-frozen addresses that have passed
4511 their retry times are tried.
4512
4513 .vitem &%-q[q][i]ff...%&
4514 .oindex "&%-qff%&"
4515 .cindex "frozen messages" "forcing delivery"
4516 If &'ff'& is present, a delivery attempt is forced for every message, whether
4517 frozen or not.
4518
4519 .vitem &%-q[q][i][f[f]]l%&
4520 .oindex "&%-ql%&"
4521 .cindex "queue" "local deliveries only"
4522 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4523 be done. If a message requires any remote deliveries, it remains in the queue
4524 for later delivery.
4525
4526 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4527 .oindex "&%-qG%&"
4528 .cindex queue named
4529 .cindex "named queues"
4530 .cindex "queue" "delivering specific messages"
4531 If the &'G'& flag and a name is present, the queue runner operates on the
4532 queue with the given name rather than the default queue.
4533 The name should not contain a &'/'& character.
4534 For a periodic queue run (see below)
4535 append to the name a slash and a time value.
4536
4537 If other commandline options specify an action, a &'-qG<name>'& option
4538 will specify a queue to operate on.
4539 For example:
4540 .code
4541 exim -bp -qGquarantine
4542 mailq -qGquarantine
4543 exim -qGoffpeak -Rf @special.domain.example
4544 .endd
4545
4546 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4547 When scanning the queue, Exim can be made to skip over messages whose ids are
4548 lexically less than a given value by following the &%-q%& option with a
4549 starting message id. For example:
4550 .code
4551 exim -q 0t5C6f-0000c8-00
4552 .endd
4553 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4554 second message id is given, messages whose ids are lexically greater than it
4555 are also skipped. If the same id is given twice, for example,
4556 .code
4557 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4558 .endd
4559 just one delivery process is started, for that message. This differs from
4560 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4561 that it counts as a delivery from a queue run. Note that the selection
4562 mechanism does not affect the order in which the messages are scanned. There
4563 are also other ways of selecting specific sets of messages for delivery in a
4564 queue run &-- see &%-R%& and &%-S%&.
4565
4566 .vitem &%-q%&<&'qflags'&><&'time'&>
4567 .cindex "queue runner" "starting periodically"
4568 .cindex "periodic queue running"
4569 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4570 starting a queue runner process at intervals specified by the given time value
4571 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4572 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4573 single daemon process handles both functions. A common way of starting up a
4574 combined daemon at system boot time is to use a command such as
4575 .code
4576 /usr/exim/bin/exim -bd -q30m
4577 .endd
4578 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4579 process every 30 minutes.
4580
4581 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4582 pid file is written unless one is explicitly requested by the &%-oP%& option.
4583
4584 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4585 .oindex "&%-qR%&"
4586 This option is synonymous with &%-R%&. It is provided for Sendmail
4587 compatibility.
4588
4589 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4590 .oindex "&%-qS%&"
4591 This option is synonymous with &%-S%&.
4592
4593 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4594 .oindex "&%-R%&"
4595 .cindex "queue runner" "for specific recipients"
4596 .cindex "delivery" "to given domain"
4597 .cindex "domain" "delivery to"
4598 The <&'rsflags'&> may be empty, in which case the white space before the string
4599 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4600 which are the possible values for <&'rsflags'&>. White space is required if
4601 <&'rsflags'&> is not empty.
4602
4603 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4604 perform a single queue run, except that, when scanning the messages on the
4605 queue, Exim processes only those that have at least one undelivered recipient
4606 address containing the given string, which is checked in a case-independent
4607 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4608 regular expression; otherwise it is a literal string.
4609
4610 If you want to do periodic queue runs for messages with specific recipients,
4611 you can combine &%-R%& with &%-q%& and a time value. For example:
4612 .code
4613 exim -q25m -R @special.domain.example
4614 .endd
4615 This example does a queue run for messages with recipients in the given domain
4616 every 25 minutes. Any additional flags that are specified with &%-q%& are
4617 applied to each queue run.
4618
4619 Once a message is selected for delivery by this mechanism, all its addresses
4620 are processed. For the first selected message, Exim overrides any retry
4621 information and forces a delivery attempt for each undelivered address. This
4622 means that if delivery of any address in the first message is successful, any
4623 existing retry information is deleted, and so delivery attempts for that
4624 address in subsequently selected messages (which are processed without forcing)
4625 will run. However, if delivery of any address does not succeed, the retry
4626 information is updated, and in subsequently selected messages, the failing
4627 address will be skipped.
4628
4629 .cindex "frozen messages" "forcing delivery"
4630 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4631 all selected messages, not just the first; frozen messages are included when
4632 &'ff'& is present.
4633
4634 The &%-R%& option makes it straightforward to initiate delivery of all messages
4635 to a given domain after a host has been down for some time. When the SMTP
4636 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4637 effect is to run Exim with the &%-R%& option, but it can be configured to run
4638 an arbitrary command instead.
4639
4640 .vitem &%-r%&
4641 .oindex "&%-r%&"
4642 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4643
4644 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4645 .oindex "&%-S%&"
4646 .cindex "delivery" "from given sender"
4647 .cindex "queue runner" "for specific senders"
4648 This option acts like &%-R%& except that it checks the string against each
4649 message's sender instead of against the recipients. If &%-R%& is also set, both
4650 conditions must be met for a message to be selected. If either of the options
4651 has &'f'& or &'ff'& in its flags, the associated action is taken.
4652
4653 .vitem &%-Tqt%&&~<&'times'&>
4654 .oindex "&%-Tqt%&"
4655 This is an option that is exclusively for use by the Exim testing suite. It is not
4656 recognized when Exim is run normally. It allows for the setting up of explicit
4657 &"queue times"& so that various warning/retry features can be tested.
4658
4659 .vitem &%-t%&
4660 .oindex "&%-t%&"
4661 .cindex "recipient" "extracting from header lines"
4662 .cindex "&'Bcc:'& header line"
4663 .cindex "&'Cc:'& header line"
4664 .cindex "&'To:'& header line"
4665 When Exim is receiving a locally-generated, non-SMTP message on its standard
4666 input, the &%-t%& option causes the recipients of the message to be obtained
4667 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4668 from the command arguments. The addresses are extracted before any rewriting
4669 takes place and the &'Bcc:'& header line, if present, is then removed.
4670
4671 .cindex "Sendmail compatibility" "&%-t%& option"
4672 If the command has any arguments, they specify addresses to which the message
4673 is &'not'& to be delivered. That is, the argument addresses are removed from
4674 the recipients list obtained from the headers. This is compatible with Smail 3
4675 and in accordance with the documented behaviour of several versions of
4676 Sendmail, as described in man pages on a number of operating systems (e.g.
4677 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4678 argument addresses to those obtained from the headers, and the O'Reilly
4679 Sendmail book documents it that way. Exim can be made to add argument addresses
4680 instead of subtracting them by setting the option
4681 &%extract_addresses_remove_arguments%& false.
4682
4683 .cindex "&%Resent-%& header lines" "with &%-t%&"
4684 If there are any &%Resent-%& header lines in the message, Exim extracts
4685 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4686 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4687 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4688 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4689
4690 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4691 message is resent several times). The RFC also specifies that they should be
4692 added at the front of the message, and separated by &'Received:'& lines. It is
4693 not at all clear how &%-t%& should operate in the present of multiple sets,
4694 nor indeed exactly what constitutes a &"set"&.
4695 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4696 are often added at the end of the header, and if a message is resent more than
4697 once, it is common for the original set of &%Resent-%& headers to be renamed as
4698 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4699
4700 .vitem &%-ti%&
4701 .oindex "&%-ti%&"
4702 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4703 compatibility with Sendmail.
4704
4705 .vitem &%-tls-on-connect%&
4706 .oindex "&%-tls-on-connect%&"
4707 .cindex "TLS" "use without STARTTLS"
4708 .cindex "TLS" "automatic start"
4709 This option is available when Exim is compiled with TLS support. It forces all
4710 incoming SMTP connections to behave as if the incoming port is listed in the
4711 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4712 &<<CHAPTLS>>& for further details.
4713
4714
4715 .vitem &%-U%&
4716 .oindex "&%-U%&"
4717 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4718 Sendmail uses this option for &"initial message submission"&, and its
4719 documentation states that in future releases, it may complain about
4720 syntactically invalid messages rather than fixing them when this flag is not
4721 set. Exim ignores this option.
4722
4723 .vitem &%-v%&
4724 .oindex "&%-v%&"
4725 This option causes Exim to write information to the standard error stream,
4726 describing what it is doing. In particular, it shows the log lines for
4727 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4728 dialogue is shown. Some of the log lines shown may not actually be written to
4729 the log if the setting of &%log_selector%& discards them. Any relevant
4730 selectors are shown with each log line. If none are shown, the logging is
4731 unconditional.
4732
4733 .vitem &%-x%&
4734 .oindex "&%-x%&"
4735 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4736 National Language Support extended characters in the body of the mail item"&).
4737 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4738 this option.
4739
4740 .vitem &%-X%&&~<&'logfile'&>
4741 .oindex "&%-X%&"
4742 This option is interpreted by Sendmail to cause debug information to be sent
4743 to the named file.  It is ignored by Exim.
4744
4745 .vitem &%-z%&&~<&'log-line'&>
4746 .oindex "&%-z%&"
4747 This option writes its argument to Exim's logfile.
4748 Use is restricted to administrators; the intent is for operational notes.
4749 Quotes should be used to maintain a multi-word item as a single argument,
4750 under most shells.
4751 .endlist
4752
4753 .ecindex IIDclo1
4754 .ecindex IIDclo2
4755
4756
4757 . ////////////////////////////////////////////////////////////////////////////
4758 . Insert a stylized DocBook comment here, to identify the end of the command
4759 . line options. This is for the benefit of the Perl script that automatically
4760 . creates a man page for the options.
4761 . ////////////////////////////////////////////////////////////////////////////
4762
4763 .literal xml
4764 <!-- === End of command line options === -->
4765 .literal off
4766
4767
4768
4769
4770
4771 . ////////////////////////////////////////////////////////////////////////////
4772 . ////////////////////////////////////////////////////////////////////////////
4773
4774
4775 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4776          "The runtime configuration file"
4777
4778 .cindex "runtime configuration"
4779 .cindex "configuration file" "general description"
4780 .cindex "CONFIGURE_FILE"
4781 .cindex "configuration file" "errors in"
4782 .cindex "error" "in configuration file"
4783 .cindex "return code" "for bad configuration"
4784 Exim uses a single runtime configuration file that is read whenever an Exim
4785 binary is executed. Note that in normal operation, this happens frequently,
4786 because Exim is designed to operate in a distributed manner, without central
4787 control.
4788
4789 If a syntax error is detected while reading the configuration file, Exim
4790 writes a message on the standard error, and exits with a non-zero return code.
4791 The message is also written to the panic log. &*Note*&: Only simple syntax
4792 errors can be detected at this time. The values of any expanded options are
4793 not checked until the expansion happens, even when the expansion does not
4794 actually alter the string.
4795
4796 The name of the configuration file is compiled into the binary for security
4797 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4798 most configurations, this specifies a single file. However, it is permitted to
4799 give a colon-separated list of filenames, in which case Exim uses the first
4800 existing file in the list.
4801
4802 .cindex "EXIM_USER"
4803 .cindex "EXIM_GROUP"
4804 .cindex "CONFIGURE_OWNER"
4805 .cindex "CONFIGURE_GROUP"
4806 .cindex "configuration file" "ownership"
4807 .cindex "ownership" "configuration file"
4808 The runtime configuration file must be owned by root or by the user that is
4809 specified at compile time by the CONFIGURE_OWNER option (if set). The
4810 configuration file must not be world-writeable, or group-writeable unless its
4811 group is the root group or the one specified at compile time by the
4812 CONFIGURE_GROUP option.
4813
4814 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4815 to root, anybody who is able to edit the runtime configuration file has an
4816 easy way to run commands as root. If you specify a user or group in the
4817 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4818 who are members of that group will trivially be able to obtain root privileges.
4819
4820 Up to Exim version 4.72, the runtime configuration file was also permitted to
4821 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4822 since it offered a simple privilege escalation for any attacker who managed to
4823 compromise the Exim user account.
4824
4825 A default configuration file, which will work correctly in simple situations,
4826 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4827 defines just one filename, the installation process copies the default
4828 configuration to a new file of that name if it did not previously exist. If
4829 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4830 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4831 configuration.
4832
4833
4834
4835 .section "Using a different configuration file" "SECID40"
4836 .cindex "configuration file" "alternate"
4837 A one-off alternate configuration can be specified by the &%-C%& command line
4838 option, which may specify a single file or a list of files. However, when
4839 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4840 unless the argument for &%-C%& is identical to the built-in value from
4841 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4842 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4843 is useful mainly for checking the syntax of configuration files before
4844 installing them. No owner or group checks are done on a configuration file
4845 specified by &%-C%&, if root privilege has been dropped.
4846
4847 Even the Exim user is not trusted to specify an arbitrary configuration file
4848 with the &%-C%& option to be used with root privileges, unless that file is
4849 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4850 testing a configuration using &%-C%& right through message reception and
4851 delivery, even if the caller is root. The reception works, but by that time,
4852 Exim is running as the Exim user, so when it re-execs to regain privilege for
4853 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4854 can test reception and delivery using two separate commands (one to put a
4855 message in the queue, using &%-odq%&, and another to do the delivery, using
4856 &%-M%&).
4857
4858 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4859 prefix string with which any file named in a &%-C%& command line option must
4860 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4861 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4862 filename can be used with &%-C%&.
4863
4864 One-off changes to a configuration can be specified by the &%-D%& command line
4865 option, which defines and overrides values for macros used inside the
4866 configuration file. However, like &%-C%&, the use of this option by a
4867 non-privileged user causes Exim to discard its root privilege.
4868 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4869 completely disabled, and its use causes an immediate error exit.
4870
4871 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4872 to declare certain macro names trusted, such that root privilege will not
4873 necessarily be discarded.
4874 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4875 considered safe and, if &%-D%& only supplies macros from this list, and the
4876 values are acceptable, then Exim will not give up root privilege if the caller
4877 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4878 transition mechanism and is expected to be removed in the future.  Acceptable
4879 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4880
4881 Some sites may wish to use the same Exim binary on different machines that
4882 share a file system, but to use different configuration files on each machine.
4883 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4884 looks for a file whose name is the configuration filename followed by a dot
4885 and the machine's node name, as obtained from the &[uname()]& function. If this
4886 file does not exist, the standard name is tried. This processing occurs for
4887 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4888
4889 In some esoteric situations different versions of Exim may be run under
4890 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4891 help with this. See the comments in &_src/EDITME_& for details.
4892
4893
4894
4895 .section "Configuration file format" "SECTconffilfor"
4896 .cindex "configuration file" "format of"
4897 .cindex "format" "configuration file"
4898 Exim's configuration file is divided into a number of different parts. General
4899 option settings must always appear at the start of the file. The other parts
4900 are all optional, and may appear in any order. Each part other than the first
4901 is introduced by the word &"begin"& followed by at least one literal
4902 space, and the name of the part. The optional parts are:
4903
4904 .ilist
4905 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4906 &<<CHAPACL>>&).
4907 .next
4908 .cindex "AUTH" "configuration"
4909 &'authenticators'&: Configuration settings for the authenticator drivers. These
4910 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4911 .next
4912 &'routers'&: Configuration settings for the router drivers. Routers process
4913 addresses and determine how the message is to be delivered (see chapters
4914 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4915 .next
4916 &'transports'&: Configuration settings for the transport drivers. Transports
4917 define mechanisms for copying messages to destinations (see chapters
4918 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4919 .next
4920 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4921 If there is no retry section, or if it is empty (that is, no retry rules are
4922 defined), Exim will not retry deliveries. In this situation, temporary errors
4923 are treated the same as permanent errors. Retry rules are discussed in chapter
4924 &<<CHAPretry>>&.
4925 .next
4926 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4927 when new addresses are generated during delivery. Rewriting is discussed in
4928 chapter &<<CHAPrewrite>>&.
4929 .next
4930 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4931 want to use this feature, you must set
4932 .code
4933 LOCAL_SCAN_HAS_OPTIONS=yes
4934 .endd
4935 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4936 facility are given in chapter &<<CHAPlocalscan>>&.
4937 .endlist
4938
4939 .cindex "configuration file" "leading white space in"
4940 .cindex "configuration file" "trailing white space in"
4941 .cindex "white space" "in configuration file"
4942 Leading and trailing white space in configuration lines is always ignored.
4943
4944 Blank lines in the file, and lines starting with a # character (ignoring
4945 leading white space) are treated as comments and are ignored. &*Note*&: A
4946 # character other than at the beginning of a line is not treated specially,
4947 and does not introduce a comment.
4948
4949 Any non-comment line can be continued by ending it with a backslash. Note that
4950 the general rule for white space means that trailing white space after the
4951 backslash and leading white space at the start of continuation
4952 lines is ignored. Comment lines beginning with # (but not empty lines) may
4953 appear in the middle of a sequence of continuation lines.
4954
4955 A convenient way to create a configuration file is to start from the
4956 default, which is supplied in &_src/configure.default_&, and add, delete, or
4957 change settings as required.
4958
4959 The ACLs, retry rules, and rewriting rules have their own syntax which is
4960 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4961 respectively. The other parts of the configuration file have some syntactic
4962 items in common, and these are described below, from section &<<SECTcos>>&
4963 onwards. Before that, the inclusion, macro, and conditional facilities are
4964 described.
4965
4966
4967
4968 .section "File inclusions in the configuration file" "SECID41"
4969 .cindex "inclusions in configuration file"
4970 .cindex "configuration file" "including other files"
4971 .cindex "&`.include`& in configuration file"
4972 .cindex "&`.include_if_exists`& in configuration file"
4973 You can include other files inside Exim's runtime configuration file by
4974 using this syntax:
4975 .display
4976 &`.include`& <&'filename'&>
4977 &`.include_if_exists`& <&'filename'&>
4978 .endd
4979 on a line by itself. Double quotes round the filename are optional. If you use
4980 the first form, a configuration error occurs if the file does not exist; the
4981 second form does nothing for non-existent files.
4982 The first form allows a relative name. It is resolved relative to
4983 the directory of the including file. For the second form an absolute filename
4984 is required.
4985
4986 Includes may be nested to any depth, but remember that Exim reads its
4987 configuration file often, so it is a good idea to keep them to a minimum.
4988 If you change the contents of an included file, you must HUP the daemon,
4989 because an included file is read only when the configuration itself is read.
4990
4991 The processing of inclusions happens early, at a physical line level, so, like
4992 comment lines, an inclusion can be used in the middle of an option setting,
4993 for example:
4994 .code
4995 hosts_lookup = a.b.c \
4996                .include /some/file
4997 .endd
4998 Include processing happens after macro processing (see below). Its effect is to
4999 process the lines of the included file as if they occurred inline where the
5000 inclusion appears.
5001
5002
5003
5004 .section "Macros in the configuration file" "SECTmacrodefs"
5005 .cindex "macro" "description of"
5006 .cindex "configuration file" "macros"
5007 If a line in the main part of the configuration (that is, before the first
5008 &"begin"& line) begins with an upper case letter, it is taken as a macro
5009 definition, and must be of the form
5010 .display
5011 <&'name'&> = <&'rest of line'&>
5012 .endd
5013 The name must consist of letters, digits, and underscores, and need not all be
5014 in upper case, though that is recommended. The rest of the line, including any
5015 continuations, is the replacement text, and has leading and trailing white
5016 space removed. Quotes are not removed. The replacement text can never end with
5017 a backslash character, but this doesn't seem to be a serious limitation.
5018
5019 Macros may also be defined between router, transport, authenticator, or ACL
5020 definitions. They may not, however, be defined within an individual driver or
5021 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5022
5023 .section "Macro substitution" "SECID42"
5024 Once a macro is defined, all subsequent lines in the file (and any included
5025 files) are scanned for the macro name; if there are several macros, the line is
5026 scanned for each, in turn, in the order in which the macros are defined. The
5027 replacement text is not re-scanned for the current macro, though it is scanned
5028 for subsequently defined macros. For this reason, a macro name may not contain
5029 the name of a previously defined macro as a substring. You could, for example,
5030 define
5031 .display
5032 &`ABCD_XYZ = `&<&'something'&>
5033 &`ABCD = `&<&'something else'&>
5034 .endd
5035 but putting the definitions in the opposite order would provoke a configuration
5036 error. Macro expansion is applied to individual physical lines from the file,
5037 before checking for line continuation or file inclusion (see above). If a line
5038 consists solely of a macro name, and the expansion of the macro is empty, the
5039 line is ignored. A macro at the start of a line may turn the line into a
5040 comment line or a &`.include`& line.
5041
5042
5043 .section "Redefining macros" "SECID43"
5044 Once defined, the value of a macro can be redefined later in the configuration
5045 (or in an included file). Redefinition is specified by using &'=='& instead of
5046 &'='&. For example:
5047 .code
5048 MAC =  initial value
5049 ...
5050 MAC == updated value
5051 .endd
5052 Redefinition does not alter the order in which the macros are applied to the
5053 subsequent lines of the configuration file. It is still the same order in which
5054 the macros were originally defined. All that changes is the macro's value.
5055 Redefinition makes it possible to accumulate values. For example:
5056 .code
5057 MAC =  initial value
5058 ...
5059 MAC == MAC and something added
5060 .endd
5061 This can be helpful in situations where the configuration file is built
5062 from a number of other files.
5063
5064 .section "Overriding macro values" "SECID44"
5065 The values set for macros in the configuration file can be overridden by the
5066 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5067 used, unless called by root or the Exim user. A definition on the command line
5068 using the &%-D%& option causes all definitions and redefinitions within the
5069 file to be ignored.
5070
5071
5072
5073 .section "Example of macro usage" "SECID45"
5074 As an example of macro usage, consider a configuration where aliases are looked
5075 up in a MySQL database. It helps to keep the file less cluttered if long
5076 strings such as SQL statements are defined separately as macros, for example:
5077 .code
5078 ALIAS_QUERY = select mailbox from user where \
5079               login='${quote_mysql:$local_part}';
5080 .endd
5081 This can then be used in a &(redirect)& router setting like this:
5082 .code
5083 data = ${lookup mysql{ALIAS_QUERY}}
5084 .endd
5085 In earlier versions of Exim macros were sometimes used for domain, host, or
5086 address lists. In Exim 4 these are handled better by named lists &-- see
5087 section &<<SECTnamedlists>>&.
5088
5089
5090 .section "Builtin macros" "SECTbuiltinmacros"
5091 Exim defines some macros depending on facilities available, which may
5092 differ due to build-time definitions and from one release to another.
5093 All of these macros start with an underscore.
5094 They can be used to conditionally include parts of a configuration
5095 (see below).
5096
5097 The following classes of macros are defined:
5098 .display
5099 &` _HAVE_*                    `&  build-time defines
5100 &` _DRIVER_ROUTER_*           `&  router drivers
5101 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5102 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5103 &` _LOG_*                     `&  log_selector values
5104 &` _OPT_MAIN_*                `&  main config options
5105 &` _OPT_ROUTERS_*             `&  generic router options
5106 &` _OPT_TRANSPORTS_*          `&  generic transport options
5107 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5108 &` _OPT_ROUTER_*_*            `&  private router options
5109 &` _OPT_TRANSPORT_*_*         `&  private transport options
5110 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5111 .endd
5112
5113 Use an &"exim -bP macros"& command to get the list of macros.
5114
5115
5116 .section "Conditional skips in the configuration file" "SECID46"
5117 .cindex "configuration file" "conditional skips"
5118 .cindex "&`.ifdef`&"
5119 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5120 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5121 portions of the configuration file. The processing happens whenever the file is
5122 read (that is, when an Exim binary starts to run).
5123
5124 The implementation is very simple. Instances of the first four directives must
5125 be followed by text that includes the names of one or macros. The condition
5126 that is tested is whether or not any macro substitution has taken place in the
5127 line. Thus:
5128 .code
5129 .ifdef AAA
5130 message_size_limit = 50M
5131 .else
5132 message_size_limit = 100M
5133 .endif
5134 .endd
5135 sets a message size limit of 50M if the macro &`AAA`& is defined
5136 (or &`A`& or &`AA`&), and 100M
5137 otherwise. If there is more than one macro named on the line, the condition
5138 is true if any of them are defined. That is, it is an &"or"& condition. To
5139 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5140
5141 Although you can use a macro expansion to generate one of these directives,
5142 it is not very useful, because the condition &"there was a macro substitution
5143 in this line"& will always be true.
5144
5145 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5146 to clarify complicated nestings.
5147
5148
5149
5150 .section "Common option syntax" "SECTcos"
5151 .cindex "common option syntax"
5152 .cindex "syntax of common options"
5153 .cindex "configuration file" "common option syntax"
5154 For the main set of options, driver options, and &[local_scan()]& options,
5155 each setting is on a line by itself, and starts with a name consisting of
5156 lower-case letters and underscores. Many options require a data value, and in
5157 these cases the name must be followed by an equals sign (with optional white
5158 space) and then the value. For example:
5159 .code
5160 qualify_domain = mydomain.example.com
5161 .endd
5162 .cindex "hiding configuration option values"
5163 .cindex "configuration options" "hiding value of"
5164 .cindex "options" "hiding value of"
5165 Some option settings may contain sensitive data, for example, passwords for
5166 accessing databases. To stop non-admin users from using the &%-bP%& command
5167 line option to read these values, you can precede the option settings with the
5168 word &"hide"&. For example:
5169 .code
5170 hide mysql_servers = localhost/users/admin/secret-password
5171 .endd
5172 For non-admin users, such options are displayed like this:
5173 .code
5174 mysql_servers = <value not displayable>
5175 .endd
5176 If &"hide"& is used on a driver option, it hides the value of that option on
5177 all instances of the same driver.
5178
5179 The following sections describe the syntax used for the different data types
5180 that are found in option settings.
5181
5182
5183 .section "Boolean options" "SECID47"
5184 .cindex "format" "boolean"
5185 .cindex "boolean configuration values"
5186 .oindex "&%no_%&&'xxx'&"
5187 .oindex "&%not_%&&'xxx'&"
5188 Options whose type is given as boolean are on/off switches. There are two
5189 different ways of specifying such options: with and without a data value. If
5190 the option name is specified on its own without data, the switch is turned on;
5191 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5192 boolean options may be followed by an equals sign and one of the words
5193 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5194 the following two settings have exactly the same effect:
5195 .code
5196 queue_only
5197 queue_only = true
5198 .endd
5199 The following two lines also have the same (opposite) effect:
5200 .code
5201 no_queue_only
5202 queue_only = false
5203 .endd
5204 You can use whichever syntax you prefer.
5205
5206
5207
5208
5209 .section "Integer values" "SECID48"
5210 .cindex "integer configuration values"
5211 .cindex "format" "integer"
5212 If an option's type is given as &"integer"&, the value can be given in decimal,
5213 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5214 number is assumed. Otherwise, it is treated as an octal number unless it starts
5215 with the characters &"0x"&, in which case the remainder is interpreted as a
5216 hexadecimal number.
5217
5218 If an integer value is followed by the letter K, it is multiplied by 1024; if
5219 it is followed by the letter M, it is multiplied by 1024x1024;
5220 if by the letter G, 1024x1024x1024.
5221 When the values
5222 of integer option settings are output, values which are an exact multiple of
5223 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5224 and M. The printing style is independent of the actual input format that was
5225 used.
5226
5227
5228 .section "Octal integer values" "SECID49"
5229 .cindex "integer format"
5230 .cindex "format" "octal integer"
5231 If an option's type is given as &"octal integer"&, its value is always
5232 interpreted as an octal number, whether or not it starts with the digit zero.
5233 Such options are always output in octal.
5234
5235
5236 .section "Fixed point numbers" "SECID50"
5237 .cindex "fixed point configuration values"
5238 .cindex "format" "fixed point"
5239 If an option's type is given as &"fixed-point"&, its value must be a decimal
5240 integer, optionally followed by a decimal point and up to three further digits.
5241
5242
5243
5244 .section "Time intervals" "SECTtimeformat"
5245 .cindex "time interval" "specifying in configuration"
5246 .cindex "format" "time interval"
5247 A time interval is specified as a sequence of numbers, each followed by one of
5248 the following letters, with no intervening white space:
5249
5250 .table2 30pt
5251 .irow &%s%& seconds
5252 .irow &%m%& minutes
5253 .irow &%h%& hours
5254 .irow &%d%& days
5255 .irow &%w%& weeks
5256 .endtable
5257
5258 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5259 intervals are output in the same format. Exim does not restrict the values; it
5260 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5261
5262
5263
5264 .section "String values" "SECTstrings"
5265 .cindex "string" "format of configuration values"
5266 .cindex "format" "string"
5267 If an option's type is specified as &"string"&, the value can be specified with
5268 or without double-quotes. If it does not start with a double-quote, the value
5269 consists of the remainder of the line plus any continuation lines, starting at
5270 the first character after any leading white space, with trailing white space
5271 removed, and with no interpretation of the characters in the string. Because
5272 Exim removes comment lines (those beginning with #) at an early stage, they can
5273 appear in the middle of a multi-line string. The following two settings are
5274 therefore equivalent:
5275 .code
5276 trusted_users = uucp:mail
5277 trusted_users = uucp:\
5278                 # This comment line is ignored
5279                 mail
5280 .endd
5281 .cindex "string" "quoted"
5282 .cindex "escape characters in quoted strings"
5283 If a string does start with a double-quote, it must end with a closing
5284 double-quote, and any backslash characters other than those used for line
5285 continuation are interpreted as escape characters, as follows:
5286
5287 .table2 100pt
5288 .irow &`\\`&                     "single backslash"
5289 .irow &`\n`&                     "newline"
5290 .irow &`\r`&                     "carriage return"
5291 .irow &`\t`&                     "tab"
5292 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5293 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5294                                    character"
5295 .endtable
5296
5297 If a backslash is followed by some other character, including a double-quote
5298 character, that character replaces the pair.
5299
5300 Quoting is necessary only if you want to make use of the backslash escapes to
5301 insert special characters, or if you need to specify a value with leading or
5302 trailing spaces. These cases are rare, so quoting is almost never needed in
5303 current versions of Exim. In versions of Exim before 3.14, quoting was required
5304 in order to continue lines, so you may come across older configuration files
5305 and examples that apparently quote unnecessarily.
5306
5307
5308 .section "Expanded strings" "SECID51"
5309 .cindex "expansion" "definition of"
5310 Some strings in the configuration file are subjected to &'string expansion'&,
5311 by which means various parts of the string may be changed according to the
5312 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5313 is as just described; in particular, the handling of backslashes in quoted
5314 strings is done as part of the input process, before expansion takes place.
5315 However, backslash is also an escape character for the expander, so any
5316 backslashes that are required for that reason must be doubled if they are
5317 within a quoted configuration string.
5318
5319
5320 .section "User and group names" "SECID52"
5321 .cindex "user name" "format of"
5322 .cindex "format" "user name"
5323 .cindex "groups" "name format"
5324 .cindex "format" "group name"
5325 User and group names are specified as strings, using the syntax described
5326 above, but the strings are interpreted specially. A user or group name must
5327 either consist entirely of digits, or be a name that can be looked up using the
5328 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5329
5330
5331 .section "List construction" "SECTlistconstruct"
5332 .cindex "list" "syntax of in configuration"
5333 .cindex "format" "list item in configuration"
5334 .cindex "string" "list, definition of"
5335 The data for some configuration options is a list of items, with colon as the
5336 default separator. Many of these options are shown with type &"string list"& in
5337 the descriptions later in this document. Others are listed as &"domain list"&,
5338 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5339 are all the same; however, those other than &"string list"& are subject to
5340 particular kinds of interpretation, as described in chapter
5341 &<<CHAPdomhosaddlists>>&.
5342
5343 In all these cases, the entire list is treated as a single string as far as the
5344 input syntax is concerned. The &%trusted_users%& setting in section
5345 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5346 in a list, it must be entered as two colons. Leading and trailing white space
5347 on each item in a list is ignored. This makes it possible to include items that
5348 start with a colon, and in particular, certain forms of IPv6 address. For
5349 example, the list
5350 .code
5351 local_interfaces = 127.0.0.1 : ::::1
5352 .endd
5353 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5354
5355 &*Note*&: Although leading and trailing white space is ignored in individual
5356 list items, it is not ignored when parsing the list. The space after the first
5357 colon in the example above is necessary. If it were not there, the list would
5358 be interpreted as the two items 127.0.0.1:: and 1.
5359
5360 .section "Changing list separators" "SECTlistsepchange"
5361 .cindex "list separator" "changing"
5362 .cindex "IPv6" "addresses in lists"
5363 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5364 introduced to allow the separator character to be changed. If a list begins
5365 with a left angle bracket, followed by any punctuation character, that
5366 character is used instead of colon as the list separator. For example, the list
5367 above can be rewritten to use a semicolon separator like this:
5368 .code
5369 local_interfaces = <; 127.0.0.1 ; ::1
5370 .endd
5371 This facility applies to all lists, with the exception of the list in
5372 &%log_file_path%&. It is recommended that the use of non-colon separators be
5373 confined to circumstances where they really are needed.
5374
5375 .cindex "list separator" "newline as"
5376 .cindex "newline" "as list separator"
5377 It is also possible to use newline and other control characters (those with
5378 code values less than 32, plus DEL) as separators in lists. Such separators
5379 must be provided literally at the time the list is processed. For options that
5380 are string-expanded, you can write the separator using a normal escape
5381 sequence. This will be processed by the expander before the string is
5382 interpreted as a list. For example, if a newline-separated list of domains is
5383 generated by a lookup, you can process it directly by a line such as this:
5384 .code
5385 domains = <\n ${lookup mysql{.....}}
5386 .endd
5387 This avoids having to change the list separator in such data. You are unlikely
5388 to want to use a control character as a separator in an option that is not
5389 expanded, because the value is literal text. However, it can be done by giving
5390 the value in quotes. For example:
5391 .code
5392 local_interfaces = "<\n 127.0.0.1 \n ::1"
5393 .endd
5394 Unlike printing character separators, which can be included in list items by
5395 doubling, it is not possible to include a control character as data when it is
5396 set as the separator. Two such characters in succession are interpreted as
5397 enclosing an empty list item.
5398
5399
5400
5401 .section "Empty items in lists" "SECTempitelis"
5402 .cindex "list" "empty item in"
5403 An empty item at the end of a list is always ignored. In other words, trailing
5404 separator characters are ignored. Thus, the list in
5405 .code
5406 senders = user@domain :
5407 .endd
5408 contains only a single item. If you want to include an empty string as one item
5409 in a list, it must not be the last item. For example, this list contains three
5410 items, the second of which is empty:
5411 .code
5412 senders = user1@domain : : user2@domain
5413 .endd
5414 &*Note*&: There must be white space between the two colons, as otherwise they
5415 are interpreted as representing a single colon data character (and the list
5416 would then contain just one item). If you want to specify a list that contains
5417 just one, empty item, you can do it as in this example:
5418 .code
5419 senders = :
5420 .endd
5421 In this case, the first item is empty, and the second is discarded because it
5422 is at the end of the list.
5423
5424
5425
5426
5427 .section "Format of driver configurations" "SECTfordricon"
5428 .cindex "drivers" "configuration format"
5429 There are separate parts in the configuration for defining routers, transports,
5430 and authenticators. In each part, you are defining a number of driver
5431 instances, each with its own set of options. Each driver instance is defined by
5432 a sequence of lines like this:
5433 .display
5434 <&'instance name'&>:
5435   <&'option'&>
5436   ...
5437   <&'option'&>
5438 .endd
5439 In the following example, the instance name is &(localuser)&, and it is
5440 followed by three options settings:
5441 .code
5442 localuser:
5443   driver = accept
5444   check_local_user
5445   transport = local_delivery
5446 .endd
5447 For each driver instance, you specify which Exim code module it uses &-- by the
5448 setting of the &%driver%& option &-- and (optionally) some configuration
5449 settings. For example, in the case of transports, if you want a transport to
5450 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5451 a local file you would use the &(appendfile)& driver. Each of the drivers is
5452 described in detail in its own separate chapter later in this manual.
5453
5454 You can have several routers, transports, or authenticators that are based on
5455 the same underlying driver (each must have a different instance name).
5456
5457 The order in which routers are defined is important, because addresses are
5458 passed to individual routers one by one, in order. The order in which
5459 transports are defined does not matter at all. The order in which
5460 authenticators are defined is used only when Exim, as a client, is searching
5461 them to find one that matches an authentication mechanism offered by the
5462 server.
5463
5464 .cindex "generic options"
5465 .cindex "options" "generic &-- definition of"
5466 Within a driver instance definition, there are two kinds of option: &'generic'&
5467 and &'private'&. The generic options are those that apply to all drivers of the
5468 same type (that is, all routers, all transports or all authenticators). The
5469 &%driver%& option is a generic option that must appear in every definition.
5470 .cindex "private options"
5471 The private options are special for each driver, and none need appear, because
5472 they all have default values.
5473
5474 The options may appear in any order, except that the &%driver%& option must
5475 precede any private options, since these depend on the particular driver. For
5476 this reason, it is recommended that &%driver%& always be the first option.
5477
5478 Driver instance names, which are used for reference in log entries and
5479 elsewhere, can be any sequence of letters, digits, and underscores (starting
5480 with a letter) and must be unique among drivers of the same type. A router and
5481 a transport (for example) can each have the same name, but no two router
5482 instances can have the same name. The name of a driver instance should not be
5483 confused with the name of the underlying driver module. For example, the
5484 configuration lines:
5485 .code
5486 remote_smtp:
5487   driver = smtp
5488 .endd
5489 create an instance of the &(smtp)& transport driver whose name is
5490 &(remote_smtp)&. The same driver code can be used more than once, with
5491 different instance names and different option settings each time. A second
5492 instance of the &(smtp)& transport, with different options, might be defined
5493 thus:
5494 .code
5495 special_smtp:
5496   driver = smtp
5497   port = 1234
5498   command_timeout = 10s
5499 .endd
5500 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5501 these transport instances from routers, and these names would appear in log
5502 lines.
5503
5504 Comment lines may be present in the middle of driver specifications. The full
5505 list of option settings for any particular driver instance, including all the
5506 defaulted values, can be extracted by making use of the &%-bP%& command line
5507 option.
5508
5509
5510
5511
5512
5513
5514 . ////////////////////////////////////////////////////////////////////////////
5515 . ////////////////////////////////////////////////////////////////////////////
5516
5517 .chapter "The default configuration file" "CHAPdefconfil"
5518 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5519 .cindex "default" "configuration file &""walk through""&"
5520 The default configuration file supplied with Exim as &_src/configure.default_&
5521 is sufficient for a host with simple mail requirements. As an introduction to
5522 the way Exim is configured, this chapter &"walks through"& the default
5523 configuration, giving brief explanations of the settings. Detailed descriptions
5524 of the options are given in subsequent chapters. The default configuration file
5525 itself contains extensive comments about ways you might want to modify the
5526 initial settings. However, note that there are many options that are not
5527 mentioned at all in the default configuration.
5528
5529
5530
5531 .section "Macros" "SECTdefconfmacros"
5532 All macros should be defined before any options.
5533
5534 One macro is specified, but commented out, in the default configuration:
5535 .code
5536 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5537 .endd
5538 If all off-site mail is expected to be delivered to a "smarthost", then set the
5539 hostname here and uncomment the macro.  This will affect which router is used
5540 later on.  If this is left commented out, then Exim will perform direct-to-MX
5541 deliveries using a &(dnslookup)& router.
5542
5543 In addition to macros defined here, Exim includes a number of built-in macros
5544 to enable configuration to be guarded by a binary built with support for a
5545 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5546
5547
5548 .section "Main configuration settings" "SECTdefconfmain"
5549 The main (global) configuration option settings section must always come first
5550 in the file, after the macros.
5551 The first thing you'll see in the file, after some initial comments, is the line
5552 .code
5553 # primary_hostname =
5554 .endd
5555 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5556 to know the official, fully qualified name of your host, and this is where you
5557 can specify it. However, in most cases you do not need to set this option. When
5558 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5559
5560 The first three non-comment configuration lines are as follows:
5561 .code
5562 domainlist local_domains    = @
5563 domainlist relay_to_domains =
5564 hostlist   relay_from_hosts = 127.0.0.1
5565 .endd
5566 These are not, in fact, option settings. They are definitions of two named
5567 domain lists and one named host list. Exim allows you to give names to lists of
5568 domains, hosts, and email addresses, in order to make it easier to manage the
5569 configuration file (see section &<<SECTnamedlists>>&).
5570
5571 The first line defines a domain list called &'local_domains'&; this is used
5572 later in the configuration to identify domains that are to be delivered
5573 on the local host.
5574
5575 .cindex "@ in a domain list"
5576 There is just one item in this list, the string &"@"&. This is a special form
5577 of entry which means &"the name of the local host"&. Thus, if the local host is
5578 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5579 be delivered locally. Because the local host's name is referenced indirectly,
5580 the same configuration file can be used on different hosts.
5581
5582 The second line defines a domain list called &'relay_to_domains'&, but the
5583 list itself is empty. Later in the configuration we will come to the part that
5584 controls mail relaying through the local host; it allows relaying to any
5585 domains in this list. By default, therefore, no relaying on the basis of a mail
5586 domain is permitted.
5587
5588 The third line defines a host list called &'relay_from_hosts'&. This list is
5589 used later in the configuration to permit relaying from any host or IP address
5590 that matches the list. The default contains just the IP address of the IPv4
5591 loopback interface, which means that processes on the local host are able to
5592 submit mail for relaying by sending it over TCP/IP to that interface. No other
5593 hosts are permitted to submit messages for relaying.
5594
5595 Just to be sure there's no misunderstanding: at this point in the configuration
5596 we aren't actually setting up any controls. We are just defining some domains
5597 and hosts that will be used in the controls that are specified later.
5598
5599 The next two configuration lines are genuine option settings:
5600 .code
5601 acl_smtp_rcpt = acl_check_rcpt
5602 acl_smtp_data = acl_check_data
5603 .endd
5604 These options specify &'Access Control Lists'& (ACLs) that are to be used
5605 during an incoming SMTP session for every recipient of a message (every RCPT
5606 command), and after the contents of the message have been received,
5607 respectively. The names of the lists are &'acl_check_rcpt'& and
5608 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5609 section of the configuration. The RCPT ACL controls which recipients are
5610 accepted for an incoming message &-- if a configuration does not provide an ACL
5611 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5612 contents of a message to be checked.
5613
5614 Two commented-out option settings are next:
5615 .code
5616 # av_scanner = clamd:/tmp/clamd
5617 # spamd_address = 127.0.0.1 783
5618 .endd
5619 These are example settings that can be used when Exim is compiled with the
5620 content-scanning extension. The first specifies the interface to the virus
5621 scanner, and the second specifies the interface to SpamAssassin. Further
5622 details are given in chapter &<<CHAPexiscan>>&.
5623
5624 Three more commented-out option settings follow:
5625 .code
5626 # tls_advertise_hosts = *
5627 # tls_certificate = /etc/ssl/exim.crt
5628 # tls_privatekey = /etc/ssl/exim.pem
5629 .endd
5630 These are example settings that can be used when Exim is compiled with
5631 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5632 first one specifies the list of clients that are allowed to use TLS when
5633 connecting to this server; in this case, the wildcard means all clients. The
5634 other options specify where Exim should find its TLS certificate and private
5635 key, which together prove the server's identity to any clients that connect.
5636 More details are given in chapter &<<CHAPTLS>>&.
5637
5638 Another two commented-out option settings follow:
5639 .code
5640 # daemon_smtp_ports = 25 : 465 : 587
5641 # tls_on_connect_ports = 465
5642 .endd
5643 .cindex "port" "465 and 587"
5644 .cindex "port" "for message submission"
5645 .cindex "message" "submission, ports for"
5646 .cindex "submissions protocol"
5647 .cindex "smtps protocol"
5648 .cindex "ssmtp protocol"
5649 .cindex "SMTP" "submissions protocol"
5650 .cindex "SMTP" "ssmtp protocol"
5651 .cindex "SMTP" "smtps protocol"
5652 These options provide better support for roaming users who wish to use this
5653 server for message submission. They are not much use unless you have turned on
5654 TLS (as described in the previous paragraph) and authentication (about which
5655 more in section &<<SECTdefconfauth>>&).
5656 Mail submission from mail clients (MUAs) should be separate from inbound mail
5657 to your domain (MX delivery) for various good reasons (eg, ability to impose
5658 much saner TLS protocol and ciphersuite requirements without unintended
5659 consequences).
5660 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5661 which uses STARTTLS, so this is the &"submission"& port.
5662 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5663 which should be used in preference to 587.
5664 You should also consider deploying SRV records to help clients find
5665 these ports.
5666 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5667
5668 Two more commented-out options settings follow:
5669 .code
5670 # qualify_domain =
5671 # qualify_recipient =
5672 .endd
5673 The first of these specifies a domain that Exim uses when it constructs a
5674 complete email address from a local login name. This is often needed when Exim
5675 receives a message from a local process. If you do not set &%qualify_domain%&,
5676 the value of &%primary_hostname%& is used. If you set both of these options,
5677 you can have different qualification domains for sender and recipient
5678 addresses. If you set only the first one, its value is used in both cases.
5679
5680 .cindex "domain literal" "recognizing format"
5681 The following line must be uncommented if you want Exim to recognize
5682 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5683 (an IP address within square brackets) instead of a named domain.
5684 .code
5685 # allow_domain_literals
5686 .endd
5687 The RFCs still require this form, but many people think that in the modern
5688 Internet it makes little sense to permit mail to be sent to specific hosts by
5689 quoting their IP addresses. This ancient format has been used by people who
5690 try to abuse hosts by using them for unwanted relaying. However, some
5691 people believe there are circumstances (for example, messages addressed to
5692 &'postmaster'&) where domain literals are still useful.
5693
5694 The next configuration line is a kind of trigger guard:
5695 .code
5696 never_users = root
5697 .endd
5698 It specifies that no delivery must ever be run as the root user. The normal
5699 convention is to set up &'root'& as an alias for the system administrator. This
5700 setting is a guard against slips in the configuration.
5701 The list of users specified by &%never_users%& is not, however, the complete
5702 list; the build-time configuration in &_Local/Makefile_& has an option called
5703 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5704 contents of &%never_users%& are added to this list. By default
5705 FIXED_NEVER_USERS also specifies root.
5706
5707 When a remote host connects to Exim in order to send mail, the only information
5708 Exim has about the host's identity is its IP address. The next configuration
5709 line,
5710 .code
5711 host_lookup = *
5712 .endd
5713 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5714 in order to get a host name. This improves the quality of the logging
5715 information, but if you feel it is too expensive, you can remove it entirely,
5716 or restrict the lookup to hosts on &"nearby"& networks.
5717 Note that it is not always possible to find a host name from an IP address,
5718 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5719 unreachable.
5720
5721 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5722 1413 (hence their names):
5723 .code
5724 rfc1413_hosts = *
5725 rfc1413_query_timeout = 0s
5726 .endd
5727 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5728 Few hosts offer RFC1413 service these days; calls have to be
5729 terminated by a timeout and this needlessly delays the startup
5730 of an incoming SMTP connection.
5731 If you have hosts for which you trust RFC1413 and need this
5732 information, you can change this.
5733
5734 This line enables an efficiency SMTP option.  It is negotiated by clients
5735 and not expected to cause problems but can be disabled if needed.
5736 .code
5737 prdr_enable = true
5738 .endd
5739
5740 When Exim receives messages over SMTP connections, it expects all addresses to
5741 be fully qualified with a domain, as required by the SMTP definition. However,
5742 if you are running a server to which simple clients submit messages, you may
5743 find that they send unqualified addresses. The two commented-out options:
5744 .code
5745 # sender_unqualified_hosts =
5746 # recipient_unqualified_hosts =
5747 .endd
5748 show how you can specify hosts that are permitted to send unqualified sender
5749 and recipient addresses, respectively.
5750
5751 The &%log_selector%& option is used to increase the detail of logging
5752 over the default:
5753 .code
5754 log_selector = +smtp_protocol_error +smtp_syntax_error \
5755                +tls_certificate_verified
5756 .endd
5757
5758 The &%percent_hack_domains%& option is also commented out:
5759 .code
5760 # percent_hack_domains =
5761 .endd
5762 It provides a list of domains for which the &"percent hack"& is to operate.
5763 This is an almost obsolete form of explicit email routing. If you do not know
5764 anything about it, you can safely ignore this topic.
5765
5766 The next two settings in the main part of the default configuration are
5767 concerned with messages that have been &"frozen"& on Exim's queue. When a
5768 message is frozen, Exim no longer continues to try to deliver it. Freezing
5769 occurs when a bounce message encounters a permanent failure because the sender
5770 address of the original message that caused the bounce is invalid, so the
5771 bounce cannot be delivered. This is probably the most common case, but there
5772 are also other conditions that cause freezing, and frozen messages are not
5773 always bounce messages.
5774 .code
5775 ignore_bounce_errors_after = 2d
5776 timeout_frozen_after = 7d
5777 .endd
5778 The first of these options specifies that failing bounce messages are to be
5779 discarded after 2 days in the queue. The second specifies that any frozen
5780 message (whether a bounce message or not) is to be timed out (and discarded)
5781 after a week. In this configuration, the first setting ensures that no failing
5782 bounce message ever lasts a week.
5783
5784 Exim queues it's messages in a spool directory. If you expect to have
5785 large queues, you may consider using this option. It splits the spool
5786 directory into subdirectories to avoid file system degradation from
5787 many files in a single directory, resulting in better performance.
5788 Manual manipulation of queued messages becomes more complex (though fortunately
5789 not often needed).
5790 .code
5791 # split_spool_directory = true
5792 .endd
5793
5794 In an ideal world everybody follows the standards. For non-ASCII
5795 messages RFC 2047 is a standard, allowing a maximum line length of 76
5796 characters. Exim adheres that standard and won't process messages which
5797 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5798 In particular, the Exim maintainers have had multiple reports of
5799 problems from Russian administrators of issues until they disable this
5800 check, because of some popular, yet buggy, mail composition software.
5801 .code
5802 # check_rfc2047_length = false
5803 .endd
5804
5805 If you need to be strictly RFC compliant you may wish to disable the
5806 8BITMIME advertisement. Use this, if you exchange mails with systems
5807 that are not 8-bit clean.
5808 .code
5809 # accept_8bitmime = false
5810 .endd
5811
5812 Libraries you use may depend on specific environment settings.  This
5813 imposes a security risk (e.g. PATH). There are two lists:
5814 &%keep_environment%& for the variables to import as they are, and
5815 &%add_environment%& for variables we want to set to a fixed value.
5816 Note that TZ is handled separately, by the $%timezone%$ runtime
5817 option and by the TIMEZONE_DEFAULT buildtime option.
5818 .code
5819 # keep_environment = ^LDAP
5820 # add_environment = PATH=/usr/bin::/bin
5821 .endd
5822
5823
5824 .section "ACL configuration" "SECID54"
5825 .cindex "default" "ACLs"
5826 .cindex "&ACL;" "default configuration"
5827 In the default configuration, the ACL section follows the main configuration.
5828 It starts with the line
5829 .code
5830 begin acl
5831 .endd
5832 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5833 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5834 and &%acl_smtp_data%& above.
5835
5836 .cindex "RCPT" "ACL for"
5837 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5838 RCPT command specifies one of the message's recipients. The ACL statements
5839 are considered in order, until the recipient address is either accepted or
5840 rejected. The RCPT command is then accepted or rejected, according to the
5841 result of the ACL processing.
5842 .code
5843 acl_check_rcpt:
5844 .endd
5845 This line, consisting of a name terminated by a colon, marks the start of the
5846 ACL, and names it.
5847 .code
5848 accept  hosts = :
5849 .endd
5850 This ACL statement accepts the recipient if the sending host matches the list.
5851 But what does that strange list mean? It doesn't actually contain any host
5852 names or IP addresses. The presence of the colon puts an empty item in the
5853 list; Exim matches this only if the incoming message did not come from a remote
5854 host, because in that case, the remote hostname is empty. The colon is
5855 important. Without it, the list itself is empty, and can never match anything.
5856
5857 What this statement is doing is to accept unconditionally all recipients in
5858 messages that are submitted by SMTP from local processes using the standard
5859 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5860 manner.
5861 .code
5862 deny    message       = Restricted characters in address
5863         domains       = +local_domains
5864         local_parts   = ^[.] : ^.*[@%!/|]
5865
5866 deny    message       = Restricted characters in address
5867         domains       = !+local_domains
5868         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5869 .endd
5870 These statements are concerned with local parts that contain any of the
5871 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5872 Although these characters are entirely legal in local parts (in the case of
5873 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5874 in Internet mail addresses.
5875
5876 The first three have in the past been associated with explicitly routed
5877 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5878 option). Addresses containing these characters are regularly tried by spammers
5879 in an attempt to bypass relaying restrictions, and also by open relay testing
5880 programs. Unless you really need them it is safest to reject these characters
5881 at this early stage. This configuration is heavy-handed in rejecting these
5882 characters for all messages it accepts from remote hosts. This is a deliberate
5883 policy of being as safe as possible.
5884
5885 The first rule above is stricter, and is applied to messages that are addressed
5886 to one of the local domains handled by this host. This is implemented by the
5887 first condition, which restricts it to domains that are listed in the
5888 &'local_domains'& domain list. The &"+"& character is used to indicate a
5889 reference to a named list. In this configuration, there is just one domain in
5890 &'local_domains'&, but in general there may be many.
5891
5892 The second condition on the first statement uses two regular expressions to
5893 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5894 or &"|"&. If you have local accounts that include these characters, you will
5895 have to modify this rule.
5896
5897 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5898 allows them because they have been encountered in practice. (Consider the
5899 common convention of local parts constructed as
5900 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5901 the author of Exim, who has no second initial.) However, a local part starting
5902 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5903 filename (for example, for a mailing list). This is also true for local parts
5904 that contain slashes. A pipe symbol can also be troublesome if the local part
5905 is incorporated unthinkingly into a shell command line.
5906
5907 The second rule above applies to all other domains, and is less strict. This
5908 allows your own users to send outgoing messages to sites that use slashes
5909 and vertical bars in their local parts. It blocks local parts that begin
5910 with a dot, slash, or vertical bar, but allows these characters within the
5911 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5912 and &"!"& is blocked, as before. The motivation here is to prevent your users
5913 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5914 .code
5915 accept  local_parts   = postmaster
5916         domains       = +local_domains
5917 .endd
5918 This statement, which has two conditions, accepts an incoming address if the
5919 local part is &'postmaster'& and the domain is one of those listed in the
5920 &'local_domains'& domain list. The &"+"& character is used to indicate a
5921 reference to a named list. In this configuration, there is just one domain in
5922 &'local_domains'&, but in general there may be many.
5923
5924 The presence of this statement means that mail to postmaster is never blocked
5925 by any of the subsequent tests. This can be helpful while sorting out problems
5926 in cases where the subsequent tests are incorrectly denying access.
5927 .code
5928 require verify        = sender
5929 .endd
5930 This statement requires the sender address to be verified before any subsequent
5931 ACL statement can be used. If verification fails, the incoming recipient
5932 address is refused. Verification consists of trying to route the address, to
5933 see if a bounce message could be delivered to it. In the case of remote
5934 addresses, basic verification checks only the domain, but &'callouts'& can be
5935 used for more verification if required. Section &<<SECTaddressverification>>&
5936 discusses the details of address verification.
5937 .code
5938 accept  hosts         = +relay_from_hosts
5939         control       = submission
5940 .endd
5941 This statement accepts the address if the message is coming from one of the
5942 hosts that are defined as being allowed to relay through this host. Recipient
5943 verification is omitted here, because in many cases the clients are dumb MUAs
5944 that do not cope well with SMTP error responses. For the same reason, the
5945 second line specifies &"submission mode"& for messages that are accepted. This
5946 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5947 messages that are deficient in some way, for example, because they lack a
5948 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5949 probably add recipient verification here, and disable submission mode.
5950 .code
5951 accept  authenticated = *
5952         control       = submission
5953 .endd
5954 This statement accepts the address if the client host has authenticated itself.
5955 Submission mode is again specified, on the grounds that such messages are most
5956 likely to come from MUAs. The default configuration does not define any
5957 authenticators, though it does include some nearly complete commented-out
5958 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5959 fact authenticate until you complete the authenticator definitions.
5960 .code
5961 require message = relay not permitted
5962         domains = +local_domains : +relay_to_domains
5963 .endd
5964 This statement rejects the address if its domain is neither a local domain nor
5965 one of the domains for which this host is a relay.
5966 .code
5967 require verify = recipient
5968 .endd
5969 This statement requires the recipient address to be verified; if verification
5970 fails, the address is rejected.
5971 .code
5972 # deny    message     = rejected because $sender_host_address \
5973 #                       is in a black list at $dnslist_domain\n\
5974 #                       $dnslist_text
5975 #         dnslists    = black.list.example
5976 #
5977 # warn    dnslists    = black.list.example
5978 #         add_header  = X-Warning: $sender_host_address is in \
5979 #                       a black list at $dnslist_domain
5980 #         log_message = found in $dnslist_domain
5981 .endd
5982 These commented-out lines are examples of how you could configure Exim to check
5983 sending hosts against a DNS black list. The first statement rejects messages
5984 from blacklisted hosts, whereas the second just inserts a warning header
5985 line.
5986 .code
5987 # require verify = csa
5988 .endd
5989 This commented-out line is an example of how you could turn on client SMTP
5990 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5991 records.
5992 .code
5993 accept
5994 .endd
5995 The final statement in the first ACL unconditionally accepts any recipient
5996 address that has successfully passed all the previous tests.
5997 .code
5998 acl_check_data:
5999 .endd
6000 This line marks the start of the second ACL, and names it. Most of the contents
6001 of this ACL are commented out:
6002 .code
6003 # deny    malware   = *
6004 #         message   = This message contains a virus \
6005 #                     ($malware_name).
6006 .endd
6007 These lines are examples of how to arrange for messages to be scanned for
6008 viruses when Exim has been compiled with the content-scanning extension, and a
6009 suitable virus scanner is installed. If the message is found to contain a
6010 virus, it is rejected with the given custom error message.
6011 .code
6012 # warn    spam      = nobody
6013 #         message   = X-Spam_score: $spam_score\n\
6014 #                     X-Spam_score_int: $spam_score_int\n\
6015 #                     X-Spam_bar: $spam_bar\n\
6016 #                     X-Spam_report: $spam_report
6017 .endd
6018 These lines are an example of how to arrange for messages to be scanned by
6019 SpamAssassin when Exim has been compiled with the content-scanning extension,
6020 and SpamAssassin has been installed. The SpamAssassin check is run with
6021 &`nobody`& as its user parameter, and the results are added to the message as a
6022 series of extra header line. In this case, the message is not rejected,
6023 whatever the spam score.
6024 .code
6025 accept
6026 .endd
6027 This final line in the DATA ACL accepts the message unconditionally.
6028
6029
6030 .section "Router configuration" "SECID55"
6031 .cindex "default" "routers"
6032 .cindex "routers" "default"
6033 The router configuration comes next in the default configuration, introduced
6034 by the line
6035 .code
6036 begin routers
6037 .endd
6038 Routers are the modules in Exim that make decisions about where to send
6039 messages. An address is passed to each router, in turn, until it is either
6040 accepted, or failed. This means that the order in which you define the routers
6041 matters. Each router is fully described in its own chapter later in this
6042 manual. Here we give only brief overviews.
6043 .code
6044 # domain_literal:
6045 #   driver = ipliteral
6046 #   domains = !+local_domains
6047 #   transport = remote_smtp
6048 .endd
6049 .cindex "domain literal" "default router"
6050 This router is commented out because the majority of sites do not want to
6051 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6052 you uncomment this router, you also need to uncomment the setting of
6053 &%allow_domain_literals%& in the main part of the configuration.
6054
6055 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6056 macro has been defined, per
6057 .code
6058 .ifdef ROUTER_SMARTHOST
6059 smarthost:
6060 #...
6061 .else
6062 dnslookup:
6063 #...
6064 .endif
6065 .endd
6066
6067 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6068 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6069 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6070 skip these routers because of the &%domains%& option.
6071
6072 .code
6073 smarthost:
6074   driver = manualroute
6075   domains = ! +local_domains
6076   transport = smarthost_smtp
6077   route_data = ROUTER_SMARTHOST
6078   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6079   no_more
6080 .endd
6081 This router only handles mail which is not to any local domains; this is
6082 specified by the line
6083 .code
6084 domains = ! +local_domains
6085 .endd
6086 The &%domains%& option lists the domains to which this router applies, but the
6087 exclamation mark is a negation sign, so the router is used only for domains
6088 that are not in the domain list called &'local_domains'& (which was defined at
6089 the start of the configuration). The plus sign before &'local_domains'&
6090 indicates that it is referring to a named list. Addresses in other domains are
6091 passed on to the following routers.
6092
6093 The name of the router driver is &(manualroute)& because we are manually
6094 specifying how mail should be routed onwards, instead of using DNS MX.
6095 While the name of this router instance is arbitrary, the &%driver%& option must
6096 be one of the driver modules that is in the Exim binary.
6097
6098 With no pre-conditions other than &%domains%&, all mail for non-local domains
6099 will be handled by this router, and the &%no_more%& setting will ensure that no
6100 other routers will be used for messages matching the pre-conditions.  See
6101 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6102 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6103 and the macro supplies the value; the address is then queued for the
6104 &(smarthost_smtp)& transport.
6105
6106 .code
6107 dnslookup:
6108   driver = dnslookup
6109   domains = ! +local_domains
6110   transport = remote_smtp
6111   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6112   no_more
6113 .endd
6114 The &%domains%& option behaves as per smarthost, above.
6115
6116 The name of the router driver is &(dnslookup)&,
6117 and is specified by the &%driver%& option. Do not be confused by the fact that
6118 the name of this router instance is the same as the name of the driver. The
6119 instance name is arbitrary, but the name set in the &%driver%& option must be
6120 one of the driver modules that is in the Exim binary.
6121
6122 The &(dnslookup)& router routes addresses by looking up their domains in the
6123 DNS in order to obtain a list of hosts to which the address is routed. If the
6124 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6125 specified by the &%transport%& option. If the router does not find the domain
6126 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6127 the address fails and is bounced.
6128
6129 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6130 be entirely ignored. This option is present because a number of cases have been
6131 encountered where MX records in the DNS point to host names
6132 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6133 Completely ignoring these IP addresses causes Exim to fail to route the
6134 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6135 continue to try to deliver the message periodically until the address timed
6136 out.
6137 .code
6138 system_aliases:
6139   driver = redirect
6140   allow_fail
6141   allow_defer
6142   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6143 # user = exim
6144   file_transport = address_file
6145   pipe_transport = address_pipe
6146 .endd
6147 Control reaches this and subsequent routers only for addresses in the local
6148 domains. This router checks to see whether the local part is defined as an
6149 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6150 data that it looks up from that file. If no data is found for the local part,
6151 the value of the &%data%& option is empty, causing the address to be passed to
6152 the next router.
6153
6154 &_/etc/aliases_& is a conventional name for the system aliases file that is
6155 often used. That is why it is referenced by from the default configuration
6156 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6157 &_Local/Makefile_& before building Exim.
6158 .code
6159 userforward:
6160   driver = redirect
6161   check_local_user
6162 # local_part_suffix = +* : -*
6163 # local_part_suffix_optional
6164   file = $home/.forward
6165 # allow_filter
6166   no_verify
6167   no_expn
6168   check_ancestor
6169   file_transport = address_file
6170   pipe_transport = address_pipe
6171   reply_transport = address_reply
6172 .endd
6173 This is the most complicated router in the default configuration. It is another
6174 redirection router, but this time it is looking for forwarding data set up by
6175 individual users. The &%check_local_user%& setting specifies a check that the
6176 local part of the address is the login name of a local user. If it is not, the
6177 router is skipped. The two commented options that follow &%check_local_user%&,
6178 namely:
6179 .code
6180 # local_part_suffix = +* : -*
6181 # local_part_suffix_optional
6182 .endd
6183 .vindex "&$local_part_suffix$&"
6184 show how you can specify the recognition of local part suffixes. If the first
6185 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6186 by any sequence of characters, is removed from the local part and placed in the
6187 variable &$local_part_suffix$&. The second suffix option specifies that the
6188 presence of a suffix in the local part is optional. When a suffix is present,
6189 the check for a local login uses the local part with the suffix removed.
6190
6191 When a local user account is found, the file called &_.forward_& in the user's
6192 home directory is consulted. If it does not exist, or is empty, the router
6193 declines. Otherwise, the contents of &_.forward_& are interpreted as
6194 redirection data (see chapter &<<CHAPredirect>>& for more details).
6195
6196 .cindex "Sieve filter" "enabling in default router"
6197 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6198 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6199 is commented out by default), the contents of the file are interpreted as a set
6200 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6201 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6202 separate document entitled &'Exim's interfaces to mail filtering'&.
6203
6204 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6205 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6206 There are two reasons for doing this:
6207
6208 .olist
6209 Whether or not a local user has a &_.forward_& file is not really relevant when
6210 checking an address for validity; it makes sense not to waste resources doing
6211 unnecessary work.
6212 .next
6213 More importantly, when Exim is verifying addresses or handling an EXPN
6214 command during an SMTP session, it is running as the Exim user, not as root.
6215 The group is the Exim group, and no additional groups are set up.
6216 It may therefore not be possible for Exim to read users' &_.forward_& files at
6217 this time.
6218 .endlist
6219
6220 The setting of &%check_ancestor%& prevents the router from generating a new
6221 address that is the same as any previous address that was redirected. (This
6222 works round a problem concerning a bad interaction between aliasing and
6223 forwarding &-- see section &<<SECTredlocmai>>&).
6224
6225 The final three option settings specify the transports that are to be used when
6226 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6227 auto-reply, respectively. For example, if a &_.forward_& file contains
6228 .code
6229 a.nother@elsewhere.example, /home/spqr/archive
6230 .endd
6231 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6232 transport.
6233 .code
6234 localuser:
6235   driver = accept
6236   check_local_user
6237 # local_part_suffix = +* : -*
6238 # local_part_suffix_optional
6239   transport = local_delivery
6240 .endd
6241 The final router sets up delivery into local mailboxes, provided that the local
6242 part is the name of a local login, by accepting the address and assigning it to
6243 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6244 routers, so the address is bounced. The commented suffix settings fulfil the
6245 same purpose as they do for the &(userforward)& router.
6246
6247
6248 .section "Transport configuration" "SECID56"
6249 .cindex "default" "transports"
6250 .cindex "transports" "default"
6251 Transports define mechanisms for actually delivering messages. They operate
6252 only when referenced from routers, so the order in which they are defined does
6253 not matter. The transports section of the configuration starts with
6254 .code
6255 begin transports
6256 .endd
6257 Two remote transports and four local transports are defined.
6258 .code
6259 remote_smtp:
6260   driver = smtp
6261   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6262 .ifdef _HAVE_DANE
6263   dnssec_request_domains = *
6264   hosts_try_dane = *
6265 .endif
6266 .ifdef _HAVE_PRDR
6267   hosts_try_prdr = *
6268 .endif
6269 .endd
6270 This transport is used for delivering messages over SMTP connections.
6271 The list of remote hosts comes from the router.
6272 The &%message_size_limit%& usage is a hack to avoid sending on messages
6273 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6274 to try to use DNSSEC for all queries and to use DANE for delivery;
6275 see section &<<SECDANE>>& for more details.
6276
6277 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6278 negotiated between client and server and not expected to cause problems
6279 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6280 use of the &%hosts_try_prdr%& configuration option.
6281
6282 The other remote transport is used when delivering to a specific smarthost
6283 with whom there must be some kind of existing relationship, instead of the
6284 usual federated system.
6285
6286 .code
6287 smarthost_smtp:
6288   driver = smtp
6289   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6290   multi_domain
6291   #
6292 .ifdef _HAVE_TLS
6293   # Comment out any of these which you have to, then file a Support
6294   # request with your smarthost provider to get things fixed:
6295   hosts_require_tls = *
6296   tls_verify_hosts = *
6297   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6298   # have to comment it out then this will at least log whether you succeed
6299   # or not:
6300   tls_try_verify_hosts = *
6301   #
6302   # The SNI name should match the name which we'll expect to verify;
6303   # many mail systems don't use SNI and this doesn't matter, but if it does,
6304   # we need to send a name which the remote site will recognize.
6305   # This _should_ be the name which the smarthost operators specified as
6306   # the hostname for sending your mail to.
6307   tls_sni = ROUTER_SMARTHOST
6308   #
6309 .ifdef _HAVE_OPENSSL
6310   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6311 .endif
6312 .ifdef _HAVE_GNUTLS
6313   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6314 .endif
6315 .endif
6316 .ifdef _HAVE_PRDR
6317   hosts_try_prdr = *
6318 .endif
6319 .endd
6320 After the same &%message_size_limit%& hack, we then specify that this Transport
6321 can handle messages to multiple domains in one run.  The assumption here is
6322 that you're routing all non-local mail to the same place and that place is
6323 happy to take all messages from you as quickly as possible.
6324 All other options depend upon built-in macros; if Exim was built without TLS support
6325 then no other options are defined.
6326 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6327 and versions using the &%tls_require_ciphers%& option, where the value to be
6328 used depends upon the library providing TLS.
6329 Beyond that, the options adopt the stance that you should have TLS support available
6330 from your smarthost on today's Internet, so we turn on requiring TLS for the
6331 mail to be delivered, and requiring that the certificate be valid, and match
6332 the expected hostname.  The &%tls_sni%& option can be used by service providers
6333 to select an appropriate certificate to present to you and here we re-use the
6334 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6335 You want to specify the hostname which you'll expect to validate for, and that
6336 should not be subject to insecure tampering via DNS results.
6337
6338 For the &%hosts_try_prdr%& option see the previous transport.
6339
6340 All other options are defaulted.
6341 .code
6342 local_delivery:
6343   driver = appendfile
6344   file = /var/mail/$local_part
6345   delivery_date_add
6346   envelope_to_add
6347   return_path_add
6348 # group = mail
6349 # mode = 0660
6350 .endd
6351 This &(appendfile)& transport is used for local delivery to user mailboxes in
6352 traditional BSD mailbox format. By default it runs under the uid and gid of the
6353 local user, which requires the sticky bit to be set on the &_/var/mail_&
6354 directory. Some systems use the alternative approach of running mail deliveries
6355 under a particular group instead of using the sticky bit. The commented options
6356 show how this can be done.
6357
6358 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6359 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6360 similarly-named options above.
6361 .code
6362 address_pipe:
6363   driver = pipe
6364   return_output
6365 .endd
6366 This transport is used for handling deliveries to pipes that are generated by
6367 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6368 option specifies that any output on stdout or stderr generated by the pipe is to
6369 be returned to the sender.
6370 .code
6371 address_file:
6372   driver = appendfile
6373   delivery_date_add
6374   envelope_to_add
6375   return_path_add
6376 .endd
6377 This transport is used for handling deliveries to files that are generated by
6378 redirection. The name of the file is not specified in this instance of
6379 &(appendfile)&, because it comes from the &(redirect)& router.
6380 .code
6381 address_reply:
6382   driver = autoreply
6383 .endd
6384 This transport is used for handling automatic replies generated by users'
6385 filter files.
6386
6387
6388
6389 .section "Default retry rule" "SECID57"
6390 .cindex "retry" "default rule"
6391 .cindex "default" "retry rule"
6392 The retry section of the configuration file contains rules which affect the way
6393 Exim retries deliveries that cannot be completed at the first attempt. It is
6394 introduced by the line
6395 .code
6396 begin retry
6397 .endd
6398 In the default configuration, there is just one rule, which applies to all
6399 errors:
6400 .code
6401 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6402 .endd
6403 This causes any temporarily failing address to be retried every 15 minutes for
6404 2 hours, then at intervals starting at one hour and increasing by a factor of
6405 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6406 is not delivered after 4 days of temporary failure, it is bounced. The time is
6407 measured from first failure, not from the time the message was received.
6408
6409 If the retry section is removed from the configuration, or is empty (that is,
6410 if no retry rules are defined), Exim will not retry deliveries. This turns
6411 temporary errors into permanent errors.
6412
6413
6414 .section "Rewriting configuration" "SECID58"
6415 The rewriting section of the configuration, introduced by
6416 .code
6417 begin rewrite
6418 .endd
6419 contains rules for rewriting addresses in messages as they arrive. There are no
6420 rewriting rules in the default configuration file.
6421
6422
6423
6424 .section "Authenticators configuration" "SECTdefconfauth"
6425 .cindex "AUTH" "configuration"
6426 The authenticators section of the configuration, introduced by
6427 .code
6428 begin authenticators
6429 .endd
6430 defines mechanisms for the use of the SMTP AUTH command. The default
6431 configuration file contains two commented-out example authenticators
6432 which support plaintext username/password authentication using the
6433 standard PLAIN mechanism and the traditional but non-standard LOGIN
6434 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6435 to support most MUA software.
6436
6437 The example PLAIN authenticator looks like this:
6438 .code
6439 #PLAIN:
6440 #  driver                  = plaintext
6441 #  server_set_id           = $auth2
6442 #  server_prompts          = :
6443 #  server_condition        = Authentication is not yet configured
6444 #  server_advertise_condition = ${if def:tls_in_cipher }
6445 .endd
6446 And the example LOGIN authenticator looks like this:
6447 .code
6448 #LOGIN:
6449 #  driver                  = plaintext
6450 #  server_set_id           = $auth1
6451 #  server_prompts          = <| Username: | Password:
6452 #  server_condition        = Authentication is not yet configured
6453 #  server_advertise_condition = ${if def:tls_in_cipher }
6454 .endd
6455
6456 The &%server_set_id%& option makes Exim remember the authenticated username
6457 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6458 &%server_prompts%& option configures the &(plaintext)& authenticator so
6459 that it implements the details of the specific authentication mechanism,
6460 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6461 when Exim offers authentication to clients; in the examples, this is only
6462 when TLS or SSL has been started, so to enable the authenticators you also
6463 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6464
6465 The &%server_condition%& setting defines how to verify that the username and
6466 password are correct. In the examples it just produces an error message.
6467 To make the authenticators work, you can use a string expansion
6468 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6469
6470 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6471 usercode and password are in different positions.
6472 Chapter &<<CHAPplaintext>>& covers both.
6473
6474 .ecindex IIDconfiwal
6475
6476
6477
6478 . ////////////////////////////////////////////////////////////////////////////
6479 . ////////////////////////////////////////////////////////////////////////////
6480
6481 .chapter "Regular expressions" "CHAPregexp"
6482
6483 .cindex "regular expressions" "library"
6484 .cindex "PCRE"
6485 Exim supports the use of regular expressions in many of its options. It
6486 uses the PCRE regular expression library; this provides regular expression
6487 matching that is compatible with Perl 5. The syntax and semantics of
6488 regular expressions is discussed in
6489 online Perl manpages, in
6490 many Perl reference books, and also in
6491 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6492 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6493 . --- the http: URL here redirects to another page with the ISBN in the URL
6494 . --- where trying to use https: just redirects back to http:, so sticking
6495 . --- to the old URL for now.  2018-09-07.
6496
6497 The documentation for the syntax and semantics of the regular expressions that
6498 are supported by PCRE is included in the PCRE distribution, and no further
6499 description is included here. The PCRE functions are called from Exim using
6500 the default option settings (that is, with no PCRE options set), except that
6501 the PCRE_CASELESS option is set when the matching is required to be
6502 case-insensitive.
6503
6504 In most cases, when a regular expression is required in an Exim configuration,
6505 it has to start with a circumflex, in order to distinguish it from plain text
6506 or an &"ends with"& wildcard. In this example of a configuration setting, the
6507 second item in the colon-separated list is a regular expression.
6508 .code
6509 domains = a.b.c : ^\\d{3} : *.y.z : ...
6510 .endd
6511 The doubling of the backslash is required because of string expansion that
6512 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6513 of this issue, and a way of avoiding the need for doubling backslashes. The
6514 regular expression that is eventually used in this example contains just one
6515 backslash. The circumflex is included in the regular expression, and has the
6516 normal effect of &"anchoring"& it to the start of the string that is being
6517 matched.
6518
6519 There are, however, two cases where a circumflex is not required for the
6520 recognition of a regular expression: these are the &%match%& condition in a
6521 string expansion, and the &%matches%& condition in an Exim filter file. In
6522 these cases, the relevant string is always treated as a regular expression; if
6523 it does not start with a circumflex, the expression is not anchored, and can
6524 match anywhere in the subject string.
6525
6526 In all cases, if you want a regular expression to match at the end of a string,
6527 you must code the $ metacharacter to indicate this. For example:
6528 .code
6529 domains = ^\\d{3}\\.example
6530 .endd
6531 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6532 You need to use:
6533 .code
6534 domains = ^\\d{3}\\.example\$
6535 .endd
6536 if you want &'example'& to be the top-level domain. The backslash before the
6537 $ is needed because string expansion also interprets dollar characters.
6538
6539
6540
6541 . ////////////////////////////////////////////////////////////////////////////
6542 . ////////////////////////////////////////////////////////////////////////////
6543
6544 .chapter "File and database lookups" "CHAPfdlookup"
6545 .scindex IIDfidalo1 "file" "lookups"
6546 .scindex IIDfidalo2 "database" "lookups"
6547 .cindex "lookup" "description of"
6548 Exim can be configured to look up data in files or databases as it processes
6549 messages. Two different kinds of syntax are used:
6550
6551 .olist
6552 A string that is to be expanded may contain explicit lookup requests. These
6553 cause parts of the string to be replaced by data that is obtained from the
6554 lookup. Lookups of this type are conditional expansion items. Different results
6555 can be defined for the cases of lookup success and failure. See chapter
6556 &<<CHAPexpand>>&, where string expansions are described in detail.
6557 The key for the lookup is specified as part of the string expansion.
6558 .next
6559 Lists of domains, hosts, and email addresses can contain lookup requests as a
6560 way of avoiding excessively long linear lists. In this case, the data that is
6561 returned by the lookup is often (but not always) discarded; whether the lookup
6562 succeeds or fails is what really counts. These kinds of list are described in
6563 chapter &<<CHAPdomhosaddlists>>&.
6564 The key for the lookup is given by the context in which the list is expanded.
6565 .endlist
6566
6567 String expansions, lists, and lookups interact with each other in such a way
6568 that there is no order in which to describe any one of them that does not
6569 involve references to the others. Each of these three chapters makes more sense
6570 if you have read the other two first. If you are reading this for the first
6571 time, be aware that some of it will make a lot more sense after you have read
6572 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6573
6574 .section "Examples of different lookup syntax" "SECID60"
6575 It is easy to confuse the two different kinds of lookup, especially as the
6576 lists that may contain the second kind are always expanded before being
6577 processed as lists. Therefore, they may also contain lookups of the first kind.
6578 Be careful to distinguish between the following two examples:
6579 .code
6580 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6581 domains = lsearch;/some/file
6582 .endd
6583 The first uses a string expansion, the result of which must be a domain list.
6584 No strings have been specified for a successful or a failing lookup; the
6585 defaults in this case are the looked-up data and an empty string, respectively.
6586 The expansion takes place before the string is processed as a list, and the
6587 file that is searched could contain lines like this:
6588 .code
6589 192.168.3.4: domain1:domain2:...
6590 192.168.1.9: domain3:domain4:...
6591 .endd
6592 When the lookup succeeds, the result of the expansion is a list of domains (and
6593 possibly other types of item that are allowed in domain lists).
6594
6595 In the second example, the lookup is a single item in a domain list. It causes
6596 Exim to use a lookup to see if the domain that is being processed can be found
6597 in the file. The file could contains lines like this:
6598 .code
6599 domain1:
6600 domain2:
6601 .endd
6602 Any data that follows the keys is not relevant when checking that the domain
6603 matches the list item.
6604
6605 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6606 Consider a file containing lines like this:
6607 .code
6608 192.168.5.6: lsearch;/another/file
6609 .endd
6610 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6611 first &%domains%& setting above generates the second setting, which therefore
6612 causes a second lookup to occur.
6613
6614 The rest of this chapter describes the different lookup types that are
6615 available. Any of them can be used in any part of the configuration where a
6616 lookup is permitted.
6617
6618
6619 .section "Lookup types" "SECID61"
6620 .cindex "lookup" "types of"
6621 .cindex "single-key lookup" "definition of"
6622 Two different types of data lookup are implemented:
6623
6624 .ilist
6625 The &'single-key'& type requires the specification of a file in which to look,
6626 and a single key to search for. The key must be a non-empty string for the
6627 lookup to succeed. The lookup type determines how the file is searched.
6628 .next
6629 .cindex "query-style lookup" "definition of"
6630 The &'query-style'& type accepts a generalized database query. No particular
6631 key value is assumed by Exim for query-style lookups. You can use whichever
6632 Exim variables you need to construct the database query.
6633 .endlist
6634
6635 The code for each lookup type is in a separate source file that is included in
6636 the binary of Exim only if the corresponding compile-time option is set. The
6637 default settings in &_src/EDITME_& are:
6638 .code
6639 LOOKUP_DBM=yes
6640 LOOKUP_LSEARCH=yes
6641 .endd
6642 which means that only linear searching and DBM lookups are included by default.
6643 For some types of lookup (e.g. SQL databases), you need to install appropriate
6644 libraries and header files before building Exim.
6645
6646
6647
6648
6649 .section "Single-key lookup types" "SECTsinglekeylookups"
6650 .cindex "lookup" "single-key types"
6651 .cindex "single-key lookup" "list of types"
6652 The following single-key lookup types are implemented:
6653
6654 .ilist
6655 .cindex "cdb" "description of"
6656 .cindex "lookup" "cdb"
6657 .cindex "binary zero" "in lookup key"
6658 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6659 string without a terminating binary zero. The cdb format is designed for
6660 indexed files that are read frequently and never updated, except by total
6661 re-creation. As such, it is particularly suitable for large files containing
6662 aliases or other indexed data referenced by an MTA. Information about cdb and
6663 tools for building the files can be found in several places:
6664 .display
6665 &url(https://cr.yp.to/cdb.html)
6666 &url(http://www.corpit.ru/mjt/tinycdb.html)
6667 &url(https://packages.debian.org/stable/utils/freecdb)
6668 &url(https://github.com/philpennock/cdbtools) (in Go)
6669 .endd
6670 . --- 2018-09-07: corpit.ru http:-only
6671 A cdb distribution is not needed in order to build Exim with cdb support,
6672 because the code for reading cdb files is included directly in Exim itself.
6673 However, no means of building or testing cdb files is provided with Exim, so
6674 you need to obtain a cdb distribution in order to do this.
6675 .next
6676 .cindex "DBM" "lookup type"
6677 .cindex "lookup" "dbm"
6678 .cindex "binary zero" "in lookup key"
6679 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6680 DBM file by looking up the record with the given key. A terminating binary
6681 zero is included in the key that is passed to the DBM library. See section
6682 &<<SECTdb>>& for a discussion of DBM libraries.
6683
6684 .cindex "Berkeley DB library" "file format"
6685 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6686 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6687 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6688 the DB_UNKNOWN option. This enables it to handle any of the types of database
6689 that the library supports, and can be useful for accessing DBM files created by
6690 other applications. (For earlier DB versions, DB_HASH is always used.)
6691 .next
6692 .cindex "lookup" "dbmjz"
6693 .cindex "lookup" "dbm &-- embedded NULs"
6694 .cindex "sasldb2"
6695 .cindex "dbmjz lookup type"
6696 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6697 interpreted as an Exim list; the elements of the list are joined together with
6698 ASCII NUL characters to form the lookup key.  An example usage would be to
6699 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6700 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6701 &(cram_md5)& authenticator.
6702 .next
6703 .cindex "lookup" "dbmnz"
6704 .cindex "lookup" "dbm &-- terminating zero"
6705 .cindex "binary zero" "in lookup key"
6706 .cindex "Courier"
6707 .cindex "&_/etc/userdbshadow.dat_&"
6708 .cindex "dbmnz lookup type"
6709 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6710 is not included in the key that is passed to the DBM library. You may need this
6711 if you want to look up data in files that are created by or shared with some
6712 other application that does not use terminating zeros. For example, you need to
6713 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6714 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6715 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6716 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6717 .next
6718 .cindex "lookup" "dsearch"
6719 .cindex "dsearch lookup type"
6720 &(dsearch)&: The given file must be a directory; this is searched for an entry
6721 whose name is the key by calling the &[lstat()]& function. The key may not
6722 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6723 the lookup is the name of the entry, which may be a file, directory,
6724 symbolic link, or any other kind of directory entry. An example of how this
6725 lookup can be used to support virtual domains is given in section
6726 &<<SECTvirtualdomains>>&.
6727 .next
6728 .cindex "lookup" "iplsearch"
6729 .cindex "iplsearch lookup type"
6730 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6731 terminated by a colon or white space or the end of the line. The keys in the
6732 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6733 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6734 being interpreted as a key terminator. For example:
6735 .code
6736 1.2.3.4:           data for 1.2.3.4
6737 192.168.0.0/16:    data for 192.168.0.0/16
6738 "abcd::cdab":      data for abcd::cdab
6739 "abcd:abcd::/32"   data for abcd:abcd::/32
6740 .endd
6741 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6742 file is searched linearly, using the CIDR masks where present, until a matching
6743 key is found. The first key that matches is used; there is no attempt to find a
6744 &"best"& match. Apart from the way the keys are matched, the processing for
6745 &(iplsearch)& is the same as for &(lsearch)&.
6746
6747 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6748 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6749 lookup types support only literal keys.
6750
6751 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6752 the implicit key is the host's IP address rather than its name (see section
6753 &<<SECThoslispatsikey>>&).
6754
6755 .new
6756 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6757 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6758 notation before executing the lookup.)
6759 .wen
6760 .next
6761 .new
6762 .cindex lookup json
6763 .cindex json "lookup type"
6764 .cindex JSON expansions
6765 &(json)&: The given file is a text file with a JSON structure.
6766 An element of the structure is extracted, defined by the search key.
6767 The key is a list of subelement selectors
6768 (colon-separated by default but changeable in the usual way)
6769 which are applied in turn to select smaller and smaller portions
6770 of the JSON structure.
6771 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6772 nunbered array element is selected.
6773 Otherwise it must apply to a JSON object; the named element is selected.
6774 The final resulting element can be a simple JSON type or a JSON object
6775 or array; for the latter two a string-representation os the JSON
6776 is returned.
6777 For elements of type string, the returned value is de-quoted.
6778 .wen
6779 .next
6780 .cindex "linear search"
6781 .cindex "lookup" "lsearch"
6782 .cindex "lsearch lookup type"
6783 .cindex "case sensitivity" "in lsearch lookup"
6784 &(lsearch)&: The given file is a text file that is searched linearly for a
6785 line beginning with the search key, terminated by a colon or white space or the
6786 end of the line. The search is case-insensitive; that is, upper and lower case
6787 letters are treated as the same. The first occurrence of the key that is found
6788 in the file is used.
6789
6790 White space between the key and the colon is permitted. The remainder of the
6791 line, with leading and trailing white space removed, is the data. This can be
6792 continued onto subsequent lines by starting them with any amount of white
6793 space, but only a single space character is included in the data at such a
6794 junction. If the data begins with a colon, the key must be terminated by a
6795 colon, for example:
6796 .code
6797 baduser:  :fail:
6798 .endd
6799 Empty lines and lines beginning with # are ignored, even if they occur in the
6800 middle of an item. This is the traditional textual format of alias files. Note
6801 that the keys in an &(lsearch)& file are literal strings. There is no
6802 wildcarding of any kind.
6803
6804 .cindex "lookup" "lsearch &-- colons in keys"
6805 .cindex "white space" "in lsearch key"
6806 In most &(lsearch)& files, keys are not required to contain colons or #
6807 characters, or white space. However, if you need this feature, it is available.
6808 If a key begins with a doublequote character, it is terminated only by a
6809 matching quote (or end of line), and the normal escaping rules apply to its
6810 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6811 quoted keys (exactly as for unquoted keys). There is no special handling of
6812 quotes for the data part of an &(lsearch)& line.
6813
6814 .next
6815 .cindex "NIS lookup type"
6816 .cindex "lookup" "NIS"
6817 .cindex "binary zero" "in lookup key"
6818 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6819 the given key, without a terminating binary zero. There is a variant called
6820 &(nis0)& which does include the terminating binary zero in the key. This is
6821 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6822 aliases; the full map names must be used.
6823
6824 .next
6825 .cindex "wildlsearch lookup type"
6826 .cindex "lookup" "wildlsearch"
6827 .cindex "nwildlsearch lookup type"
6828 .cindex "lookup" "nwildlsearch"
6829 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6830 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6831 the file may be wildcarded. The difference between these two lookup types is
6832 that for &(wildlsearch)&, each key in the file is string-expanded before being
6833 used, whereas for &(nwildlsearch)&, no expansion takes place.
6834
6835 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6836 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6837 file that are regular expressions can be made case-sensitive by the use of
6838 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6839
6840 . ==== As this is a nested list, any displays it contains must be indented
6841 . ==== as otherwise they are too far to the left.
6842
6843 .olist
6844 The string may begin with an asterisk to mean &"ends with"&. For example:
6845 .code
6846     *.a.b.c       data for anything.a.b.c
6847     *fish         data for anythingfish
6848 .endd
6849 .next
6850 The string may begin with a circumflex to indicate a regular expression. For
6851 example, for &(wildlsearch)&:
6852 .code
6853     ^\N\d+\.a\.b\N    data for <digits>.a.b
6854 .endd
6855 Note the use of &`\N`& to disable expansion of the contents of the regular
6856 expression. If you are using &(nwildlsearch)&, where the keys are not
6857 string-expanded, the equivalent entry is:
6858 .code
6859     ^\d+\.a\.b        data for <digits>.a.b
6860 .endd
6861 The case-insensitive flag is set at the start of compiling the regular
6862 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6863 For example, to make the entire pattern case-sensitive:
6864 .code
6865     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6866 .endd
6867
6868 If the regular expression contains white space or colon characters, you must
6869 either quote it (see &(lsearch)& above), or represent these characters in other
6870 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6871 colon. This may be easier than quoting, because if you quote, you have to
6872 escape all the backslashes inside the quotes.
6873
6874 &*Note*&: It is not possible to capture substrings in a regular expression
6875 match for later use, because the results of all lookups are cached. If a lookup
6876 is repeated, the result is taken from the cache, and no actual pattern matching
6877 takes place. The values of all the numeric variables are unset after a
6878 &((n)wildlsearch)& match.
6879
6880 .next
6881 Although I cannot see it being of much use, the general matching function that
6882 is used to implement &((n)wildlsearch)& means that the string may begin with a
6883 lookup name terminated by a semicolon, and followed by lookup data. For
6884 example:
6885 .code
6886     cdb;/some/file  data for keys that match the file
6887 .endd
6888 The data that is obtained from the nested lookup is discarded.
6889 .endlist olist
6890
6891 Keys that do not match any of these patterns are interpreted literally. The
6892 continuation rules for the data are the same as for &(lsearch)&, and keys may
6893 be followed by optional colons.
6894
6895 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6896 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6897 lookup types support only literal keys.
6898
6899 .next
6900 .cindex "lookup" "spf"
6901 If Exim is built with SPF support, manual lookups can be done
6902 (as opposed to the standard ACL condition method.
6903 For details see section &<<SECSPF>>&.
6904 .endlist ilist
6905
6906
6907 .section "Query-style lookup types" "SECTquerystylelookups"
6908 .cindex "lookup" "query-style types"
6909 .cindex "query-style lookup" "list of types"
6910 The supported query-style lookup types are listed below. Further details about
6911 many of them are given in later sections.
6912
6913 .ilist
6914 .cindex "DNS" "as a lookup type"
6915 .cindex "lookup" "DNS"
6916 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6917 are given in the supplied query. The resulting data is the contents of the
6918 records. See section &<<SECTdnsdb>>&.
6919 .next
6920 .cindex "InterBase lookup type"
6921 .cindex "lookup" "InterBase"
6922 &(ibase)&: This does a lookup in an InterBase database.
6923 .next
6924 .cindex "LDAP" "lookup type"
6925 .cindex "lookup" "LDAP"
6926 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6927 returns attributes from a single entry. There is a variant called &(ldapm)&
6928 that permits values from multiple entries to be returned. A third variant
6929 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6930 any attribute values. See section &<<SECTldap>>&.
6931 .next
6932 .cindex "MySQL" "lookup type"
6933 .cindex "lookup" "MySQL"
6934 &(mysql)&: The format of the query is an SQL statement that is passed to a
6935 MySQL database. See section &<<SECTsql>>&.
6936 .next
6937 .cindex "NIS+ lookup type"
6938 .cindex "lookup" "NIS+"
6939 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6940 the field to be returned. See section &<<SECTnisplus>>&.
6941 .next
6942 .cindex "Oracle" "lookup type"
6943 .cindex "lookup" "Oracle"
6944 &(oracle)&: The format of the query is an SQL statement that is passed to an
6945 Oracle database. See section &<<SECTsql>>&.
6946 .next
6947 .cindex "lookup" "passwd"
6948 .cindex "passwd lookup type"
6949 .cindex "&_/etc/passwd_&"
6950 &(passwd)& is a query-style lookup with queries that are just user names. The
6951 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6952 success, the result string is the same as you would get from an &(lsearch)&
6953 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6954 password value. For example:
6955 .code
6956 *:42:42:King Rat:/home/kr:/bin/bash
6957 .endd
6958 .next
6959 .cindex "PostgreSQL lookup type"
6960 .cindex "lookup" "PostgreSQL"
6961 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6962 PostgreSQL database. See section &<<SECTsql>>&.
6963
6964 .next
6965 .cindex "Redis lookup type"
6966 .cindex lookup Redis
6967 &(redis)&: The format of the query is either a simple get or simple set,
6968 passed to a Redis database. See section &<<SECTsql>>&.
6969
6970 .next
6971 .cindex "sqlite lookup type"
6972 .cindex "lookup" "sqlite"
6973 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6974 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6975
6976 .next
6977 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6978 not likely to be useful in normal operation.
6979 .next
6980 .cindex "whoson lookup type"
6981 .cindex "lookup" "whoson"
6982 . --- still http:-only, 2018-09-07
6983 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6984 allows a server to check whether a particular (dynamically allocated) IP
6985 address is currently allocated to a known (trusted) user and, optionally, to
6986 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6987 at one time for &"POP before SMTP"& authentication, but that approach has been
6988 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6989 &"POP before SMTP"& checking using ACL statements such as
6990 .code
6991 require condition = \
6992   ${lookup whoson {$sender_host_address}{yes}{no}}
6993 .endd
6994 The query consists of a single IP address. The value returned is the name of
6995 the authenticated user, which is stored in the variable &$value$&. However, in
6996 this example, the data in &$value$& is not used; the result of the lookup is
6997 one of the fixed strings &"yes"& or &"no"&.
6998 .endlist
6999
7000
7001
7002 .section "Temporary errors in lookups" "SECID63"
7003 .cindex "lookup" "temporary error in"
7004 Lookup functions can return temporary error codes if the lookup cannot be
7005 completed. For example, an SQL or LDAP database might be unavailable. For this
7006 reason, it is not advisable to use a lookup that might do this for critical
7007 options such as a list of local domains.
7008
7009 When a lookup cannot be completed in a router or transport, delivery
7010 of the message (to the relevant address) is deferred, as for any other
7011 temporary error. In other circumstances Exim may assume the lookup has failed,
7012 or may give up altogether.
7013
7014
7015
7016 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7017 .cindex "wildcard lookups"
7018 .cindex "lookup" "default values"
7019 .cindex "lookup" "wildcard"
7020 .cindex "lookup" "* added to type"
7021 .cindex "default" "in single-key lookups"
7022 In this context, a &"default value"& is a value specified by the administrator
7023 that is to be used if a lookup fails.
7024
7025 &*Note:*& This section applies only to single-key lookups. For query-style
7026 lookups, the facilities of the query language must be used. An attempt to
7027 specify a default for a query-style lookup provokes an error.
7028
7029 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7030 and the initial lookup fails, the key &"*"& is looked up in the file to
7031 provide a default value. See also the section on partial matching below.
7032
7033 .cindex "*@ with single-key lookup"
7034 .cindex "lookup" "*@ added to type"
7035 .cindex "alias file" "per-domain default"
7036 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7037 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7038 character, a second lookup is done with everything before the last @ replaced
7039 by *. This makes it possible to provide per-domain defaults in alias files
7040 that include the domains in the keys. If the second lookup fails (or doesn't
7041 take place because there is no @ in the key), &"*"& is looked up.
7042 For example, a &(redirect)& router might contain:
7043 .code
7044 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7045 .endd
7046 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7047 looks up these keys, in this order:
7048 .code
7049 jane@eyre.example
7050 *@eyre.example
7051 *
7052 .endd
7053 The data is taken from whichever key it finds first. &*Note*&: In an
7054 &(lsearch)& file, this does not mean the first of these keys in the file. A
7055 complete scan is done for each key, and only if it is not found at all does
7056 Exim move on to try the next key.
7057
7058
7059
7060 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7061 .cindex "partial matching"
7062 .cindex "wildcard lookups"
7063 .cindex "lookup" "partial matching"
7064 .cindex "lookup" "wildcard"
7065 .cindex "asterisk" "in search type"
7066 The normal operation of a single-key lookup is to search the file for an exact
7067 match with the given key. However, in a number of situations where domains are
7068 being looked up, it is useful to be able to do partial matching. In this case,
7069 information in the file that has a key starting with &"*."& is matched by any
7070 domain that ends with the components that follow the full stop. For example, if
7071 a key in a DBM file is
7072 .code
7073 *.dates.fict.example
7074 .endd
7075 then when partial matching is enabled this is matched by (amongst others)
7076 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7077 by &'dates.fict.example'&, if that does not appear as a separate key in the
7078 file.
7079
7080 &*Note*&: Partial matching is not available for query-style lookups. It is
7081 also not available for any lookup items in address lists (see section
7082 &<<SECTaddresslist>>&).
7083
7084 Partial matching is implemented by doing a series of separate lookups using
7085 keys constructed by modifying the original subject key. This means that it can
7086 be used with any of the single-key lookup types, provided that
7087 partial matching keys
7088 beginning with a special prefix (default &"*."&) are included in the data file.
7089 Keys in the file that do not begin with the prefix are matched only by
7090 unmodified subject keys when partial matching is in use.
7091
7092 Partial matching is requested by adding the string &"partial-"& to the front of
7093 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7094 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7095 is added at the start of the subject key, and it is looked up again. If that
7096 fails, further lookups are tried with dot-separated components removed from the
7097 start of the subject key, one-by-one, and &"*."& added on the front of what
7098 remains.
7099
7100 A minimum number of two non-* components are required. This can be adjusted
7101 by including a number before the hyphen in the search type. For example,
7102 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7103 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7104 subject key is &'2250.dates.fict.example'& then the following keys are looked
7105 up when the minimum number of non-* components is two:
7106 .code
7107 2250.dates.fict.example
7108 *.2250.dates.fict.example
7109 *.dates.fict.example
7110 *.fict.example
7111 .endd
7112 As soon as one key in the sequence is successfully looked up, the lookup
7113 finishes.
7114
7115 .cindex "lookup" "partial matching &-- changing prefix"
7116 .cindex "prefix" "for partial matching"
7117 The use of &"*."& as the partial matching prefix is a default that can be
7118 changed. The motivation for this feature is to allow Exim to operate with file
7119 formats that are used by other MTAs. A different prefix can be supplied in
7120 parentheses instead of the hyphen after &"partial"&. For example:
7121 .code
7122 domains = partial(.)lsearch;/some/file
7123 .endd
7124 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7125 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7126 components is unchanged). The prefix may consist of any punctuation characters
7127 other than a closing parenthesis. It may be empty, for example:
7128 .code
7129 domains = partial1()cdb;/some/file
7130 .endd
7131 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7132 &`a.b.c`&, &`b.c`&, and &`c`&.
7133
7134 If &"partial0"& is specified, what happens at the end (when the lookup with
7135 just one non-wild component has failed, and the original key is shortened right
7136 down to the null string) depends on the prefix:
7137
7138 .ilist
7139 If the prefix has zero length, the whole lookup fails.
7140 .next
7141 If the prefix has length 1, a lookup for just the prefix is done. For
7142 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7143 .next
7144 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7145 remainder is looked up. With the default prefix, therefore, the final lookup is
7146 for &"*"& on its own.
7147 .next
7148 Otherwise, the whole prefix is looked up.
7149 .endlist
7150
7151
7152 If the search type ends in &"*"& or &"*@"& (see section
7153 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7154 this implies happens after all partial lookups have failed. If &"partial0"& is
7155 specified, adding &"*"& to the search type has no effect with the default
7156 prefix, because the &"*"& key is already included in the sequence of partial
7157 lookups. However, there might be a use for lookup types such as
7158 &"partial0(.)lsearch*"&.
7159
7160 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7161 in domain lists and the like. Partial matching works only in terms of
7162 dot-separated components; a key such as &`*fict.example`&
7163 in a database file is useless, because the asterisk in a partial matching
7164 subject key is always followed by a dot.
7165
7166
7167
7168
7169 .section "Lookup caching" "SECID64"
7170 .cindex "lookup" "caching"
7171 .cindex "caching" "lookup data"
7172 Exim caches all lookup results in order to avoid needless repetition of
7173 lookups. However, because (apart from the daemon) Exim operates as a collection
7174 of independent, short-lived processes, this caching applies only within a
7175 single Exim process. There is no inter-process lookup caching facility.
7176
7177 For single-key lookups, Exim keeps the relevant files open in case there is
7178 another lookup that needs them. In some types of configuration this can lead to
7179 many files being kept open for messages with many recipients. To avoid hitting
7180 the operating system limit on the number of simultaneously open files, Exim
7181 closes the least recently used file when it needs to open more files than its
7182 own internal limit, which can be changed via the &%lookup_open_max%& option.
7183
7184 The single-key lookup files are closed and the lookup caches are flushed at
7185 strategic points during delivery &-- for example, after all routing is
7186 complete.
7187
7188
7189
7190
7191 .section "Quoting lookup data" "SECID65"
7192 .cindex "lookup" "quoting"
7193 .cindex "quoting" "in lookups"
7194 When data from an incoming message is included in a query-style lookup, there
7195 is the possibility of special characters in the data messing up the syntax of
7196 the query. For example, a NIS+ query that contains
7197 .code
7198 [name=$local_part]
7199 .endd
7200 will be broken if the local part happens to contain a closing square bracket.
7201 For NIS+, data can be enclosed in double quotes like this:
7202 .code
7203 [name="$local_part"]
7204 .endd
7205 but this still leaves the problem of a double quote in the data. The rule for
7206 NIS+ is that double quotes must be doubled. Other lookup types have different
7207 rules, and to cope with the differing requirements, an expansion operator
7208 of the following form is provided:
7209 .code
7210 ${quote_<lookup-type>:<string>}
7211 .endd
7212 For example, the safest way to write the NIS+ query is
7213 .code
7214 [name="${quote_nisplus:$local_part}"]
7215 .endd
7216 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7217 operator can be used for all lookup types, but has no effect for single-key
7218 lookups, since no quoting is ever needed in their key strings.
7219
7220
7221
7222
7223 .section "More about dnsdb" "SECTdnsdb"
7224 .cindex "dnsdb lookup"
7225 .cindex "lookup" "dnsdb"
7226 .cindex "DNS" "as a lookup type"
7227 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7228 of a record type and a domain name, separated by an equals sign. For example,
7229 an expansion string could contain:
7230 .code
7231 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7232 .endd
7233 If the lookup succeeds, the result is placed in &$value$&, which in this case
7234 is used on its own as the result. If the lookup does not succeed, the
7235 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7236 &<<SECTforexpfai>>& for an explanation of what this means.
7237
7238 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7239 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7240 If no type is given, TXT is assumed.
7241
7242 For any record type, if multiple records are found, the data is returned as a
7243 concatenation, with newline as the default separator. The order, of course,
7244 depends on the DNS resolver. You can specify a different separator character
7245 between multiple records by putting a right angle-bracket followed immediately
7246 by the new separator at the start of the query. For example:
7247 .code
7248 ${lookup dnsdb{>: a=host1.example}}
7249 .endd
7250 It is permitted to specify a space as the separator character. Further
7251 white space is ignored.
7252 For lookup types that return multiple fields per record,
7253 an alternate field separator can be specified using a comma after the main
7254 separator character, followed immediately by the field separator.
7255
7256 .cindex "PTR record" "in &(dnsdb)& lookup"
7257 When the type is PTR,
7258 the data can be an IP address, written as normal; inversion and the addition of
7259 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7260 .code
7261 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7262 .endd
7263 If the data for a PTR record is not a syntactically valid IP address, it is not
7264 altered and nothing is added.
7265
7266 .cindex "MX record" "in &(dnsdb)& lookup"
7267 .cindex "SRV record" "in &(dnsdb)& lookup"
7268 For an MX lookup, both the preference value and the host name are returned for
7269 each record, separated by a space. For an SRV lookup, the priority, weight,
7270 port, and host name are returned for each record, separated by spaces.
7271 The field separator can be modified as above.
7272
7273 .cindex "TXT record" "in &(dnsdb)& lookup"
7274 .cindex "SPF record" "in &(dnsdb)& lookup"
7275 For TXT records with multiple items of data, only the first item is returned,
7276 unless a field separator is specified.
7277 To concatenate items without a separator, use a semicolon instead.
7278 For SPF records the
7279 default behaviour is to concatenate multiple items without using a separator.
7280 .code
7281 ${lookup dnsdb{>\n,: txt=a.b.example}}
7282 ${lookup dnsdb{>\n; txt=a.b.example}}
7283 ${lookup dnsdb{spf=example.org}}
7284 .endd
7285 It is permitted to specify a space as the separator character. Further
7286 white space is ignored.
7287
7288 .cindex "SOA record" "in &(dnsdb)& lookup"
7289 For an SOA lookup, while no result is obtained the lookup is redone with
7290 successively more leading components dropped from the given domain.
7291 Only the primary-nameserver field is returned unless a field separator is
7292 specified.
7293 .code
7294 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7295 .endd
7296
7297 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7298 .cindex "dnsdb modifiers"
7299 .cindex "modifiers" "dnsdb"
7300 .cindex "options" "dnsdb"
7301 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7302 each followed by a comma,
7303 that may appear before the record type.
7304
7305 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7306 temporary DNS error for any of them, the behaviour is controlled by
7307 a defer-option modifier.
7308 The possible keywords are
7309 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7310 With &"strict"& behaviour, any temporary DNS error causes the
7311 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7312 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7313 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7314 error causes the whole lookup to defer only if none of the other lookups
7315 succeed. The default is &"lax"&, so the following lookups are equivalent:
7316 .code
7317 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7318 ${lookup dnsdb{a=one.host.com:two.host.com}}
7319 .endd
7320 Thus, in the default case, as long as at least one of the DNS lookups
7321 yields some data, the lookup succeeds.
7322
7323 .cindex "DNSSEC" "dns lookup"
7324 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7325 The possible keywords are
7326 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7327 With &"strict"& or &"lax"& DNSSEC information is requested
7328 with the lookup.
7329 With &"strict"& a response from the DNS resolver that
7330 is not labelled as authenticated data
7331 is treated as equivalent to a temporary DNS error.
7332 The default is &"never"&.
7333
7334 See also the &$lookup_dnssec_authenticated$& variable.
7335
7336 .cindex timeout "dns lookup"
7337 .cindex "DNS" timeout
7338 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7339 The form is &"retrans_VAL"& where VAL is an Exim time specification
7340 (e.g. &"5s"&).
7341 The default value is set by the main configuration option &%dns_retrans%&.
7342
7343 Retries for the dnsdb lookup can be controlled by a retry modifier.
7344 The form if &"retry_VAL"& where VAL is an integer.
7345 The default count is set by the main configuration option &%dns_retry%&.
7346
7347 .cindex caching "of dns lookup"
7348 .cindex TTL "of dns lookup"
7349 .cindex DNS TTL
7350 Dnsdb lookup results are cached within a single process (and its children).
7351 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7352 value of the set of returned DNS records.
7353
7354
7355 .section "Pseudo dnsdb record types" "SECID66"
7356 .cindex "MX record" "in &(dnsdb)& lookup"
7357 By default, both the preference value and the host name are returned for
7358 each MX record, separated by a space. If you want only host names, you can use
7359 the pseudo-type MXH:
7360 .code
7361 ${lookup dnsdb{mxh=a.b.example}}
7362 .endd
7363 In this case, the preference values are omitted, and just the host names are
7364 returned.
7365
7366 .cindex "name server for enclosing domain"
7367 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7368 records on the given domain, but if none are found, it removes the first
7369 component of the domain name, and tries again. This process continues until NS
7370 records are found or there are no more components left (or there is a DNS
7371 error). In other words, it may return the name servers for a top-level domain,
7372 but it never returns the root name servers. If there are no NS records for the
7373 top-level domain, the lookup fails. Consider these examples:
7374 .code
7375 ${lookup dnsdb{zns=xxx.quercite.com}}
7376 ${lookup dnsdb{zns=xxx.edu}}
7377 .endd
7378 Assuming that in each case there are no NS records for the full domain name,
7379 the first returns the name servers for &%quercite.com%&, and the second returns
7380 the name servers for &%edu%&.
7381
7382 You should be careful about how you use this lookup because, unless the
7383 top-level domain does not exist, the lookup always returns some host names. The
7384 sort of use to which this might be put is for seeing if the name servers for a
7385 given domain are on a blacklist. You can probably assume that the name servers
7386 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7387 such a list.
7388
7389 .cindex "CSA" "in &(dnsdb)& lookup"
7390 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7391 records according to the CSA rules, which are described in section
7392 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7393 not sufficient because of the extra parent domain search behaviour of CSA. The
7394 result of a successful lookup such as:
7395 .code
7396 ${lookup dnsdb {csa=$sender_helo_name}}
7397 .endd
7398 has two space-separated fields: an authorization code and a target host name.
7399 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7400 authorization required but absent, or &"?"& for unknown.
7401
7402 .cindex "A+" "in &(dnsdb)& lookup"
7403 The pseudo-type A+ performs an AAAA
7404 and then an A lookup.  All results are returned; defer processing
7405 (see below) is handled separately for each lookup.  Example:
7406 .code
7407 ${lookup dnsdb {>; a+=$sender_helo_name}}
7408 .endd
7409
7410
7411 .section "Multiple dnsdb lookups" "SECID67"
7412 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7413 However, you can specify a list of domains or IP addresses in a single
7414 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7415 the default separator, but with the ability to change this. For example:
7416 .code
7417 ${lookup dnsdb{one.domain.com:two.domain.com}}
7418 ${lookup dnsdb{a=one.host.com:two.host.com}}
7419 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7420 .endd
7421 In order to retain backwards compatibility, there is one special case: if
7422 the lookup type is PTR and no change of separator is specified, Exim looks
7423 to see if the rest of the string is precisely one IPv6 address. In this
7424 case, it does not treat it as a list.
7425
7426 The data from each lookup is concatenated, with newline separators by default,
7427 in the same way that multiple DNS records for a single item are handled. A
7428 different separator can be specified, as described above.
7429
7430
7431
7432
7433 .section "More about LDAP" "SECTldap"
7434 .cindex "LDAP" "lookup, more about"
7435 .cindex "lookup" "LDAP"
7436 .cindex "Solaris" "LDAP"
7437 The original LDAP implementation came from the University of Michigan; this has
7438 become &"Open LDAP"&, and there are now two different releases. Another
7439 implementation comes from Netscape, and Solaris 7 and subsequent releases
7440 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7441 the lookup function level, their error handling is different. For this reason
7442 it is necessary to set a compile-time variable when building Exim with LDAP, to
7443 indicate which LDAP library is in use. One of the following should appear in
7444 your &_Local/Makefile_&:
7445 .code
7446 LDAP_LIB_TYPE=UMICHIGAN
7447 LDAP_LIB_TYPE=OPENLDAP1
7448 LDAP_LIB_TYPE=OPENLDAP2
7449 LDAP_LIB_TYPE=NETSCAPE
7450 LDAP_LIB_TYPE=SOLARIS
7451 .endd
7452 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7453 same interface as the University of Michigan version.
7454
7455 There are three LDAP lookup types in Exim. These behave slightly differently in
7456 the way they handle the results of a query:
7457
7458 .ilist
7459 &(ldap)& requires the result to contain just one entry; if there are more, it
7460 gives an error.
7461 .next
7462 &(ldapdn)& also requires the result to contain just one entry, but it is the
7463 Distinguished Name that is returned rather than any attribute values.
7464 .next
7465 &(ldapm)& permits the result to contain more than one entry; the attributes
7466 from all of them are returned.
7467 .endlist
7468
7469
7470 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7471 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7472 the data returned by a successful lookup is described in the next section.
7473 First we explain how LDAP queries are coded.
7474
7475
7476 .section "Format of LDAP queries" "SECTforldaque"
7477 .cindex "LDAP" "query format"
7478 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7479 the configuration of a &(redirect)& router one might have this setting:
7480 .code
7481 data = ${lookup ldap \
7482   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7483   c=UK?mailbox?base?}}
7484 .endd
7485 .cindex "LDAP" "with TLS"
7486 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7487 secure (encrypted) LDAP connections. The second of these ensures that an
7488 encrypted TLS connection is used.
7489
7490 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7491 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7492 See the &%ldap_start_tls%& option.
7493
7494 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7495 controlled. Every part of the TLS configuration can be configured by settings in
7496 &_exim.conf_&. Depending on the version of the client libraries installed on
7497 your system, some of the initialization may have required setting options in
7498 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7499 certificates. This revealed a nuance where the current UID that exim was
7500 running as could affect which config files it read. With Exim 4.83, these
7501 methods become optional, only taking effect if not specifically set in
7502 &_exim.conf_&.
7503
7504
7505 .section "LDAP quoting" "SECID68"
7506 .cindex "LDAP" "quoting"
7507 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7508 and the second because the LDAP query is represented as a URL. Furthermore,
7509 within an LDAP query, two different kinds of quoting are required. For this
7510 reason, there are two different LDAP-specific quoting operators.
7511
7512 The &%quote_ldap%& operator is designed for use on strings that are part of
7513 filter specifications. Conceptually, it first does the following conversions on
7514 the string:
7515 .code
7516 *   =>   \2A
7517 (   =>   \28
7518 )   =>   \29
7519 \   =>   \5C
7520 .endd
7521 in accordance with RFC 2254. The resulting string is then quoted according
7522 to the rules for URLs, that is, all non-alphanumeric characters except
7523 .code
7524 ! $ ' - . _ ( ) * +
7525 .endd
7526 are converted to their hex values, preceded by a percent sign. For example:
7527 .code
7528 ${quote_ldap: a(bc)*, a<yz>; }
7529 .endd
7530 yields
7531 .code
7532 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7533 .endd
7534 Removing the URL quoting, this is (with a leading and a trailing space):
7535 .code
7536 a\28bc\29\2A, a<yz>;
7537 .endd
7538 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7539 base DN specifications in queries. Conceptually, it first converts the string
7540 by inserting a backslash in front of any of the following characters:
7541 .code
7542 , + " \ < > ;
7543 .endd
7544 It also inserts a backslash before any leading spaces or # characters, and
7545 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7546 is then quoted according to the rules for URLs. For example:
7547 .code
7548 ${quote_ldap_dn: a(bc)*, a<yz>; }
7549 .endd
7550 yields
7551 .code
7552 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7553 .endd
7554 Removing the URL quoting, this is (with a trailing space):
7555 .code
7556 \ a(bc)*\, a\<yz\>\;\
7557 .endd
7558 There are some further comments about quoting in the section on LDAP
7559 authentication below.
7560
7561
7562 .section "LDAP connections" "SECID69"
7563 .cindex "LDAP" "connections"
7564 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7565 is in use, via a Unix domain socket. The example given above does not specify
7566 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7567 by starting it with
7568 .code
7569 ldap://<hostname>:<port>/...
7570 .endd
7571 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7572 used. When no server is specified in a query, a list of default servers is
7573 taken from the &%ldap_default_servers%& configuration option. This supplies a
7574 colon-separated list of servers which are tried in turn until one successfully
7575 handles a query, or there is a serious error. Successful handling either
7576 returns the requested data, or indicates that it does not exist. Serious errors
7577 are syntactical, or multiple values when only a single value is expected.
7578 Errors which cause the next server to be tried are connection failures, bind
7579 failures, and timeouts.
7580
7581 For each server name in the list, a port number can be given. The standard way
7582 of specifying a host and port is to use a colon separator (RFC 1738). Because
7583 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7584 doubled. For example
7585 .code
7586 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7587 .endd
7588 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7589 to the LDAP library with no server name, and the library's default (normally
7590 the local host) is used.
7591
7592 If you are using the OpenLDAP library, you can connect to an LDAP server using
7593 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7594 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7595 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7596 not available.
7597
7598 For this type of connection, instead of a host name for the server, a pathname
7599 for the socket is required, and the port number is not relevant. The pathname
7600 can be specified either as an item in &%ldap_default_servers%&, or inline in
7601 the query. In the former case, you can have settings such as
7602 .code
7603 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7604 .endd
7605 When the pathname is given in the query, you have to escape the slashes as
7606 &`%2F`& to fit in with the LDAP URL syntax. For example:
7607 .code
7608 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7609 .endd
7610 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7611 a pathname, it uses the Unix domain socket code, even if the query actually
7612 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7613 socket connection. This behaviour means that you can use a setting of
7614 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7615 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7616 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7617 backup host.
7618
7619 If an explicit &`ldapi`& type is given in a query when a host name is
7620 specified, an error is diagnosed. However, if there are more items in
7621 &%ldap_default_servers%&, they are tried. In other words:
7622
7623 .ilist
7624 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7625 interface.
7626 .next
7627 Using &`ldapi`& with a host name causes an error.
7628 .endlist
7629
7630
7631 Using &`ldapi`& with no host or path in the query, and no setting of
7632 &%ldap_default_servers%&, does whatever the library does by default.
7633
7634
7635
7636 .section "LDAP authentication and control information" "SECID70"
7637 .cindex "LDAP" "authentication"
7638 The LDAP URL syntax provides no way of passing authentication and other control
7639 information to the server. To make this possible, the URL in an LDAP query may
7640 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7641 spaces. If a value contains spaces it must be enclosed in double quotes, and
7642 when double quotes are used, backslash is interpreted in the usual way inside
7643 them. The following names are recognized:
7644 .display
7645 &`DEREFERENCE`&  set the dereferencing parameter
7646 &`NETTIME    `&  set a timeout for a network operation
7647 &`USER       `&  set the DN, for authenticating the LDAP bind
7648 &`PASS       `&  set the password, likewise
7649 &`REFERRALS  `&  set the referrals parameter
7650 &`SERVERS    `&  set alternate server list for this query only
7651 &`SIZE       `&  set the limit for the number of entries returned
7652 &`TIME       `&  set the maximum waiting time for a query
7653 .endd
7654 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7655 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7656 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7657 library from trying to follow referrals issued by the LDAP server.
7658
7659 .cindex LDAP timeout
7660 .cindex timeout "LDAP lookup"
7661 The name CONNECT is an obsolete name for NETTIME, retained for
7662 backwards compatibility. This timeout (specified as a number of seconds) is
7663 enforced from the client end for operations that can be carried out over a
7664 network. Specifically, it applies to network connections and calls to the
7665 &'ldap_result()'& function. If the value is greater than zero, it is used if
7666 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7667 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7668 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7669 Netscape SDK; for OpenLDAP no action is taken.
7670
7671 The TIME parameter (also a number of seconds) is passed to the server to
7672 set a server-side limit on the time taken to complete a search.
7673
7674 The SERVERS parameter allows you to specify an alternate list of ldap servers
7675 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7676 default list of ldap servers, and a single lookup can specify a single ldap
7677 server to use.  But when you need to do a lookup with a list of servers that is
7678 different than the default list (maybe different order, maybe a completely
7679 different set of servers), the SERVERS parameter allows you to specify this
7680 alternate list (colon-separated).
7681
7682 Here is an example of an LDAP query in an Exim lookup that uses some of these
7683 values. This is a single line, folded to fit on the page:
7684 .code
7685 ${lookup ldap
7686   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7687   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7688   {$value}fail}
7689 .endd
7690 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7691 any of the auxiliary data. Exim configuration settings that include lookups
7692 which contain password information should be preceded by &"hide"& to prevent
7693 non-admin users from using the &%-bP%& option to see their values.
7694
7695 The auxiliary data items may be given in any order. The default is no
7696 connection timeout (the system timeout is used), no user or password, no limit
7697 on the number of entries returned, and no time limit on queries.
7698
7699 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7700 removes any URL quoting that it may contain before passing it LDAP. Apparently
7701 some libraries do this for themselves, but some do not. Removing the URL
7702 quoting has two advantages:
7703
7704 .ilist
7705 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7706 DNs as with DNs inside actual queries.
7707 .next
7708 It permits spaces inside USER= DNs.
7709 .endlist
7710
7711 For example, a setting such as
7712 .code
7713 USER=cn=${quote_ldap_dn:$1}
7714 .endd
7715 should work even if &$1$& contains spaces.
7716
7717 Expanded data for the PASS= value should be quoted using the &%quote%&
7718 expansion operator, rather than the LDAP quote operators. The only reason this
7719 field needs quoting is to ensure that it conforms to the Exim syntax, which
7720 does not allow unquoted spaces. For example:
7721 .code
7722 PASS=${quote:$3}
7723 .endd
7724 The LDAP authentication mechanism can be used to check passwords as part of
7725 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7726 &<<CHAPexpand>>&.
7727
7728
7729
7730 .section "Format of data returned by LDAP" "SECID71"
7731 .cindex "LDAP" "returned data formats"
7732 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7733 as a sequence of values, for example
7734 .code
7735 cn=manager,o=University of Cambridge,c=UK
7736 .endd
7737 The &(ldap)& lookup type generates an error if more than one entry matches the
7738 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7739 the result between the data from different entries. It is possible for multiple
7740 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7741 you know that whatever values are returned all came from a single entry in the
7742 directory.
7743
7744 In the common case where you specify a single attribute in your LDAP query, the
7745 result is not quoted, and does not contain the attribute name. If the attribute
7746 has multiple values, they are separated by commas. Any comma that is
7747 part of an attribute's value is doubled.
7748
7749 If you specify multiple attributes, the result contains space-separated, quoted
7750 strings, each preceded by the attribute name and an equals sign. Within the
7751 quotes, the quote character, backslash, and newline are escaped with
7752 backslashes, and commas are used to separate multiple values for the attribute.
7753 Any commas in attribute values are doubled
7754 (permitting treatment of the values as a comma-separated list).
7755 Apart from the escaping, the string within quotes takes the same form as the
7756 output when a single attribute is requested. Specifying no attributes is the
7757 same as specifying all of an entry's attributes.
7758
7759 Here are some examples of the output format. The first line of each pair is an
7760 LDAP query, and the second is the data that is returned. The attribute called
7761 &%attr1%& has two values, one of them with an embedded comma, whereas
7762 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7763 (they have SUP &%attr%& in their schema definitions).
7764
7765 .code
7766 ldap:///o=base?attr1?sub?(uid=fred)
7767 value1.1,value1,,2
7768
7769 ldap:///o=base?attr2?sub?(uid=fred)
7770 value two
7771
7772 ldap:///o=base?attr?sub?(uid=fred)
7773 value1.1,value1,,2,value two
7774
7775 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7776 attr1="value1.1,value1,,2" attr2="value two"
7777
7778 ldap:///o=base??sub?(uid=fred)
7779 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7780 .endd
7781 You can
7782 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7783 results of LDAP lookups.
7784 The &%extract%& operator in string expansions can be used to pick out
7785 individual fields from data that consists of &'key'&=&'value'& pairs.
7786 The &%listextract%& operator should be used to pick out individual values
7787 of attributes, even when only a single value is expected.
7788 The doubling of embedded commas allows you to use the returned data as a
7789 comma separated list (using the "<," syntax for changing the input list separator).
7790
7791
7792
7793
7794 .section "More about NIS+" "SECTnisplus"
7795 .cindex "NIS+ lookup type"
7796 .cindex "lookup" "NIS+"
7797 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7798 and field name. If this is given, the result of a successful query is the
7799 contents of the named field; otherwise the result consists of a concatenation
7800 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7801 values containing spaces are quoted. For example, the query
7802 .code
7803 [name=mg1456],passwd.org_dir
7804 .endd
7805 might return the string
7806 .code
7807 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7808 home=/home/mg1456 shell=/bin/bash shadow=""
7809 .endd
7810 (split over two lines here to fit on the page), whereas
7811 .code
7812 [name=mg1456],passwd.org_dir:gcos
7813 .endd
7814 would just return
7815 .code
7816 Martin Guerre
7817 .endd
7818 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7819 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7820 operator is to double any quote characters within the text.
7821
7822
7823
7824 .section "SQL lookups" "SECTsql"
7825 .cindex "SQL lookup types"
7826 .cindex "MySQL" "lookup type"
7827 .cindex "PostgreSQL lookup type"
7828 .cindex "lookup" "MySQL"
7829 .cindex "lookup" "PostgreSQL"
7830 .cindex "Oracle" "lookup type"
7831 .cindex "lookup" "Oracle"
7832 .cindex "InterBase lookup type"
7833 .cindex "lookup" "InterBase"
7834 .cindex "Redis lookup type"
7835 .cindex lookup Redis
7836 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7837 and SQLite
7838 databases. Queries for these databases contain SQL statements, so an example
7839 might be
7840 .code
7841 ${lookup mysql{select mailbox from users where id='userx'}\
7842   {$value}fail}
7843 .endd
7844 If the result of the query contains more than one field, the data for each
7845 field in the row is returned, preceded by its name, so the result of
7846 .code
7847 ${lookup pgsql{select home,name from users where id='userx'}\
7848   {$value}}
7849 .endd
7850 might be
7851 .code
7852 home=/home/userx name="Mister X"
7853 .endd
7854 Empty values and values containing spaces are double quoted, with embedded
7855 quotes escaped by a backslash. If the result of the query contains just one
7856 field, the value is passed back verbatim, without a field name, for example:
7857 .code
7858 Mister X
7859 .endd
7860 If the result of the query yields more than one row, it is all concatenated,
7861 with a newline between the data for each row.
7862
7863
7864 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7865 .cindex "MySQL" "lookup type"
7866 .cindex "PostgreSQL lookup type"
7867 .cindex "lookup" "MySQL"
7868 .cindex "lookup" "PostgreSQL"
7869 .cindex "Oracle" "lookup type"
7870 .cindex "lookup" "Oracle"
7871 .cindex "InterBase lookup type"
7872 .cindex "lookup" "InterBase"
7873 .cindex "Redis lookup type"
7874 .cindex lookup Redis
7875 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7876 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7877 or &%redis_servers%&
7878 option (as appropriate) must be set to a colon-separated list of server
7879 information.
7880 (For MySQL and PostgreSQL, the global option need not be set if all
7881 queries contain their own server information &-- see section
7882 &<<SECTspeserque>>&.)
7883 For all but Redis
7884 each item in the list is a slash-separated list of four
7885 items: host name, database name, user name, and password. In the case of
7886 Oracle, the host name field is used for the &"service name"&, and the database
7887 name field is not used and should be empty. For example:
7888 .code
7889 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7890 .endd
7891 Because password data is sensitive, you should always precede the setting with
7892 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7893 option. Here is an example where two MySQL servers are listed:
7894 .code
7895 hide mysql_servers = localhost/users/root/secret:\
7896                      otherhost/users/root/othersecret
7897 .endd
7898 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7899 because this is a colon-separated list, the colon has to be doubled. For each
7900 query, these parameter groups are tried in order until a connection is made and
7901 a query is successfully processed. The result of a query may be that no data is
7902 found, but that is still a successful query. In other words, the list of
7903 servers provides a backup facility, not a list of different places to look.
7904
7905 For Redis the global option need not be specified if all queries contain their
7906 own server information &-- see section &<<SECTspeserque>>&.
7907 If specified, the option must be set to a colon-separated list of server
7908 information.
7909 Each item in the list is a slash-separated list of three items:
7910 host, database number, and password.
7911 .olist
7912 The host is required and may be either an IPv4 address and optional
7913 port number (separated by a colon, which needs doubling due to the
7914 higher-level list), or a Unix socket pathname enclosed in parentheses
7915 .next
7916 The database number is optional; if present that number is selected in the backend
7917 .next
7918 The password is optional; if present it is used to authenticate to the backend
7919 .endlist
7920
7921 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7922 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7923 respectively, and the characters single-quote, double-quote, and backslash
7924 itself are escaped with backslashes.
7925
7926 The &%quote_redis%& expansion operator
7927 escapes whitespace and backslash characters with a backslash.
7928
7929 .section "Specifying the server in the query" "SECTspeserque"
7930 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7931 it is possible to specify a list of servers with an individual query. This is
7932 done by starting the query with
7933 .display
7934 &`servers=`&&'server1:server2:server3:...'&&`;`&
7935 .endd
7936 Each item in the list may take one of two forms:
7937 .olist
7938 If it contains no slashes it is assumed to be just a host name. The appropriate
7939 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7940 of the same name, and the remaining parameters (database, user, password) are
7941 taken from there.
7942 .next
7943 If it contains any slashes, it is taken as a complete parameter set.
7944 .endlist
7945 The list of servers is used in exactly the same way as the global list.
7946 Once a connection to a server has happened and a query has been
7947 successfully executed, processing of the lookup ceases.
7948
7949 This feature is intended for use in master/slave situations where updates
7950 are occurring and you want to update the master rather than a slave. If the
7951 master is in the list as a backup for reading, you might have a global setting
7952 like this:
7953 .code
7954 mysql_servers = slave1/db/name/pw:\
7955                 slave2/db/name/pw:\
7956                 master/db/name/pw
7957 .endd
7958 In an updating lookup, you could then write:
7959 .code
7960 ${lookup mysql{servers=master; UPDATE ...} }
7961 .endd
7962 That query would then be sent only to the master server. If, on the other hand,
7963 the master is not to be used for reading, and so is not present in the global
7964 option, you can still update it by a query of this form:
7965 .code
7966 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7967 .endd
7968
7969
7970 .section "Special MySQL features" "SECID73"
7971 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7972 causes a connection to the server on the local host by means of a Unix domain
7973 socket. An alternate socket can be specified in parentheses.
7974 An option group name for MySQL option files can be specified in square brackets;
7975 the default value is &"exim"&.
7976 The full syntax of each item in &%mysql_servers%& is:
7977 .display
7978 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7979   <&'database'&>/<&'user'&>/<&'password'&>
7980 .endd
7981 Any of the four sub-parts of the first field can be omitted. For normal use on
7982 the local host it can be left blank or set to just &"localhost"&.
7983
7984 No database need be supplied &-- but if it is absent here, it must be given in
7985 the queries.
7986
7987 If a MySQL query is issued that does not request any data (an insert, update,
7988 or delete command), the result of the lookup is the number of rows affected.
7989
7990 &*Warning*&: This can be misleading. If an update does not actually change
7991 anything (for example, setting a field to the value it already has), the result
7992 is zero because no rows are affected.
7993
7994
7995 .section "Special PostgreSQL features" "SECID74"
7996 PostgreSQL lookups can also use Unix domain socket connections to the database.
7997 This is usually faster and costs less CPU time than a TCP/IP connection.
7998 However it can be used only if the mail server runs on the same machine as the
7999 database server. A configuration line for PostgreSQL via Unix domain sockets
8000 looks like this:
8001 .code
8002 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8003 .endd
8004 In other words, instead of supplying a host name, a path to the socket is
8005 given. The path name is enclosed in parentheses so that its slashes aren't
8006 visually confused with the delimiters for the other server parameters.
8007
8008 If a PostgreSQL query is issued that does not request any data (an insert,
8009 update, or delete command), the result of the lookup is the number of rows
8010 affected.
8011
8012 .section "More about SQLite" "SECTsqlite"
8013 .cindex "lookup" "SQLite"
8014 .cindex "sqlite lookup type"
8015 SQLite is different to the other SQL lookups because a filename is required in
8016 addition to the SQL query. An SQLite database is a single file, and there is no
8017 daemon as in the other SQL databases. The interface to Exim requires the name
8018 of the file, as an absolute path, to be given at the start of the query. It is
8019 separated from the query by white space. This means that the path name cannot
8020 contain white space. Here is a lookup expansion example:
8021 .code
8022 ${lookup sqlite {/some/thing/sqlitedb \
8023   select name from aliases where id='userx';}}
8024 .endd
8025 In a list, the syntax is similar. For example:
8026 .code
8027 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8028    select * from relays where ip='$sender_host_address';
8029 .endd
8030 The only character affected by the &%quote_sqlite%& operator is a single
8031 quote, which it doubles.
8032
8033 .cindex timeout SQLite
8034 .cindex sqlite "lookup timeout"
8035 The SQLite library handles multiple simultaneous accesses to the database
8036 internally. Multiple readers are permitted, but only one process can
8037 update at once. Attempts to access the database while it is being updated
8038 are rejected after a timeout period, during which the SQLite library
8039 waits for the lock to be released. In Exim, the default timeout is set
8040 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8041 option.
8042
8043 .section "More about Redis" "SECTredis"
8044 .cindex "lookup" "Redis"
8045 .cindex "redis lookup type"
8046 Redis is a non-SQL database. Commands are simple get and set.
8047 Examples:
8048 .code
8049 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8050 ${lookup redis{get keyname}}
8051 .endd
8052
8053 As of release 4.91, "lightweight" support for Redis Cluster is available.
8054 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8055 of which must be reachable from the running exim instance. If the cluster has
8056 master/slave replication, the list must contain all the master and slave
8057 servers.
8058
8059 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8060 immediately follow the redirection but treats the response as a DEFER, moving on
8061 to the next server in the &%redis_servers%& list until the correct server is
8062 reached.
8063
8064 .ecindex IIDfidalo1
8065 .ecindex IIDfidalo2
8066
8067
8068 . ////////////////////////////////////////////////////////////////////////////
8069 . ////////////////////////////////////////////////////////////////////////////
8070
8071 .chapter "Domain, host, address, and local part lists" &&&
8072          "CHAPdomhosaddlists" &&&
8073          "Domain, host, and address lists"
8074 .scindex IIDdohoadli "lists of domains; hosts; etc."
8075 A number of Exim configuration options contain lists of domains, hosts,
8076 email addresses, or local parts. For example, the &%hold_domains%& option
8077 contains a list of domains whose delivery is currently suspended. These lists
8078 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8079 arguments to expansion conditions such as &%match_domain%&.
8080
8081 Each item in one of these lists is a pattern to be matched against a domain,
8082 host, email address, or local part, respectively. In the sections below, the
8083 different types of pattern for each case are described, but first we cover some
8084 general facilities that apply to all four kinds of list.
8085
8086 Note that other parts of Exim use a &'string list'& which does not
8087 support all the complexity available in
8088 domain, host, address and local part lists.
8089
8090
8091
8092 .section "Expansion of lists" "SECTlistexpand"
8093 .cindex "expansion" "of lists"
8094 Each list is expanded as a single string before it is used.
8095
8096 &'Exception: the router headers_remove option, where list-item
8097 splitting is done before string-expansion.'&
8098
8099 The result of
8100 expansion must be a list, possibly containing empty items, which is split up
8101 into separate items for matching. By default, colon is the separator character,
8102 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8103 &<<SECTempitelis>>& for details of the list syntax; the second of these
8104 discusses the way to specify empty list items.
8105
8106
8107 If the string expansion is forced to fail, Exim behaves as if the item it is
8108 testing (domain, host, address, or local part) is not in the list. Other
8109 expansion failures cause temporary errors.
8110
8111 If an item in a list is a regular expression, backslashes, dollars and possibly
8112 other special characters in the expression must be protected against
8113 misinterpretation by the string expander. The easiest way to do this is to use
8114 the &`\N`& expansion feature to indicate that the contents of the regular
8115 expression should not be expanded. For example, in an ACL you might have:
8116 .code
8117 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8118                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8119 .endd
8120 The first item is a regular expression that is protected from expansion by
8121 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8122 senders based on the receiving domain.
8123
8124
8125
8126
8127 .section "Negated items in lists" "SECID76"
8128 .cindex "list" "negation"
8129 .cindex "negation" "in lists"
8130 Items in a list may be positive or negative. Negative items are indicated by a
8131 leading exclamation mark, which may be followed by optional white space. A list
8132 defines a set of items (domains, etc). When Exim processes one of these lists,
8133 it is trying to find out whether a domain, host, address, or local part
8134 (respectively) is in the set that is defined by the list. It works like this:
8135
8136 The list is scanned from left to right. If a positive item is matched, the
8137 subject that is being checked is in the set; if a negative item is matched, the
8138 subject is not in the set. If the end of the list is reached without the
8139 subject having matched any of the patterns, it is in the set if the last item
8140 was a negative one, but not if it was a positive one. For example, the list in
8141 .code
8142 domainlist relay_to_domains = !a.b.c : *.b.c
8143 .endd
8144 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8145 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8146 list is positive. However, if the setting were
8147 .code
8148 domainlist relay_to_domains = !a.b.c
8149 .endd
8150 then all domains other than &'a.b.c'& would match because the last item in the
8151 list is negative. In other words, a list that ends with a negative item behaves
8152 as if it had an extra item &`:*`& on the end.
8153
8154 Another way of thinking about positive and negative items in lists is to read
8155 the connector as &"or"& after a positive item and as &"and"& after a negative
8156 item.
8157
8158
8159
8160 .section "File names in lists" "SECTfilnamlis"
8161 .cindex "list" "filename in"
8162 If an item in a domain, host, address, or local part list is an absolute
8163 filename (beginning with a slash character), each line of the file is read and
8164 processed as if it were an independent item in the list, except that further
8165 filenames are not allowed,
8166 and no expansion of the data from the file takes place.
8167 Empty lines in the file are ignored, and the file may also contain comment
8168 lines:
8169
8170 .ilist
8171 For domain and host lists, if a # character appears anywhere in a line of the
8172 file, it and all following characters are ignored.
8173 .next
8174 Because local parts may legitimately contain # characters, a comment in an
8175 address list or local part list file is recognized only if # is preceded by
8176 white space or the start of the line. For example:
8177 .code
8178 not#comment@x.y.z   # but this is a comment
8179 .endd
8180 .endlist
8181
8182 Putting a filename in a list has the same effect as inserting each line of the
8183 file as an item in the list (blank lines and comments excepted). However, there
8184 is one important difference: the file is read each time the list is processed,
8185 so if its contents vary over time, Exim's behaviour changes.
8186
8187 If a filename is preceded by an exclamation mark, the sense of any match
8188 within the file is inverted. For example, if
8189 .code
8190 hold_domains = !/etc/nohold-domains
8191 .endd
8192 and the file contains the lines
8193 .code
8194 !a.b.c
8195 *.b.c
8196 .endd
8197 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8198 any domain matching &`*.b.c`& is not.
8199
8200
8201
8202 .section "An lsearch file is not an out-of-line list" "SECID77"
8203 As will be described in the sections that follow, lookups can be used in lists
8204 to provide indexed methods of checking list membership. There has been some
8205 confusion about the way &(lsearch)& lookups work in lists. Because
8206 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8207 sometimes thought that it is allowed to contain wild cards and other kinds of
8208 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8209 always fixed strings, just as for any other single-key lookup type.
8210
8211 If you want to use a file to contain wild-card patterns that form part of a
8212 list, just give the filename on its own, without a search type, as described
8213 in the previous section. You could also use the &(wildlsearch)& or
8214 &(nwildlsearch)&, but there is no advantage in doing this.
8215
8216
8217
8218
8219 .section "Named lists" "SECTnamedlists"
8220 .cindex "named lists"
8221 .cindex "list" "named"
8222 A list of domains, hosts, email addresses, or local parts can be given a name
8223 which is then used to refer to the list elsewhere in the configuration. This is
8224 particularly convenient if the same list is required in several different
8225 places. It also allows lists to be given meaningful names, which can improve
8226 the readability of the configuration. For example, it is conventional to define
8227 a domain list called &'local_domains'& for all the domains that are handled
8228 locally on a host, using a configuration line such as
8229 .code
8230 domainlist local_domains = localhost:my.dom.example
8231 .endd
8232 Named lists are referenced by giving their name preceded by a plus sign, so,
8233 for example, a router that is intended to handle local domains would be
8234 configured with the line
8235 .code
8236 domains = +local_domains
8237 .endd
8238 The first router in a configuration is often one that handles all domains
8239 except the local ones, using a configuration with a negated item like this:
8240 .code
8241 dnslookup:
8242   driver = dnslookup
8243   domains = ! +local_domains
8244   transport = remote_smtp
8245   no_more
8246 .endd
8247 The four kinds of named list are created by configuration lines starting with
8248 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8249 respectively. Then there follows the name that you are defining, followed by an
8250 equals sign and the list itself. For example:
8251 .code
8252 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8253 addresslist bad_senders = cdb;/etc/badsenders
8254 .endd
8255 A named list may refer to other named lists:
8256 .code
8257 domainlist  dom1 = first.example : second.example
8258 domainlist  dom2 = +dom1 : third.example
8259 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8260 .endd
8261 &*Warning*&: If the last item in a referenced list is a negative one, the
8262 effect may not be what you intended, because the negation does not propagate
8263 out to the higher level. For example, consider:
8264 .code
8265 domainlist  dom1 = !a.b
8266 domainlist  dom2 = +dom1 : *.b
8267 .endd
8268 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8269 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8270 means it matches the second list as well. The effect is not the same as
8271 .code
8272 domainlist  dom2 = !a.b : *.b
8273 .endd
8274 where &'x.y'& does not match. It's best to avoid negation altogether in
8275 referenced lists if you can.
8276
8277 Named lists may have a performance advantage. When Exim is routing an
8278 address or checking an incoming message, it caches the result of tests on named
8279 lists. So, if you have a setting such as
8280 .code
8281 domains = +local_domains
8282 .endd
8283 on several of your routers
8284 or in several ACL statements,
8285 the actual test is done only for the first one. However, the caching works only
8286 if there are no expansions within the list itself or any sublists that it
8287 references. In other words, caching happens only for lists that are known to be
8288 the same each time they are referenced.
8289
8290 By default, there may be up to 16 named lists of each type. This limit can be
8291 extended by changing a compile-time variable. The use of domain and host lists
8292 is recommended for concepts such as local domains, relay domains, and relay
8293 hosts. The default configuration is set up like this.
8294
8295
8296
8297 .section "Named lists compared with macros" "SECID78"
8298 .cindex "list" "named compared with macro"
8299 .cindex "macro" "compared with named list"
8300 At first sight, named lists might seem to be no different from macros in the
8301 configuration file. However, macros are just textual substitutions. If you
8302 write
8303 .code
8304 ALIST = host1 : host2
8305 auth_advertise_hosts = !ALIST
8306 .endd
8307 it probably won't do what you want, because that is exactly the same as
8308 .code
8309 auth_advertise_hosts = !host1 : host2
8310 .endd
8311 Notice that the second host name is not negated. However, if you use a host
8312 list, and write
8313 .code
8314 hostlist alist = host1 : host2
8315 auth_advertise_hosts = ! +alist
8316 .endd
8317 the negation applies to the whole list, and so that is equivalent to
8318 .code
8319 auth_advertise_hosts = !host1 : !host2
8320 .endd
8321
8322
8323 .section "Named list caching" "SECID79"
8324 .cindex "list" "caching of named"
8325 .cindex "caching" "named lists"
8326 While processing a message, Exim caches the result of checking a named list if
8327 it is sure that the list is the same each time. In practice, this means that
8328 the cache operates only if the list contains no $ characters, which guarantees
8329 that it will not change when it is expanded. Sometimes, however, you may have
8330 an expanded list that you know will be the same each time within a given
8331 message. For example:
8332 .code
8333 domainlist special_domains = \
8334            ${lookup{$sender_host_address}cdb{/some/file}}
8335 .endd
8336 This provides a list of domains that depends only on the sending host's IP
8337 address. If this domain list is referenced a number of times (for example,
8338 in several ACL lines, or in several routers) the result of the check is not
8339 cached by default, because Exim does not know that it is going to be the
8340 same list each time.
8341
8342 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8343 cache the result anyway. For example:
8344 .code
8345 domainlist_cache special_domains = ${lookup{...
8346 .endd
8347 If you do this, you should be absolutely sure that caching is going to do
8348 the right thing in all cases. When in doubt, leave it out.
8349
8350
8351
8352 .section "Domain lists" "SECTdomainlist"
8353 .cindex "domain list" "patterns for"
8354 .cindex "list" "domain list"
8355 Domain lists contain patterns that are to be matched against a mail domain.
8356 The following types of item may appear in domain lists:
8357
8358 .ilist
8359 .cindex "primary host name"
8360 .cindex "host name" "matched in domain list"
8361 .oindex "&%primary_hostname%&"
8362 .cindex "domain list" "matching primary host name"
8363 .cindex "@ in a domain list"
8364 If a pattern consists of a single @ character, it matches the local host name,
8365 as set by the &%primary_hostname%& option (or defaulted). This makes it
8366 possible to use the same configuration file on several different hosts that
8367 differ only in their names.
8368 .next
8369 .cindex "@[] in a domain list"
8370 .cindex "domain list" "matching local IP interfaces"
8371 .cindex "domain literal"
8372 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8373 in square brackets (as in an email address that contains a domain literal), but
8374 only if that IP address is recognized as local for email routing purposes. The
8375 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8376 control which of a host's several IP addresses are treated as local.
8377 In today's Internet, the use of domain literals is controversial.
8378 .next
8379 .cindex "@mx_any"
8380 .cindex "@mx_primary"
8381 .cindex "@mx_secondary"
8382 .cindex "domain list" "matching MX pointers to local host"
8383 If a pattern consists of the string &`@mx_any`& it matches any domain that
8384 has an MX record pointing to the local host or to any host that is listed in
8385 .oindex "&%hosts_treat_as_local%&"
8386 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8387 are similar, except that the first matches only when a primary MX target is the
8388 local host, and the second only when no primary MX target is the local host,
8389 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8390 preference value &-- there may of course be more than one of them.
8391
8392 The MX lookup that takes place when matching a pattern of this type is
8393 performed with the resolver options for widening names turned off. Thus, for
8394 example, a single-component domain will &'not'& be expanded by adding the
8395 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8396 options of the &(dnslookup)& router for a discussion of domain widening.
8397
8398 Sometimes you may want to ignore certain IP addresses when using one of these
8399 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8400 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8401 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8402 on a router). For example:
8403 .code
8404 domains = @mx_any/ignore=127.0.0.1
8405 .endd
8406 This example matches any domain that has an MX record pointing to one of
8407 the local host's IP addresses other than 127.0.0.1.
8408
8409 The list of IP addresses is in fact processed by the same code that processes
8410 host lists, so it may contain CIDR-coded network specifications and it may also
8411 contain negative items.
8412
8413 Because the list of IP addresses is a sublist within a domain list, you have to
8414 be careful about delimiters if there is more than one address. Like any other
8415 list, the default delimiter can be changed. Thus, you might have:
8416 .code
8417 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8418           an.other.domain : ...
8419 .endd
8420 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8421 involved, it is easiest to change the delimiter for the main list as well:
8422 .code
8423 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8424           an.other.domain ? ...
8425 .endd
8426 .next
8427 .cindex "asterisk" "in domain list"
8428 .cindex "domain list" "asterisk in"
8429 .cindex "domain list" "matching &""ends with""&"
8430 If a pattern starts with an asterisk, the remaining characters of the pattern
8431 are compared with the terminating characters of the domain. The use of &"*"& in
8432 domain lists differs from its use in partial matching lookups. In a domain
8433 list, the character following the asterisk need not be a dot, whereas partial
8434 matching works only in terms of dot-separated components. For example, a domain
8435 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8436 &'cipher.key.ex'&.
8437
8438 .next
8439 .cindex "regular expressions" "in domain list"
8440 .cindex "domain list" "matching regular expression"
8441 If a pattern starts with a circumflex character, it is treated as a regular
8442 expression, and matched against the domain using a regular expression matching
8443 function. The circumflex is treated as part of the regular expression.
8444 Email domains are case-independent, so this regular expression match is by
8445 default case-independent, but you can make it case-dependent by starting it
8446 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8447 are given in chapter &<<CHAPregexp>>&.
8448
8449 &*Warning*&: Because domain lists are expanded before being processed, you
8450 must escape any backslash and dollar characters in the regular expression, or
8451 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8452 it is not to be expanded (unless you really do want to build a regular
8453 expression by expansion, of course).
8454 .next
8455 .cindex "lookup" "in domain list"
8456 .cindex "domain list" "matching by lookup"
8457 If a pattern starts with the name of a single-key lookup type followed by a
8458 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8459 must be a filename in a suitable format for the lookup type. For example, for
8460 &"cdb;"& it must be an absolute path:
8461 .code
8462 domains = cdb;/etc/mail/local_domains.cdb
8463 .endd
8464 The appropriate type of lookup is done on the file using the domain name as the
8465 key. In most cases, the data that is looked up is not used; Exim is interested
8466 only in whether or not the key is present in the file. However, when a lookup
8467 is used for the &%domains%& option on a router
8468 or a &%domains%& condition in an ACL statement, the data is preserved in the
8469 &$domain_data$& variable and can be referred to in other router options or
8470 other statements in the same ACL.
8471
8472 .next
8473 Any of the single-key lookup type names may be preceded by
8474 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8475 .code
8476 domains = partial-dbm;/partial/domains
8477 .endd
8478 This causes partial matching logic to be invoked; a description of how this
8479 works is given in section &<<SECTpartiallookup>>&.
8480
8481 .next
8482 .cindex "asterisk" "in lookup type"
8483 Any of the single-key lookup types may be followed by an asterisk. This causes
8484 a default lookup for a key consisting of a single asterisk to be done if the
8485 original lookup fails. This is not a useful feature when using a domain list to
8486 select particular domains (because any domain would match), but it might have
8487 value if the result of the lookup is being used via the &$domain_data$&
8488 expansion variable.
8489 .next
8490 If the pattern starts with the name of a query-style lookup type followed by a
8491 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8492 pattern must be an appropriate query for the lookup type, as described in
8493 chapter &<<CHAPfdlookup>>&. For example:
8494 .code
8495 hold_domains = mysql;select domain from holdlist \
8496   where domain = '${quote_mysql:$domain}';
8497 .endd
8498 In most cases, the data that is looked up is not used (so for an SQL query, for
8499 example, it doesn't matter what field you select). Exim is interested only in
8500 whether or not the query succeeds. However, when a lookup is used for the
8501 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8502 variable and can be referred to in other options.
8503 .next
8504 .cindex "domain list" "matching literal domain name"
8505 If none of the above cases apply, a caseless textual comparison is made
8506 between the pattern and the domain.
8507 .endlist
8508
8509 Here is an example that uses several different kinds of pattern:
8510 .code
8511 domainlist funny_domains = \
8512   @ : \
8513   lib.unseen.edu : \
8514   *.foundation.fict.example : \
8515   \N^[1-2]\d{3}\.fict\.example$\N : \
8516   partial-dbm;/opt/data/penguin/book : \
8517   nis;domains.byname : \
8518   nisplus;[name=$domain,status=local],domains.org_dir
8519 .endd
8520 There are obvious processing trade-offs among the various matching modes. Using
8521 an asterisk is faster than a regular expression, and listing a few names
8522 explicitly probably is too. The use of a file or database lookup is expensive,
8523 but may be the only option if hundreds of names are required. Because the
8524 patterns are tested in order, it makes sense to put the most commonly matched
8525 patterns earlier.
8526
8527
8528
8529 .section "Host lists" "SECThostlist"
8530 .cindex "host list" "patterns in"
8531 .cindex "list" "host list"
8532 Host lists are used to control what remote hosts are allowed to do. For
8533 example, some hosts may be allowed to use the local host as a relay, and some
8534 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8535 two different ways, by name or by IP address. In a host list, some types of
8536 pattern are matched to a host name, and some are matched to an IP address.
8537 You need to be particularly careful with this when single-key lookups are
8538 involved, to ensure that the right value is being used as the key.
8539
8540
8541 .section "Special host list patterns" "SECID80"
8542 .cindex "empty item in hosts list"
8543 .cindex "host list" "empty string in"
8544 If a host list item is the empty string, it matches only when no remote host is
8545 involved. This is the case when a message is being received from a local
8546 process using SMTP on the standard input, that is, when a TCP/IP connection is
8547 not used.
8548
8549 .cindex "asterisk" "in host list"
8550 The special pattern &"*"& in a host list matches any host or no host. Neither
8551 the IP address nor the name is actually inspected.
8552
8553
8554
8555 .section "Host list patterns that match by IP address" "SECThoslispatip"
8556 .cindex "host list" "matching IP addresses"
8557 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8558 the incoming address actually appears in the IPv6 host as
8559 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8560 list, it is converted into a traditional IPv4 address first. (Not all operating
8561 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8562 concerns.)
8563
8564 The following types of pattern in a host list check the remote host by
8565 inspecting its IP address:
8566
8567 .ilist
8568 If the pattern is a plain domain name (not a regular expression, not starting
8569 with *, not a lookup of any kind), Exim calls the operating system function
8570 to find the associated IP address(es). Exim uses the newer
8571 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8572 This typically causes a forward DNS lookup of the name. The result is compared
8573 with the IP address of the subject host.
8574
8575 If there is a temporary problem (such as a DNS timeout) with the host name
8576 lookup, a temporary error occurs. For example, if the list is being used in an
8577 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8578 temporary SMTP error code. If no IP address can be found for the host name,
8579 what happens is described in section &<<SECTbehipnot>>& below.
8580
8581 .next
8582 .cindex "@ in a host list"
8583 If the pattern is &"@"&, the primary host name is substituted and used as a
8584 domain name, as just described.
8585
8586 .next
8587 If the pattern is an IP address, it is matched against the IP address of the
8588 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8589 IPv6 addresses can be given in colon-separated format, but the colons have to
8590 be doubled so as not to be taken as item separators when the default list
8591 separator is used. IPv6 addresses are recognized even when Exim is compiled
8592 without IPv6 support. This means that if they appear in a host list on an
8593 IPv4-only host, Exim will not treat them as host names. They are just addresses
8594 that can never match a client host.
8595
8596 .next
8597 .cindex "@[] in a host list"
8598 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8599 the local host. For example, if the local host is an IPv4 host with one
8600 interface address 10.45.23.56, these two ACL statements have the same effect:
8601 .code
8602 accept hosts = 127.0.0.1 : 10.45.23.56
8603 accept hosts = @[]
8604 .endd
8605 .next
8606 .cindex "CIDR notation"
8607 If the pattern is an IP address followed by a slash and a mask length (for
8608 example 10.11.42.0/24), it is matched against the IP address of the subject
8609 host under the given mask. This allows, an entire network of hosts to be
8610 included (or excluded) by a single item. The mask uses CIDR notation; it
8611 specifies the number of address bits that must match, starting from the most
8612 significant end of the address.
8613
8614 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8615 of a range of addresses. It is the number of bits in the network portion of the
8616 address. The above example specifies a 24-bit netmask, so it matches all 256
8617 addresses in the 10.11.42.0 network. An item such as
8618 .code
8619 192.168.23.236/31
8620 .endd
8621 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8622 32 for an IPv4 address is the same as no mask at all; just a single address
8623 matches.
8624
8625 Here is another example which shows an IPv4 and an IPv6 network:
8626 .code
8627 recipient_unqualified_hosts = 192.168.0.0/16: \
8628                               3ffe::ffff::836f::::/48
8629 .endd
8630 The doubling of list separator characters applies only when these items
8631 appear inline in a host list. It is not required when indirecting via a file.
8632 For example:
8633 .code
8634 recipient_unqualified_hosts = /opt/exim/unqualnets
8635 .endd
8636 could make use of a file containing
8637 .code
8638 172.16.0.0/12
8639 3ffe:ffff:836f::/48
8640 .endd
8641 to have exactly the same effect as the previous example. When listing IPv6
8642 addresses inline, it is usually more convenient to use the facility for
8643 changing separator characters. This list contains the same two networks:
8644 .code
8645 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8646                                  3ffe:ffff:836f::/48
8647 .endd
8648 The separator is changed to semicolon by the leading &"<;"& at the start of the
8649 list.
8650 .endlist
8651
8652
8653
8654 .section "Host list patterns for single-key lookups by host address" &&&
8655          "SECThoslispatsikey"
8656 .cindex "host list" "lookup of IP address"
8657 When a host is to be identified by a single-key lookup of its complete IP
8658 address, the pattern takes this form:
8659 .display
8660 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8661 .endd
8662 For example:
8663 .code
8664 hosts_lookup = net-cdb;/hosts-by-ip.db
8665 .endd
8666 The text form of the IP address of the subject host is used as the lookup key.
8667 IPv6 addresses are converted to an unabbreviated form, using lower case
8668 letters, with dots as separators because colon is the key terminator in
8669 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8670 quoting the keys, but this is a facility that was added later.] The data
8671 returned by the lookup is not used.
8672
8673 .cindex "IP address" "masking"
8674 .cindex "host list" "masked IP address"
8675 Single-key lookups can also be performed using masked IP addresses, using
8676 patterns of this form:
8677 .display
8678 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8679 .endd
8680 For example:
8681 .code
8682 net24-dbm;/networks.db
8683 .endd
8684 The IP address of the subject host is masked using <&'number'&> as the mask
8685 length. A textual string is constructed from the masked value, followed by the
8686 mask, and this is used as the lookup key. For example, if the host's IP address
8687 is 192.168.34.6, the key that is looked up for the above example is
8688 &"192.168.34.0/24"&.
8689
8690 When an IPv6 address is converted to a string, dots are normally used instead
8691 of colons, so that keys in &(lsearch)& files need not contain colons (which
8692 terminate &(lsearch)& keys). This was implemented some time before the ability
8693 to quote keys was made available in &(lsearch)& files. However, the more
8694 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8695 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8696 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8697 converted using colons and not dots.
8698 .new
8699 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8700 addresses are always used.
8701 The latter are converted to IPv4 addresses, in dotted-quad form.
8702 .wen
8703
8704 Ideally, it would be nice to tidy up this anomalous situation by changing to
8705 colons in all cases, given that quoting is now available for &(lsearch)&.
8706 However, this would be an incompatible change that might break some existing
8707 configurations.
8708
8709 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8710 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8711 the former case the key strings include the mask value, whereas in the latter
8712 case the IP address is used on its own.
8713
8714
8715
8716 .section "Host list patterns that match by host name" "SECThoslispatnam"
8717 .cindex "host" "lookup failures"
8718 .cindex "unknown host name"
8719 .cindex "host list" "matching host name"
8720 There are several types of pattern that require Exim to know the name of the
8721 remote host. These are either wildcard patterns or lookups by name. (If a
8722 complete hostname is given without any wildcarding, it is used to find an IP
8723 address to match against, as described in section &<<SECThoslispatip>>&
8724 above.)
8725
8726 If the remote host name is not already known when Exim encounters one of these
8727 patterns, it has to be found from the IP address.
8728 Although many sites on the Internet are conscientious about maintaining reverse
8729 DNS data for their hosts, there are also many that do not do this.
8730 Consequently, a name cannot always be found, and this may lead to unwanted
8731 effects. Take care when configuring host lists with wildcarded name patterns.
8732 Consider what will happen if a name cannot be found.
8733
8734 Because of the problems of determining host names from IP addresses, matching
8735 against host names is not as common as matching against IP addresses.
8736
8737 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8738 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8739 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8740 are done can be changed by setting the &%host_lookup_order%& option. For
8741 security, once Exim has found one or more names, it looks up the IP addresses
8742 for these names and compares them with the IP address that it started with.
8743 Only those names whose IP addresses match are accepted. Any other names are
8744 discarded. If no names are left, Exim behaves as if the host name cannot be
8745 found. In the most common case there is only one name and one IP address.
8746
8747 There are some options that control what happens if a host name cannot be
8748 found. These are described in section &<<SECTbehipnot>>& below.
8749
8750 .cindex "host" "alias for"
8751 .cindex "alias for host"
8752 As a result of aliasing, hosts may have more than one name. When processing any
8753 of the following types of pattern, all the host's names are checked:
8754
8755 .ilist
8756 .cindex "asterisk" "in host list"
8757 If a pattern starts with &"*"& the remainder of the item must match the end of
8758 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8759 &'.b.c'&. This special simple form is provided because this is a very common
8760 requirement. Other kinds of wildcarding require the use of a regular
8761 expression.
8762 .next
8763 .cindex "regular expressions" "in host list"
8764 .cindex "host list" "regular expression in"
8765 If the item starts with &"^"& it is taken to be a regular expression which is
8766 matched against the host name. Host names are case-independent, so this regular
8767 expression match is by default case-independent, but you can make it
8768 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8769 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8770 example,
8771 .code
8772 ^(a|b)\.c\.d$
8773 .endd
8774 is a regular expression that matches either of the two hosts &'a.c.d'& or
8775 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8776 that backslash and dollar characters are not misinterpreted as part of the
8777 string expansion. The simplest way to do this is to use &`\N`& to mark that
8778 part of the string as non-expandable. For example:
8779 .code
8780 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8781 .endd
8782 &*Warning*&: If you want to match a complete host name, you must include the
8783 &`$`& terminating metacharacter in the regular expression, as in the above
8784 example. Without it, a match at the start of the host name is all that is
8785 required.
8786 .endlist
8787
8788
8789
8790
8791 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8792 .cindex "host" "lookup failures, permanent"
8793 While processing a host list, Exim may need to look up an IP address from a
8794 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8795 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8796 behaviour when it fails to find the information it is seeking is the same.
8797
8798 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8799 apply to temporary DNS errors, whose handling is described in the next section.
8800
8801 .cindex "&`+include_unknown`&"
8802 .cindex "&`+ignore_unknown`&"
8803 Exim parses a host list from left to right. If it encounters a permanent
8804 lookup failure in any item in the host list before it has found a match,
8805 Exim treats it as a failure and the default behavior is as if the host
8806 does not match the list. This may not always be what you want to happen.
8807 To change Exim's behaviour, the special items &`+include_unknown`& or
8808 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8809 not recognized in an indirected file).
8810
8811 .ilist
8812 If any item that follows &`+include_unknown`& requires information that
8813 cannot found, Exim behaves as if the host does match the list. For example,
8814 .code
8815 host_reject_connection = +include_unknown:*.enemy.ex
8816 .endd
8817 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8818 any hosts whose name it cannot find.
8819
8820 .next
8821 If any item that follows &`+ignore_unknown`& requires information that cannot
8822 be found, Exim ignores that item and proceeds to the rest of the list. For
8823 example:
8824 .code
8825 accept hosts = +ignore_unknown : friend.example : \
8826                192.168.4.5
8827 .endd
8828 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8829 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8830 name can be found for 192.168.4.5, it is rejected.
8831 .endlist
8832
8833 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8834 list. The effect of each one lasts until the next, or until the end of the
8835 list.
8836
8837 .section "Mixing wildcarded host names and addresses in host lists" &&&
8838          "SECTmixwilhos"
8839 .cindex "host list" "mixing names and addresses in"
8840
8841 This section explains the host/ip processing logic with the same concepts
8842 as the previous section, but specifically addresses what happens when a
8843 wildcarded hostname is one of the items in the hostlist.
8844
8845 .ilist
8846 If you have name lookups or wildcarded host names and
8847 IP addresses in the same host list, you should normally put the IP
8848 addresses first. For example, in an ACL you could have:
8849 .code
8850 accept hosts = 10.9.8.7 : *.friend.example
8851 .endd
8852 The reason you normally would order it this way lies in the
8853 left-to-right way that Exim processes lists.  It can test IP addresses
8854 without doing any DNS lookups, but when it reaches an item that requires
8855 a host name, it fails if it cannot find a host name to compare with the
8856 pattern. If the above list is given in the opposite order, the
8857 &%accept%& statement fails for a host whose name cannot be found, even
8858 if its IP address is 10.9.8.7.
8859
8860 .next
8861 If you really do want to do the name check first, and still recognize the IP
8862 address, you can rewrite the ACL like this:
8863 .code
8864 accept hosts = *.friend.example
8865 accept hosts = 10.9.8.7
8866 .endd
8867 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8868 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8869 &`+ignore_unknown`&, which was discussed in depth in the first example in
8870 this section.
8871 .endlist
8872
8873
8874 .section "Temporary DNS errors when looking up host information" &&&
8875          "SECTtemdnserr"
8876 .cindex "host" "lookup failures, temporary"
8877 .cindex "&`+include_defer`&"
8878 .cindex "&`+ignore_defer`&"
8879 A temporary DNS lookup failure normally causes a defer action (except when
8880 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8881 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8882 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8883 section. These options should be used with care, probably only in non-critical
8884 host lists such as whitelists.
8885
8886
8887
8888 .section "Host list patterns for single-key lookups by host name" &&&
8889          "SECThoslispatnamsk"
8890 .cindex "unknown host name"
8891 .cindex "host list" "matching host name"
8892 If a pattern is of the form
8893 .display
8894 <&'single-key-search-type'&>;<&'search-data'&>
8895 .endd
8896 for example
8897 .code
8898 dbm;/host/accept/list
8899 .endd
8900 a single-key lookup is performed, using the host name as its key. If the
8901 lookup succeeds, the host matches the item. The actual data that is looked up
8902 is not used.
8903
8904 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8905 keys in the file, not IP addresses. If you want to do lookups based on IP
8906 addresses, you must precede the search type with &"net-"& (see section
8907 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8908 two items in the same list, one doing an address lookup and one doing a name
8909 lookup, both using the same file.
8910
8911
8912
8913 .section "Host list patterns for query-style lookups" "SECID81"
8914 If a pattern is of the form
8915 .display
8916 <&'query-style-search-type'&>;<&'query'&>
8917 .endd
8918 the query is obeyed, and if it succeeds, the host matches the item. The actual
8919 data that is looked up is not used. The variables &$sender_host_address$& and
8920 &$sender_host_name$& can be used in the query. For example:
8921 .code
8922 hosts_lookup = pgsql;\
8923   select ip from hostlist where ip='$sender_host_address'
8924 .endd
8925 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8926 can use the &%sg%& expansion item to change this if you need to. If you want to
8927 use masked IP addresses in database queries, you can use the &%mask%& expansion
8928 operator.
8929
8930 If the query contains a reference to &$sender_host_name$&, Exim automatically
8931 looks up the host name if it has not already done so. (See section
8932 &<<SECThoslispatnam>>& for comments on finding host names.)
8933
8934 Historical note: prior to release 4.30, Exim would always attempt to find a
8935 host name before running the query, unless the search type was preceded by
8936 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8937 still recognized for query-style lookups, but its presence or absence has no
8938 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8939 See section &<<SECThoslispatsikey>>&.)
8940
8941
8942
8943
8944
8945 .section "Address lists" "SECTaddresslist"
8946 .cindex "list" "address list"
8947 .cindex "address list" "empty item"
8948 .cindex "address list" "patterns"
8949 Address lists contain patterns that are matched against mail addresses. There
8950 is one special case to be considered: the sender address of a bounce message is
8951 always empty. You can test for this by providing an empty item in an address
8952 list. For example, you can set up a router to process bounce messages by
8953 using this option setting:
8954 .code
8955 senders = :
8956 .endd
8957 The presence of the colon creates an empty item. If you do not provide any
8958 data, the list is empty and matches nothing. The empty sender can also be
8959 detected by a regular expression that matches an empty string,
8960 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8961
8962 Non-empty items in an address list can be straightforward email addresses. For
8963 example:
8964 .code
8965 senders = jbc@askone.example : hs@anacreon.example
8966 .endd
8967 A certain amount of wildcarding is permitted. If a pattern contains an @
8968 character, but is not a regular expression and does not begin with a
8969 semicolon-terminated lookup type (described below), the local part of the
8970 subject address is compared with the local part of the pattern, which may start
8971 with an asterisk. If the local parts match, the domain is checked in exactly
8972 the same way as for a pattern in a domain list. For example, the domain can be
8973 wildcarded, refer to a named list, or be a lookup:
8974 .code
8975 deny senders = *@*.spamming.site:\
8976                *@+hostile_domains:\
8977                bozo@partial-lsearch;/list/of/dodgy/sites:\
8978                *@dbm;/bad/domains.db
8979 .endd
8980 .cindex "local part" "starting with !"
8981 .cindex "address list" "local part starting with !"
8982 If a local part that begins with an exclamation mark is required, it has to be
8983 specified using a regular expression, because otherwise the exclamation mark is
8984 treated as a sign of negation, as is standard in lists.
8985
8986 If a non-empty pattern that is not a regular expression or a lookup does not
8987 contain an @ character, it is matched against the domain part of the subject
8988 address. The only two formats that are recognized this way are a literal
8989 domain, or a domain pattern that starts with *. In both these cases, the effect
8990 is the same as if &`*@`& preceded the pattern. For example:
8991 .code
8992 deny senders = enemy.domain : *.enemy.domain
8993 .endd
8994
8995 The following kinds of more complicated address list pattern can match any
8996 address, including the empty address that is characteristic of bounce message
8997 senders:
8998
8999 .ilist
9000 .cindex "regular expressions" "in address list"
9001 .cindex "address list" "regular expression in"
9002 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9003 done against the complete address, with the pattern as the regular expression.
9004 You must take care that backslash and dollar characters are not misinterpreted
9005 as part of the string expansion. The simplest way to do this is to use &`\N`&
9006 to mark that part of the string as non-expandable. For example:
9007 .code
9008 deny senders = \N^.*this.*@example\.com$\N : \
9009                \N^\d{8}.+@spamhaus.example$\N : ...
9010 .endd
9011 The &`\N`& sequences are removed by the expansion, so these items do indeed
9012 start with &"^"& by the time they are being interpreted as address patterns.
9013
9014 .next
9015 .cindex "address list" "lookup for complete address"
9016 Complete addresses can be looked up by using a pattern that starts with a
9017 lookup type terminated by a semicolon, followed by the data for the lookup. For
9018 example:
9019 .code
9020 deny senders = cdb;/etc/blocked.senders : \
9021   mysql;select address from blocked where \
9022   address='${quote_mysql:$sender_address}'
9023 .endd
9024 Both query-style and single-key lookup types can be used. For a single-key
9025 lookup type, Exim uses the complete address as the key. However, empty keys are
9026 not supported for single-key lookups, so a match against the empty address
9027 always fails. This restriction does not apply to query-style lookups.
9028
9029 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9030 cannot be used, and is ignored if specified, with an entry being written to the
9031 panic log.
9032 .cindex "*@ with single-key lookup"
9033 However, you can configure lookup defaults, as described in section
9034 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9035 default. For example, with this lookup:
9036 .code
9037 accept senders = lsearch*@;/some/file
9038 .endd
9039 the file could contains lines like this:
9040 .code
9041 user1@domain1.example
9042 *@domain2.example
9043 .endd
9044 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9045 that are tried is:
9046 .code
9047 nimrod@jaeger.example
9048 *@jaeger.example
9049 *
9050 .endd
9051 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9052 would mean that every address matches, thus rendering the test useless.
9053
9054 &*Warning 2*&: Do not confuse these two kinds of item:
9055 .code
9056 deny recipients = dbm*@;/some/file
9057 deny recipients = *@dbm;/some/file
9058 .endd
9059 The first does a whole address lookup, with defaulting, as just described,
9060 because it starts with a lookup type. The second matches the local part and
9061 domain independently, as described in a bullet point below.
9062 .endlist
9063
9064
9065 The following kinds of address list pattern can match only non-empty addresses.
9066 If the subject address is empty, a match against any of these pattern types
9067 always fails.
9068
9069
9070 .ilist
9071 .cindex "@@ with single-key lookup"
9072 .cindex "address list" "@@ lookup type"
9073 .cindex "address list" "split local part and domain"
9074 If a pattern starts with &"@@"& followed by a single-key lookup item
9075 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9076 split into a local part and a domain. The domain is looked up in the file. If
9077 it is not found, there is no match. If it is found, the data that is looked up
9078 from the file is treated as a colon-separated list of local part patterns, each
9079 of which is matched against the subject local part in turn.
9080
9081 .cindex "asterisk" "in address list"
9082 The lookup may be a partial one, and/or one involving a search for a default
9083 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9084 patterns that are looked up can be regular expressions or begin with &"*"&, or
9085 even be further lookups. They may also be independently negated. For example,
9086 with
9087 .code
9088 deny senders = @@dbm;/etc/reject-by-domain
9089 .endd
9090 the data from which the DBM file is built could contain lines like
9091 .code
9092 baddomain.com:  !postmaster : *
9093 .endd
9094 to reject all senders except &%postmaster%& from that domain.
9095
9096 .cindex "local part" "starting with !"
9097 If a local part that actually begins with an exclamation mark is required, it
9098 has to be specified using a regular expression. In &(lsearch)& files, an entry
9099 may be split over several lines by indenting the second and subsequent lines,
9100 but the separating colon must still be included at line breaks. White space
9101 surrounding the colons is ignored. For example:
9102 .code
9103 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9104   spammer3 : spammer4
9105 .endd
9106 As in all colon-separated lists in Exim, a colon can be included in an item by
9107 doubling.
9108
9109 If the last item in the list starts with a right angle-bracket, the remainder
9110 of the item is taken as a new key to look up in order to obtain a continuation
9111 list of local parts. The new key can be any sequence of characters. Thus one
9112 might have entries like
9113 .code
9114 aol.com: spammer1 : spammer 2 : >*
9115 xyz.com: spammer3 : >*
9116 *:       ^\d{8}$
9117 .endd
9118 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9119 local parts for all domains, in addition to the specific local parts listed for
9120 each domain. Of course, using this feature costs another lookup each time a
9121 chain is followed, but the effort needed to maintain the data is reduced.
9122
9123 .cindex "loop" "in lookups"
9124 It is possible to construct loops using this facility, and in order to catch
9125 them, the chains may be no more than fifty items long.
9126
9127 .next
9128 The @@<&'lookup'&> style of item can also be used with a query-style
9129 lookup, but in this case, the chaining facility is not available. The lookup
9130 can only return a single list of local parts.
9131 .endlist
9132
9133 &*Warning*&: There is an important difference between the address list items
9134 in these two examples:
9135 .code
9136 senders = +my_list
9137 senders = *@+my_list
9138 .endd
9139 In the first one, &`my_list`& is a named address list, whereas in the second
9140 example it is a named domain list.
9141
9142
9143
9144
9145 .section "Case of letters in address lists" "SECTcasletadd"
9146 .cindex "case of local parts"
9147 .cindex "address list" "case forcing"
9148 .cindex "case forcing in address lists"
9149 Domains in email addresses are always handled caselessly, but for local parts
9150 case may be significant on some systems (see &%caseful_local_part%& for how
9151 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9152 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9153 blocking lists should be done in a case-independent manner. Since most address
9154 lists in Exim are used for this kind of control, Exim attempts to do this by
9155 default.
9156
9157 The domain portion of an address is always lowercased before matching it to an
9158 address list. The local part is lowercased by default, and any string
9159 comparisons that take place are done caselessly. This means that the data in
9160 the address list itself, in files included as plain filenames, and in any file
9161 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9162 keys in files that are looked up by a search type other than &(lsearch)& (which
9163 works caselessly) must be in lower case, because these lookups are not
9164 case-independent.
9165
9166 .cindex "&`+caseful`&"
9167 To allow for the possibility of caseful address list matching, if an item in
9168 an address list is the string &"+caseful"&, the original case of the local
9169 part is restored for any comparisons that follow, and string comparisons are no
9170 longer case-independent. This does not affect the domain, which remains in
9171 lower case. However, although independent matches on the domain alone are still
9172 performed caselessly, regular expressions that match against an entire address
9173 become case-sensitive after &"+caseful"& has been seen.
9174
9175
9176
9177 .section "Local part lists" "SECTlocparlis"
9178 .cindex "list" "local part list"
9179 .cindex "local part" "list"
9180 Case-sensitivity in local part lists is handled in the same way as for address
9181 lists, as just described. The &"+caseful"& item can be used if required. In a
9182 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9183 set false, the subject is lowercased and the matching is initially
9184 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9185 matching in the local part list, but not elsewhere in the router. If
9186 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9187 option is case-sensitive from the start.
9188
9189 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9190 comments are handled in the same way as address lists &-- they are recognized
9191 only if the # is preceded by white space or the start of the line.
9192 Otherwise, local part lists are matched in the same way as domain lists, except
9193 that the special items that refer to the local host (&`@`&, &`@[]`&,
9194 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9195 Refer to section &<<SECTdomainlist>>& for details of the other available item
9196 types.
9197 .ecindex IIDdohoadli
9198
9199
9200
9201
9202 . ////////////////////////////////////////////////////////////////////////////
9203 . ////////////////////////////////////////////////////////////////////////////
9204
9205 .chapter "String expansions" "CHAPexpand"
9206 .scindex IIDstrexp "expansion" "of strings"
9207 Many strings in Exim's runtime configuration are expanded before use. Some of
9208 them are expanded every time they are used; others are expanded only once.
9209
9210 When a string is being expanded it is copied verbatim from left to right except
9211 .cindex expansion "string concatenation"
9212 when a dollar or backslash character is encountered. A dollar specifies the
9213 start of a portion of the string that is interpreted and replaced as described
9214 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9215 escape character, as described in the following section.
9216
9217 Whether a string is expanded depends upon the context.  Usually this is solely
9218 dependent upon the option for which a value is sought; in this documentation,
9219 options for which string expansion is performed are marked with &dagger; after
9220 the data type.  ACL rules always expand strings.  A couple of expansion
9221 conditions do not expand some of the brace-delimited branches, for security
9222 reasons,
9223 .new
9224 .cindex "tainted data" expansion
9225 .cindex expansion "tainted data"
9226 and expansion of data deriving from the sender (&"tainted data"&)
9227 is not permitted.
9228 .wen
9229
9230
9231
9232 .section "Literal text in expanded strings" "SECTlittext"
9233 .cindex "expansion" "including literal text"
9234 An uninterpreted dollar can be included in an expanded string by putting a
9235 backslash in front of it. A backslash can be used to prevent any special
9236 character being treated specially in an expansion, including backslash itself.
9237 If the string appears in quotes in the configuration file, two backslashes are
9238 required because the quotes themselves cause interpretation of backslashes when
9239 the string is read in (see section &<<SECTstrings>>&).
9240
9241 .cindex "expansion" "non-expandable substrings"
9242 A portion of the string can specified as non-expandable by placing it between
9243 two occurrences of &`\N`&. This is particularly useful for protecting regular
9244 expressions, which often contain backslashes and dollar signs. For example:
9245 .code
9246 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9247 .endd
9248 On encountering the first &`\N`&, the expander copies subsequent characters
9249 without interpretation until it reaches the next &`\N`& or the end of the
9250 string.
9251
9252
9253
9254 .section "Character escape sequences in expanded strings" "SECID82"
9255 .cindex "expansion" "escape sequences"
9256 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9257 expanded string is recognized as an escape sequence for the character newline,
9258 carriage return, or tab, respectively. A backslash followed by up to three
9259 octal digits is recognized as an octal encoding for a single character, and a
9260 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9261 encoding.
9262
9263 These escape sequences are also recognized in quoted strings when they are read
9264 in. Their interpretation in expansions as well is useful for unquoted strings,
9265 and for other cases such as looked-up strings that are then expanded.
9266
9267
9268 .section "Testing string expansions" "SECID83"
9269 .cindex "expansion" "testing"
9270 .cindex "testing" "string expansion"
9271 .oindex "&%-be%&"
9272 Many expansions can be tested by calling Exim with the &%-be%& option. This
9273 takes the command arguments, or lines from the standard input if there are no
9274 arguments, runs them through the string expansion code, and writes the results
9275 to the standard output. Variables based on configuration values are set up, but
9276 since no message is being processed, variables such as &$local_part$& have no
9277 value. Nevertheless the &%-be%& option can be useful for checking out file and
9278 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9279 and &%nhash%&.
9280
9281 Exim gives up its root privilege when it is called with the &%-be%& option, and
9282 instead runs under the uid and gid it was called with, to prevent users from
9283 using &%-be%& for reading files to which they do not have access.
9284
9285 .oindex "&%-bem%&"
9286 If you want to test expansions that include variables whose values are taken
9287 from a message, there are two other options that can be used. The &%-bem%&
9288 option is like &%-be%& except that it is followed by a filename. The file is
9289 read as a message before doing the test expansions. For example:
9290 .code
9291 exim -bem /tmp/test.message '$h_subject:'
9292 .endd
9293 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9294 Exim message identifier. For example:
9295 .code
9296 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9297 .endd
9298 This loads the message from Exim's spool before doing the test expansions, and
9299 is therefore restricted to admin users.
9300
9301
9302 .section "Forced expansion failure" "SECTforexpfai"
9303 .cindex "expansion" "forced failure"
9304 A number of expansions that are described in the following section have
9305 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9306 (which are sometimes called &"curly brackets"&). Which of the two strings is
9307 used depends on some condition that is evaluated as part of the expansion. If,
9308 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9309 the entire string expansion fails in a way that can be detected by the code
9310 that requested the expansion. This is called &"forced expansion failure"&, and
9311 its consequences depend on the circumstances. In some cases it is no different
9312 from any other expansion failure, but in others a different action may be
9313 taken. Such variations are mentioned in the documentation of the option that is
9314 being expanded.
9315
9316
9317
9318
9319 .section "Expansion items" "SECTexpansionitems"
9320 The following items are recognized in expanded strings. White space may be used
9321 between sub-items that are keywords or substrings enclosed in braces inside an
9322 outer set of braces, to improve readability. &*Warning*&: Within braces,
9323 white space is significant.
9324
9325 .vlist
9326 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9327 .cindex "expansion" "variables"
9328 Substitute the contents of the named variable, for example:
9329 .code
9330 $local_part
9331 ${domain}
9332 .endd
9333 The second form can be used to separate the name from subsequent alphanumeric
9334 characters. This form (using braces) is available only for variables; it does
9335 &'not'& apply to message headers. The names of the variables are given in
9336 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9337 given, the expansion fails.
9338
9339 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9340 .cindex "expansion" "operators"
9341 The string is first itself expanded, and then the operation specified by
9342 <&'op'&> is applied to it. For example:
9343 .code
9344 ${lc:$local_part}
9345 .endd
9346 The string starts with the first character after the colon, which may be
9347 leading white space. A list of operators is given in section &<<SECTexpop>>&
9348 below. The operator notation is used for simple expansion items that have just
9349 one argument, because it reduces the number of braces and therefore makes the
9350 string easier to understand.
9351
9352 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9353 This item inserts &"basic"& header lines. It is described with the &%header%&
9354 expansion item below.
9355
9356
9357 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9358 .cindex "expansion" "calling an acl"
9359 .cindex "&%acl%&" "call from expansion"
9360 The name and zero to nine argument strings are first expanded separately.  The expanded
9361 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9362 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9363 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9364 and may use the variables; if another acl expansion is used the values
9365 are restored after it returns.  If the ACL sets
9366 a value using a "message =" modifier and returns accept or deny, the value becomes
9367 the result of the expansion.
9368 If no message is set and the ACL returns accept or deny
9369 the expansion result is an empty string.
9370 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9371
9372
9373 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9374 .cindex authentication "results header"
9375 .cindex headers "authentication-results:"
9376 .cindex authentication "expansion item"
9377 This item returns a string suitable for insertion as an
9378 &'Authentication-Results"'&
9379 header line.
9380 The given <&'authserv-id'&> is included in the result; typically this
9381 will be a domain name identifying the system performing the authentications.
9382 Methods that might be present in the result include:
9383 .code
9384 none
9385 iprev
9386 auth
9387 spf
9388 dkim
9389 .endd
9390
9391 Example use (as an ACL modifier):
9392 .code
9393       add_header = :at_start:${authresults {$primary_hostname}}
9394 .endd
9395 This is safe even if no authentication results are available.
9396
9397
9398 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9399        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9400 .cindex "expansion" "extracting certificate fields"
9401 .cindex "&%certextract%&" "certificate fields"
9402 .cindex "certificate" "extracting fields"
9403 The <&'certificate'&> must be a variable of type certificate.
9404 The field name is expanded and used to retrieve the relevant field from
9405 the certificate.  Supported fields are:
9406 .display
9407 &`version        `&
9408 &`serial_number  `&
9409 &`subject        `& RFC4514 DN
9410 &`issuer         `& RFC4514 DN
9411 &`notbefore      `& time
9412 &`notafter       `& time
9413 &`sig_algorithm  `&
9414 &`signature      `&
9415 &`subj_altname   `& tagged list
9416 &`ocsp_uri       `& list
9417 &`crl_uri        `& list
9418 .endd
9419 If the field is found,
9420 <&'string2'&> is expanded, and replaces the whole item;
9421 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9422 variable &$value$& contains the value that has been extracted. Afterwards, it
9423 is restored to any previous value it might have had.
9424
9425 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9426 key is not found. If {<&'string2'&>} is also omitted, the value that was
9427 extracted is used.
9428
9429 Some field names take optional modifiers, appended and separated by commas.
9430
9431 The field selectors marked as "RFC4514" above
9432 output a Distinguished Name string which is
9433 not quite
9434 parseable by Exim as a comma-separated tagged list
9435 (the exceptions being elements containing commas).
9436 RDN elements of a single type may be selected by
9437 a modifier of the type label; if so the expansion
9438 result is a list (newline-separated by default).
9439 The separator may be changed by another modifier of
9440 a right angle-bracket followed immediately by the new separator.
9441 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9442
9443 The field selectors marked as "time" above
9444 take an optional modifier of "int"
9445 for which the result is the number of seconds since epoch.
9446 Otherwise the result is a human-readable string
9447 in the timezone selected by the main "timezone" option.
9448
9449 The field selectors marked as "list" above return a list,
9450 newline-separated by default,
9451 (embedded separator characters in elements are doubled).
9452 The separator may be changed by a modifier of
9453 a right angle-bracket followed immediately by the new separator.
9454
9455 The field selectors marked as "tagged" above
9456 prefix each list element with a type string and an equals sign.
9457 Elements of only one type may be selected by a modifier
9458 which is one of "dns", "uri" or "mail";
9459 if so the element tags are omitted.
9460
9461 If not otherwise noted field values are presented in human-readable form.
9462
9463 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9464        {*&<&'arg'&>&*}...}*&"
9465 .cindex &%dlfunc%&
9466 This expansion dynamically loads and then calls a locally-written C function.
9467 This functionality is available only if Exim is compiled with
9468 .code
9469 EXPAND_DLFUNC=yes
9470 .endd
9471 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9472 object so that it doesn't reload the same object file in the same Exim process
9473 (but of course Exim does start new processes frequently).
9474
9475 There may be from zero to eight arguments to the function. When compiling
9476 a local function that is to be called in this way, &_local_scan.h_& should be
9477 included. The Exim variables and functions that are defined by that API
9478 are also available for dynamically loaded functions. The function itself
9479 must have the following type:
9480 .code
9481 int dlfunction(uschar **yield, int argc, uschar *argv[])
9482 .endd
9483 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9484 function should return one of the following values:
9485
9486 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9487 into the expanded string that is being built.
9488
9489 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9490 from &'yield'&, if it is set.
9491
9492 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9493 taken from &'yield'& if it is set.
9494
9495 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9496
9497 When compiling a function that is to be used in this way with gcc,
9498 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9499 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9500
9501
9502 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9503 .cindex "expansion" "extracting value from environment"
9504 .cindex "environment" "values from"
9505 The key is first expanded separately, and leading and trailing white space
9506 removed.
9507 This is then searched for as a name in the environment.
9508 If a variable is found then its value is placed in &$value$&
9509 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9510
9511 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9512 appear, for example:
9513 .code
9514 ${env{USER}{$value} fail }
9515 .endd
9516 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9517 {<&'string1'&>} must be present for &"fail"& to be recognized.
9518
9519 If {<&'string2'&>} is omitted an empty string is substituted on
9520 search failure.
9521 If {<&'string1'&>} is omitted the search result is substituted on
9522 search success.
9523
9524 The environment is adjusted by the &%keep_environment%& and
9525 &%add_environment%& main section options.
9526
9527
9528 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9529        {*&<&'string3'&>&*}}*&"
9530 .cindex "expansion" "extracting substrings by key"
9531 .cindex "&%extract%&" "substrings by key"
9532 The key and <&'string1'&> are first expanded separately. Leading and trailing
9533 white space is removed from the key (but not from any of the strings). The key
9534 must not be empty and must not consist entirely of digits.
9535 The expanded <&'string1'&> must be of the form:
9536 .display
9537 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9538 .endd
9539 .vindex "&$value$&"
9540 where the equals signs and spaces (but not both) are optional. If any of the
9541 values contain white space, they must be enclosed in double quotes, and any
9542 values that are enclosed in double quotes are subject to escape processing as
9543 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9544 for the value that corresponds to the key. The search is case-insensitive. If
9545 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9546 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9547 variable &$value$& contains the value that has been extracted. Afterwards, it
9548 is restored to any previous value it might have had.
9549
9550 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9551 key is not found. If {<&'string2'&>} is also omitted, the value that was
9552 extracted is used. Thus, for example, these two expansions are identical, and
9553 yield &"2001"&:
9554 .code
9555 ${extract{gid}{uid=1984 gid=2001}}
9556 ${extract{gid}{uid=1984 gid=2001}{$value}}
9557 .endd
9558 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9559 appear, for example:
9560 .code
9561 ${extract{Z}{A=... B=...}{$value} fail }
9562 .endd
9563 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9564 {<&'string2'&>} must be present for &"fail"& to be recognized.
9565
9566 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9567        {*&<&'string3'&>&*}}*&" &&&
9568        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9569        {*&<&'string3'&>&*}}*&"
9570 .cindex "expansion" "extracting from JSON object"
9571 .cindex JSON expansions
9572 The key and <&'string1'&> are first expanded separately. Leading and trailing
9573 white space is removed from the key (but not from any of the strings). The key
9574 must not be empty and must not consist entirely of digits.
9575 The expanded <&'string1'&> must be of the form:
9576 .display
9577 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9578 .endd
9579 .vindex "&$value$&"
9580 The braces, commas and colons, and the quoting of the member name are required;
9581 the spaces are optional.
9582 Matching of the key against the member names is done case-sensitively.
9583 For the &"json"& variant,
9584 if a returned value is a JSON string, it retains its leading and
9585 trailing quotes.
9586 .new
9587 For the &"jsons"& variant, which is intended for use with JSON strings, the
9588 leading and trailing quotes are removed from the returned value.
9589 .wen
9590 . XXX should be a UTF-8 compare
9591
9592 The results of matching are handled as above.
9593
9594
9595 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9596         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9597 .cindex "expansion" "extracting substrings by number"
9598 .cindex "&%extract%&" "substrings by number"
9599 The <&'number'&> argument must consist entirely of decimal digits,
9600 apart from leading and trailing white space, which is ignored.
9601 This is what distinguishes this form of &%extract%& from the previous kind. It
9602 behaves in the same way, except that, instead of extracting a named field, it
9603 extracts from <&'string1'&> the field whose number is given as the first
9604 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9605 <&'string3'&> as before.
9606
9607 The fields in the string are separated by any one of the characters in the
9608 separator string. These may include space or tab characters.
9609 The first field is numbered one. If the number is negative, the fields are
9610 counted from the end of the string, with the rightmost one numbered -1. If the
9611 number given is zero, the entire string is returned. If the modulus of the
9612 number is greater than the number of fields in the string, the result is the
9613 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9614 provided. For example:
9615 .code
9616 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9617 .endd
9618 yields &"42"&, and
9619 .code
9620 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9621 .endd
9622 yields &"99"&. Two successive separators mean that the field between them is
9623 empty (for example, the fifth field above).
9624
9625
9626 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9627         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9628        "&*${extract jsons{*&<&'number'&>&*}}&&&
9629         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9630 .cindex "expansion" "extracting from JSON array"
9631 .cindex JSON expansions
9632 The <&'number'&> argument must consist entirely of decimal digits,
9633 apart from leading and trailing white space, which is ignored.
9634
9635 Field selection and result handling is as above;
9636 there is no choice of field separator.
9637 For the &"json"& variant,
9638 if a returned value is a JSON string, it retains its leading and
9639 trailing quotes.
9640 .new
9641 For the &"jsons"& variant, which is intended for use with JSON strings, the
9642 leading and trailing quotes are removed from the returned value.
9643 .wen
9644
9645
9646 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9647 .cindex "list" "selecting by condition"
9648 .cindex "expansion" "selecting from list by condition"
9649 .vindex "&$item$&"
9650 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9651 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9652 For each item
9653 in this list, its value is place in &$item$&, and then the condition is
9654 evaluated. If the condition is true, &$item$& is added to the output as an
9655 item in a new list; if the condition is false, the item is discarded. The
9656 separator used for the output list is the same as the one used for the
9657 input, but a separator setting is not included in the output. For example:
9658 .code
9659 ${filter{a:b:c}{!eq{$item}{b}}}
9660 .endd
9661 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9662 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9663
9664
9665 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9666 .cindex "hash function" "textual"
9667 .cindex "expansion" "textual hash"
9668 This is a textual hashing function, and was the first to be implemented in
9669 early versions of Exim. In current releases, there are other hashing functions
9670 (numeric, MD5, and SHA-1), which are described below.
9671
9672 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9673 <&'n'&>. If you are using fixed values for these numbers, that is, if
9674 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9675 use the simpler operator notation that avoids some of the braces:
9676 .code
9677 ${hash_<n>_<m>:<string>}
9678 .endd
9679 The second number is optional (in both notations). If <&'n'&> is greater than
9680 or equal to the length of the string, the expansion item returns the string.
9681 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9682 function to the string. The new string consists of characters taken from the
9683 first <&'m'&> characters of the string
9684 .code
9685 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9686 .endd
9687 If <&'m'&> is not present the value 26 is used, so that only lower case
9688 letters appear. For example:
9689 .display
9690 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9691 &`$hash{5}{monty}}           `&   yields  &`monty`&
9692 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9693 .endd
9694
9695 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9696         &*$h_*&<&'header&~name'&>&*:*&" &&&
9697        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9698         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9699        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9700         &*$lh_*&<&'header&~name'&>&*:*&"
9701        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9702         &*$rh_*&<&'header&~name'&>&*:*&"
9703 .cindex "expansion" "header insertion"
9704 .vindex "&$header_$&"
9705 .vindex "&$bheader_$&"
9706 .vindex "&$lheader_$&"
9707 .vindex "&$rheader_$&"
9708 .cindex "header lines" "in expansion strings"
9709 .cindex "header lines" "character sets"
9710 .cindex "header lines" "decoding"
9711 Substitute the contents of the named message header line, for example
9712 .code
9713 $header_reply-to:
9714 .endd
9715 The newline that terminates a header line is not included in the expansion, but
9716 internal newlines (caused by splitting the header line over several physical
9717 lines) may be present.
9718
9719 The difference between the four pairs of expansions is in the way
9720 the data in the header line is interpreted.
9721
9722 .ilist
9723 .cindex "white space" "in header lines"
9724 &%rheader%& gives the original &"raw"& content of the header line, with no
9725 processing at all, and without the removal of leading and trailing white space.
9726
9727 .next
9728 .cindex "list" "of header lines"
9729 &%lheader%& gives a colon-separated list, one element per header when there
9730 are multiple headers with a given name.
9731 Any embedded colon characters within an element are doubled, so normal Exim
9732 list-processing facilities can be used.
9733 The terminating newline of each element is removed; in other respects
9734 the content is &"raw"&.
9735
9736 .next
9737 .cindex "base64 encoding" "in header lines"
9738 &%bheader%& removes leading and trailing white space, and then decodes base64
9739 or quoted-printable MIME &"words"& within the header text, but does no
9740 character set translation. If decoding of what looks superficially like a MIME
9741 &"word"& fails, the raw string is returned. If decoding
9742 .cindex "binary zero" "in header line"
9743 produces a binary zero character, it is replaced by a question mark &-- this is
9744 what Exim does for binary zeros that are actually received in header lines.
9745
9746 .next
9747 &%header%& tries to translate the string as decoded by &%bheader%& to a
9748 standard character set. This is an attempt to produce the same string as would
9749 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9750 returned. Translation is attempted only on operating systems that support the
9751 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9752 a system Makefile or in &_Local/Makefile_&.
9753 .endlist ilist
9754
9755 In a filter file, the target character set for &%header%& can be specified by a
9756 command of the following form:
9757 .code
9758 headers charset "UTF-8"
9759 .endd
9760 This command affects all references to &$h_$& (or &$header_$&) expansions in
9761 subsequently obeyed filter commands. In the absence of this command, the target
9762 character set in a filter is taken from the setting of the &%headers_charset%&
9763 option in the runtime configuration. The value of this option defaults to the
9764 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9765 ISO-8859-1.
9766
9767 Header names follow the syntax of RFC 2822, which states that they may contain
9768 any printing characters except space and colon. Consequently, curly brackets
9769 &'do not'& terminate header names, and should not be used to enclose them as
9770 if they were variables. Attempting to do so causes a syntax error.
9771
9772 Only header lines that are common to all copies of a message are visible to
9773 this mechanism. These are the original header lines that are received with the
9774 message, and any that are added by an ACL statement or by a system
9775 filter. Header lines that are added to a particular copy of a message by a
9776 router or transport are not accessible.
9777
9778 For incoming SMTP messages, no header lines are visible in
9779 ACLs that are obeyed before the data phase completes,
9780 because the header structure is not set up until the message is received.
9781 They are visible in DKIM, PRDR and DATA ACLs.
9782 Header lines that are added in a RCPT ACL (for example)
9783 are saved until the message's incoming header lines are available, at which
9784 point they are added.
9785 When any of the above ACLs ar
9786 running, however, header lines added by earlier ACLs are visible.
9787
9788 Upper case and lower case letters are synonymous in header names. If the
9789 following character is white space, the terminating colon may be omitted, but
9790 this is not recommended, because you may then forget it when it is needed. When
9791 white space terminates the header name, this white space is included in the
9792 expanded string.  If the message does not contain the given header, the
9793 expansion item is replaced by an empty string. (See the &%def%& condition in
9794 section &<<SECTexpcond>>& for a means of testing for the existence of a
9795 header.)
9796
9797 If there is more than one header with the same name, they are all concatenated
9798 to form the substitution string, up to a maximum length of 64K. Unless
9799 &%rheader%& is being used, leading and trailing white space is removed from
9800 each header before concatenation, and a completely empty header is ignored. A
9801 newline character is then inserted between non-empty headers, but there is no
9802 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9803 those headers that contain lists of addresses, a comma is also inserted at the
9804 junctions between headers. This does not happen for the &%rheader%& expansion.
9805
9806
9807 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9808 .cindex "expansion" "hmac hashing"
9809 .cindex &%hmac%&
9810 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9811 shared secret and some text into a message authentication code, as specified in
9812 RFC 2104. This differs from &`${md5:secret_text...}`& or
9813 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9814 cryptographic hash, allowing for authentication that is not possible with MD5
9815 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9816 present. For example:
9817 .code
9818 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9819 .endd
9820 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9821 produces:
9822 .code
9823 dd97e3ba5d1a61b5006108f8c8252953
9824 .endd
9825 As an example of how this might be used, you might put in the main part of
9826 an Exim configuration:
9827 .code
9828 SPAMSCAN_SECRET=cohgheeLei2thahw
9829 .endd
9830 In a router or a transport you could then have:
9831 .code
9832 headers_add = \
9833   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9834   ${hmac{md5}{SPAMSCAN_SECRET}\
9835   {${primary_hostname},${message_exim_id},$h_message-id:}}
9836 .endd
9837 Then given a message, you can check where it was scanned by looking at the
9838 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9839 this header line is authentic by recomputing the authentication code from the
9840 host name, message ID and the &'Message-id:'& header line. This can be done
9841 using Exim's &%-be%& option, or by other means, for example, by using the
9842 &'hmac_md5_hex()'& function in Perl.
9843
9844
9845 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9846 .cindex "expansion" "conditional"
9847 .cindex "&%if%&, expansion item"
9848 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9849 item; otherwise <&'string2'&> is used. The available conditions are described
9850 in section &<<SECTexpcond>>& below. For example:
9851 .code
9852 ${if eq {$local_part}{postmaster} {yes}{no} }
9853 .endd
9854 The second string need not be present; if it is not and the condition is not
9855 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9856 be present instead of the second string (without any curly brackets). In this
9857 case, the expansion is forced to fail if the condition is not true (see section
9858 &<<SECTforexpfai>>&).
9859
9860 If both strings are omitted, the result is the string &`true`& if the condition
9861 is true, and the empty string if the condition is false. This makes it less
9862 cumbersome to write custom ACL and router conditions. For example, instead of
9863 .code
9864 condition = ${if >{$acl_m4}{3}{true}{false}}
9865 .endd
9866 you can use
9867 .code
9868 condition = ${if >{$acl_m4}{3}}
9869 .endd
9870
9871
9872
9873 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9874 .cindex expansion "imap folder"
9875 .cindex "&%imapfolder%& expansion item"
9876 This item converts a (possibly multilevel, or with non-ASCII characters)
9877 folder specification to a Maildir name for filesystem use.
9878 For information on internationalisation support see &<<SECTi18nMDA>>&.
9879
9880
9881
9882 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9883 .cindex "expansion" "string truncation"
9884 .cindex "&%length%& expansion item"
9885 The &%length%& item is used to extract the initial portion of a string. Both
9886 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9887 you are using a fixed value for the number, that is, if <&'string1'&> does not
9888 change when expanded, you can use the simpler operator notation that avoids
9889 some of the braces:
9890 .code
9891 ${length_<n>:<string>}
9892 .endd
9893 The result of this item is either the first <&'n'&> bytes or the whole
9894 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9895 &%strlen%&, which gives the length of a string.
9896 All measurement is done in bytes and is not UTF-8 aware.
9897
9898
9899 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9900         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9901 .cindex "expansion" "extracting list elements by number"
9902 .cindex "&%listextract%&" "extract list elements by number"
9903 .cindex "list" "extracting elements by number"
9904 The <&'number'&> argument must consist entirely of decimal digits,
9905 apart from an optional leading minus,
9906 and leading and trailing white space (which is ignored).
9907
9908 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9909 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9910
9911 The first field of the list is numbered one.
9912 If the number is negative, the fields are
9913 counted from the end of the list, with the rightmost one numbered -1.
9914 The numbered element of the list is extracted and placed in &$value$&,
9915 then <&'string2'&> is expanded as the result.
9916
9917 If the modulus of the
9918 number is zero or greater than the number of fields in the string,
9919 the result is the expansion of <&'string3'&>.
9920
9921 For example:
9922 .code
9923 ${listextract{2}{x:42:99}}
9924 .endd
9925 yields &"42"&, and
9926 .code
9927 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9928 .endd
9929 yields &"result: 42"&.
9930
9931 If {<&'string3'&>} is omitted, an empty string is used for string3.
9932 If {<&'string2'&>} is also omitted, the value that was
9933 extracted is used.
9934 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9935
9936
9937 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9938         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9939 This is the first of one of two different types of lookup item, which are both
9940 described in the next item.
9941
9942 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9943         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9944 .cindex "expansion" "lookup in"
9945 .cindex "file" "lookups"
9946 .cindex "lookup" "in expanded string"
9947 The two forms of lookup item specify data lookups in files and databases, as
9948 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9949 lookups, and the second is used for query-style lookups. The <&'key'&>,
9950 <&'file'&>, and <&'query'&> strings are expanded before use.
9951
9952 If there is any white space in a lookup item which is part of a filter command,
9953 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9954 other place where white space is significant, the lookup item must be enclosed
9955 in double quotes. The use of data lookups in users' filter files may be locked
9956 out by the system administrator.
9957
9958 .vindex "&$value$&"
9959 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9960 During its expansion, the variable &$value$& contains the data returned by the
9961 lookup. Afterwards it reverts to the value it had previously (at the outer
9962 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9963 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9964 string on failure. If <&'string2'&> is provided, it can itself be a nested
9965 lookup, thus providing a mechanism for looking up a default value when the
9966 original lookup fails.
9967
9968 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9969 data for the outer lookup while the parameters of the second lookup are
9970 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9971 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9972 appear, and in this case, if the lookup fails, the entire expansion is forced
9973 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9974 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9975 successful lookup, and nothing in the case of failure.
9976
9977 For single-key lookups, the string &"partial"& is permitted to precede the
9978 search type in order to do partial matching, and * or *@ may follow a search
9979 type to request default lookups if the key does not match (see sections
9980 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9981
9982 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9983 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9984 and non-wild parts of the key during the expansion of the replacement text.
9985 They return to their previous values at the end of the lookup item.
9986
9987 This example looks up the postmaster alias in the conventional alias file:
9988 .code
9989 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9990 .endd
9991 This example uses NIS+ to look up the full name of the user corresponding to
9992 the local part of an address, forcing the expansion to fail if it is not found:
9993 .code
9994 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9995   {$value}fail}
9996 .endd
9997
9998
9999 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10000 .cindex "expansion" "list creation"
10001 .vindex "&$item$&"
10002 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10003 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10004 For each item
10005 in this list, its value is place in &$item$&, and then <&'string2'&> is
10006 expanded and added to the output as an item in a new list. The separator used
10007 for the output list is the same as the one used for the input, but a separator
10008 setting is not included in the output. For example:
10009 .code
10010 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10011 .endd
10012 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10013 value of &$item$& is restored to what it was before. See also the &*filter*&
10014 and &*reduce*& expansion items.
10015
10016 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10017 .cindex "expansion" "numeric hash"
10018 .cindex "hash function" "numeric"
10019 The three strings are expanded; the first two must yield numbers. Call them
10020 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10021 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10022 can use the simpler operator notation that avoids some of the braces:
10023 .code
10024 ${nhash_<n>_<m>:<string>}
10025 .endd
10026 The second number is optional (in both notations). If there is only one number,
10027 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10028 processed by a div/mod hash function that returns two numbers, separated by a
10029 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10030 example,
10031 .code
10032 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10033 .endd
10034 returns the string &"6/33"&.
10035
10036
10037
10038 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10039 .cindex "Perl" "use in expanded string"
10040 .cindex "expansion" "calling Perl from"
10041 This item is available only if Exim has been built to include an embedded Perl
10042 interpreter. The subroutine name and the arguments are first separately
10043 expanded, and then the Perl subroutine is called with those arguments. No
10044 additional arguments need be given; the maximum number permitted, including the
10045 name of the subroutine, is nine.
10046
10047 The return value of the subroutine is inserted into the expanded string, unless
10048 the return value is &%undef%&. In that case, the expansion fails in the same
10049 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10050 Whatever you return is evaluated in a scalar context. For example, if you
10051 return the name of a Perl vector, the return value is the size of the vector,
10052 not its contents.
10053
10054 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10055 with the error message that was passed to &%die%&. More details of the embedded
10056 Perl facility are given in chapter &<<CHAPperl>>&.
10057
10058 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10059 out the use of this expansion item in filter files.
10060
10061
10062 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10063 .cindex "&%prvs%& expansion item"
10064 The first argument is a complete email address and the second is secret
10065 keystring. The third argument, specifying a key number, is optional. If absent,
10066 it defaults to 0. The result of the expansion is a prvs-signed email address,
10067 to be typically used with the &%return_path%& option on an &(smtp)& transport
10068 as part of a bounce address tag validation (BATV) scheme. For more discussion
10069 and an example, see section &<<SECTverifyPRVS>>&.
10070
10071 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10072         {*&<&'string'&>&*}}*&"
10073 .cindex "&%prvscheck%& expansion item"
10074 This expansion item is the complement of the &%prvs%& item. It is used for
10075 checking prvs-signed addresses. If the expansion of the first argument does not
10076 yield a syntactically valid prvs-signed address, the whole item expands to the
10077 empty string. When the first argument does expand to a syntactically valid
10078 prvs-signed address, the second argument is expanded, with the prvs-decoded
10079 version of the address and the key number extracted from the address in the
10080 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10081
10082 These two variables can be used in the expansion of the second argument to
10083 retrieve the secret. The validity of the prvs-signed address is then checked
10084 against the secret. The result is stored in the variable &$prvscheck_result$&,
10085 which is empty for failure or &"1"& for success.
10086
10087 The third argument is optional; if it is missing, it defaults to an empty
10088 string. This argument is now expanded. If the result is an empty string, the
10089 result of the expansion is the decoded version of the address. This is the case
10090 whether or not the signature was valid. Otherwise, the result of the expansion
10091 is the expansion of the third argument.
10092
10093 All three variables can be used in the expansion of the third argument.
10094 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10095 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10096
10097 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10098 .cindex "expansion" "inserting an entire file"
10099 .cindex "file" "inserting into expansion"
10100 .cindex "&%readfile%& expansion item"
10101 The filename and end-of-line string are first expanded separately. The file is
10102 then read, and its contents replace the entire item. All newline characters in
10103 the file are replaced by the end-of-line string if it is present. Otherwise,
10104 newlines are left in the string.
10105 String expansion is not applied to the contents of the file. If you want this,
10106 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10107 the string expansion fails.
10108
10109 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10110 locks out the use of this expansion item in filter files.
10111
10112
10113
10114 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10115         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10116 .cindex "expansion" "inserting from a socket"
10117 .cindex "socket, use of in expansion"
10118 .cindex "&%readsocket%& expansion item"
10119 This item inserts data from a Unix domain or TCP socket into the expanded
10120 string. The minimal way of using it uses just two arguments, as in these
10121 examples:
10122 .code
10123 ${readsocket{/socket/name}{request string}}
10124 ${readsocket{inet:some.host:1234}{request string}}
10125 .endd
10126 For a Unix domain socket, the first substring must be the path to the socket.
10127 For an Internet socket, the first substring must contain &`inet:`& followed by
10128 a host name or IP address, followed by a colon and a port, which can be a
10129 number or the name of a TCP port in &_/etc/services_&. An IP address may
10130 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10131 example:
10132 .code
10133 ${readsocket{inet:[::1]:1234}{request string}}
10134 .endd
10135 Only a single host name may be given, but if looking it up yields more than
10136 one IP address, they are each tried in turn until a connection is made. For
10137 both kinds of socket, Exim makes a connection, writes the request string
10138 unless it is an empty string; and no terminating NUL is ever sent)
10139 and reads from the socket until an end-of-file
10140 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10141 extend what can be done. Firstly, you can vary the timeout. For example:
10142 .code
10143 ${readsocket{/socket/name}{request string}{3s}}
10144 .endd
10145
10146 The third argument is a list of options, of which the first element is the timeout
10147 and must be present if the argument is given.
10148 Further elements are options of form &'name=value'&.
10149 Two option types is currently recognised: shutdown and tls.
10150 The first defines whether (the default)
10151 or not a shutdown is done on the connection after sending the request.
10152 Example, to not do so (preferred, eg. by some webservers):
10153 .code
10154 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10155 .endd
10156 The second, tls, controls the use of TLS on the connection.  Example:
10157 .code
10158 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10159 .endd
10160 The default is to not use TLS.
10161 If it is enabled, a shutdown as descripbed above is never done.
10162
10163 A fourth argument allows you to change any newlines that are in the data
10164 that is read, in the same way as for &%readfile%& (see above). This example
10165 turns them into spaces:
10166 .code
10167 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10168 .endd
10169 As with all expansions, the substrings are expanded before the processing
10170 happens. Errors in these sub-expansions cause the expansion to fail. In
10171 addition, the following errors can occur:
10172
10173 .ilist
10174 Failure to create a socket file descriptor;
10175 .next
10176 Failure to connect the socket;
10177 .next
10178 Failure to write the request string;
10179 .next
10180 Timeout on reading from the socket.
10181 .endlist
10182
10183 By default, any of these errors causes the expansion to fail. However, if
10184 you supply a fifth substring, it is expanded and used when any of the above
10185 errors occurs. For example:
10186 .code
10187 ${readsocket{/socket/name}{request string}{3s}{\n}\
10188   {socket failure}}
10189 .endd
10190 You can test for the existence of a Unix domain socket by wrapping this
10191 expansion in &`${if exists`&, but there is a race condition between that test
10192 and the actual opening of the socket, so it is safer to use the fifth argument
10193 if you want to be absolutely sure of avoiding an expansion error for a
10194 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10195
10196 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10197 locks out the use of this expansion item in filter files.
10198
10199
10200 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10201 .cindex "expansion" "reducing a list to a scalar"
10202 .cindex "list" "reducing to a scalar"
10203 .vindex "&$value$&"
10204 .vindex "&$item$&"
10205 This operation reduces a list to a single, scalar string. After expansion,
10206 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10207 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10208 Then <&'string2'&> is expanded and
10209 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10210 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10211 them. The result of that expansion is assigned to &$value$& before the next
10212 iteration. When the end of the list is reached, the final value of &$value$& is
10213 added to the expansion output. The &*reduce*& expansion item can be used in a
10214 number of ways. For example, to add up a list of numbers:
10215 .code
10216 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10217 .endd
10218 The result of that expansion would be &`6`&. The maximum of a list of numbers
10219 can be found:
10220 .code
10221 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10222 .endd
10223 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10224 restored to what they were before. See also the &*filter*& and &*map*&
10225 expansion items.
10226
10227 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10228 This item inserts &"raw"& header lines. It is described with the &%header%&
10229 expansion item in section &<<SECTexpansionitems>>& above.
10230
10231 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10232         {*&<&'string2'&>&*}}*&"
10233 .cindex "expansion" "running a command"
10234 .cindex "&%run%& expansion item"
10235 The command and its arguments are first expanded as one string. The string is
10236 split apart into individual arguments by spaces, and then the command is run
10237 in a separate process, but under the same uid and gid.  As in other command
10238 executions from Exim, a shell is not used by default. If the command requires
10239 a shell, you must explicitly code it.
10240
10241 Since the arguments are split by spaces, when there is a variable expansion
10242 which has an empty result, it will cause the situation that the argument will
10243 simply be omitted when the program is actually executed by Exim. If the
10244 script/program requires a specific number of arguments and the expanded
10245 variable could possibly result in this empty expansion, the variable must be
10246 quoted. This is more difficult if the expanded variable itself could result
10247 in a string containing quotes, because it would interfere with the quotes
10248 around the command arguments. A possible guard against this is to wrap the
10249 variable in the &%sg%& operator to change any quote marks to some other
10250 character.
10251
10252 The standard input for the command exists, but is empty. The standard output
10253 and standard error are set to the same file descriptor.
10254 .cindex "return code" "from &%run%& expansion"
10255 .vindex "&$value$&"
10256 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10257 and replaces the entire item; during this expansion, the standard output/error
10258 from the command is in the variable &$value$&. If the command fails,
10259 <&'string2'&>, if present, is expanded and used. Once again, during the
10260 expansion, the standard output/error from the command is in the variable
10261 &$value$&.
10262
10263 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10264 can be the word &"fail"& (not in braces) to force expansion failure if the
10265 command does not succeed. If both strings are omitted, the result is contents
10266 of the standard output/error on success, and nothing on failure.
10267
10268 .vindex "&$run_in_acl$&"
10269 The standard output/error of the command is put in the variable &$value$&.
10270 In this ACL example, the output of a command is logged for the admin to
10271 troubleshoot:
10272 .code
10273 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10274       log_message  = Output of id: $value
10275 .endd
10276 If the command requires shell idioms, such as the > redirect operator, the
10277 shell must be invoked directly, such as with:
10278 .code
10279 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10280 .endd
10281
10282 .vindex "&$runrc$&"
10283 The return code from the command is put in the variable &$runrc$&, and this
10284 remains set afterwards, so in a filter file you can do things like this:
10285 .code
10286 if "${run{x y z}{}}$runrc" is 1 then ...
10287   elif $runrc is 2 then ...
10288   ...
10289 endif
10290 .endd
10291 If execution of the command fails (for example, the command does not exist),
10292 the return code is 127 &-- the same code that shells use for non-existent
10293 commands.
10294
10295 &*Warning*&: In a router or transport, you cannot assume the order in which
10296 option values are expanded, except for those preconditions whose order of
10297 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10298 by the expansion of one option, and use it in another.
10299
10300 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10301 out the use of this expansion item in filter files.
10302
10303
10304 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10305 .cindex "expansion" "string substitution"
10306 .cindex "&%sg%& expansion item"
10307 This item works like Perl's substitution operator (s) with the global (/g)
10308 option; hence its name. However, unlike the Perl equivalent, Exim does not
10309 modify the subject string; instead it returns the modified string for insertion
10310 into the overall expansion. The item takes three arguments: the subject string,
10311 a regular expression, and a substitution string. For example:
10312 .code
10313 ${sg{abcdefabcdef}{abc}{xyz}}
10314 .endd
10315 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10316 if any $, } or \ characters are required in the regular expression or in the
10317 substitution string, they have to be escaped. For example:
10318 .code
10319 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10320 .endd
10321 yields &"defabc"&, and
10322 .code
10323 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10324 .endd
10325 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10326 the regular expression from string expansion.
10327
10328 The regular expression is compiled in 8-bit mode, working against bytes
10329 rather than any Unicode-aware character handling.
10330
10331
10332 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10333 .cindex sorting "a list"
10334 .cindex list sorting
10335 .cindex expansion "list sorting"
10336 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10337 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10338 The <&'comparator'&> argument is interpreted as the operator
10339 of a two-argument expansion condition.
10340 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10341 The comparison should return true when applied to two values
10342 if the first value should sort before the second value.
10343 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10344 the element being placed in &$item$&,
10345 to give values for comparison.
10346
10347 The item result is a sorted list,
10348 with the original list separator,
10349 of the list elements (in full) of the original.
10350
10351 Examples:
10352 .code
10353 ${sort{3:2:1:4}{<}{$item}}
10354 .endd
10355 sorts a list of numbers, and
10356 .code
10357 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10358 .endd
10359 will sort an MX lookup into priority order.
10360
10361
10362 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10363 .cindex "&%substr%& expansion item"
10364 .cindex "substring extraction"
10365 .cindex "expansion" "substring extraction"
10366 The three strings are expanded; the first two must yield numbers. Call them
10367 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10368 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10369 can use the simpler operator notation that avoids some of the braces:
10370 .code
10371 ${substr_<n>_<m>:<string>}
10372 .endd
10373 The second number is optional (in both notations).
10374 If it is absent in the simpler format, the preceding underscore must also be
10375 omitted.
10376
10377 The &%substr%& item can be used to extract more general substrings than
10378 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10379 length required. For example
10380 .code
10381 ${substr{3}{2}{$local_part}}
10382 .endd
10383 If the starting offset is greater than the string length the result is the
10384 null string; if the length plus starting offset is greater than the string
10385 length, the result is the right-hand part of the string, starting from the
10386 given offset. The first byte (character) in the string has offset zero.
10387
10388 The &%substr%& expansion item can take negative offset values to count
10389 from the right-hand end of its operand. The last byte (character) is offset -1,
10390 the second-last is offset -2, and so on. Thus, for example,
10391 .code
10392 ${substr{-5}{2}{1234567}}
10393 .endd
10394 yields &"34"&. If the absolute value of a negative offset is greater than the
10395 length of the string, the substring starts at the beginning of the string, and
10396 the length is reduced by the amount of overshoot. Thus, for example,
10397 .code
10398 ${substr{-5}{2}{12}}
10399 .endd
10400 yields an empty string, but
10401 .code
10402 ${substr{-3}{2}{12}}
10403 .endd
10404 yields &"1"&.
10405
10406 When the second number is omitted from &%substr%&, the remainder of the string
10407 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10408 string preceding the offset point are taken. For example, an offset of -1 and
10409 no length, as in these semantically identical examples:
10410 .code
10411 ${substr_-1:abcde}
10412 ${substr{-1}{abcde}}
10413 .endd
10414 yields all but the last character of the string, that is, &"abcd"&.
10415
10416 All measurement is done in bytes and is not UTF-8 aware.
10417
10418
10419
10420 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10421         {*&<&'replacements'&>&*}}*&"
10422 .cindex "expansion" "character translation"
10423 .cindex "&%tr%& expansion item"
10424 This item does single-character (in bytes) translation on its subject string. The second
10425 argument is a list of characters to be translated in the subject string. Each
10426 matching character is replaced by the corresponding character from the
10427 replacement list. For example
10428 .code
10429 ${tr{abcdea}{ac}{13}}
10430 .endd
10431 yields &`1b3de1`&. If there are duplicates in the second character string, the
10432 last occurrence is used. If the third string is shorter than the second, its
10433 last character is replicated. However, if it is empty, no translation takes
10434 place.
10435
10436 All character handling is done in bytes and is not UTF-8 aware.
10437
10438 .endlist
10439
10440
10441
10442 .section "Expansion operators" "SECTexpop"
10443 .cindex "expansion" "operators"
10444 For expansion items that perform transformations on a single argument string,
10445 the &"operator"& notation is used because it is simpler and uses fewer braces.
10446 The substring is first expanded before the operation is applied to it. The
10447 following operations can be performed:
10448
10449 .vlist
10450 .vitem &*${address:*&<&'string'&>&*}*&
10451 .cindex "expansion" "RFC 2822 address handling"
10452 .cindex "&%address%& expansion item"
10453 The string is interpreted as an RFC 2822 address, as it might appear in a
10454 header line, and the effective address is extracted from it. If the string does
10455 not parse successfully, the result is empty.
10456
10457 The parsing correctly handles SMTPUTF8 Unicode in the string.
10458
10459
10460 .vitem &*${addresses:*&<&'string'&>&*}*&
10461 .cindex "expansion" "RFC 2822 address handling"
10462 .cindex "&%addresses%& expansion item"
10463 The string (after expansion) is interpreted as a list of addresses in RFC
10464 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10465 operative address (&'local-part@domain'&) is extracted from each item, and the
10466 result of the expansion is a colon-separated list, with appropriate
10467 doubling of colons should any happen to be present in the email addresses.
10468 Syntactically invalid RFC2822 address items are omitted from the output.
10469
10470 It is possible to specify a character other than colon for the output
10471 separator by starting the string with > followed by the new separator
10472 character. For example:
10473 .code
10474 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10475 .endd
10476 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10477 first, so if the expanded string starts with >, it may change the output
10478 separator unintentionally. This can be avoided by setting the output
10479 separator explicitly:
10480 .code
10481 ${addresses:>:$h_from:}
10482 .endd
10483
10484 Compare the &*address*& (singular)
10485 expansion item, which extracts the working address from a single RFC2822
10486 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10487 processing lists.
10488
10489 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10490 a strict interpretation of header line formatting.  Exim parses the bare,
10491 unquoted portion of an email address and if it finds a comma, treats it as an
10492 email address separator. For the example header line:
10493 .code
10494 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10495 .endd
10496 The first example below demonstrates that Q-encoded email addresses are parsed
10497 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10498 It does not see the comma because it's still encoded as "=2C".  The second
10499 example below is passed the contents of &`$header_from:`&, meaning it gets
10500 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10501 The third example shows that the presence of a comma is skipped when it is
10502 quoted.  The fourth example shows SMTPUTF8 handling.
10503 .code
10504 # exim -be '${addresses:From: \
10505 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10506 user@example.com
10507 # exim -be '${addresses:From: Last, First <user@example.com>}'
10508 Last:user@example.com
10509 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10510 user@example.com
10511 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10512 フィリップ@example.jp
10513 .endd
10514
10515 .vitem &*${base32:*&<&'digits'&>&*}*&
10516 .cindex "&%base32%& expansion item"
10517 .cindex "expansion" "conversion to base 32"
10518 The string must consist entirely of decimal digits. The number is converted to
10519 base 32 and output as a (empty, for zero) string of characters.
10520 Only lowercase letters are used.
10521
10522 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10523 .cindex "&%base32d%& expansion item"
10524 .cindex "expansion" "conversion to base 32"
10525 The string must consist entirely of base-32 digits.
10526 The number is converted to decimal and output as a string.
10527
10528 .vitem &*${base62:*&<&'digits'&>&*}*&
10529 .cindex "&%base62%& expansion item"
10530 .cindex "expansion" "conversion to base 62"
10531 The string must consist entirely of decimal digits. The number is converted to
10532 base 62 and output as a string of six characters, including leading zeros. In
10533 the few operating environments where Exim uses base 36 instead of base 62 for
10534 its message identifiers (because those systems do not have case-sensitive
10535 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10536 to be absolutely clear: this is &'not'& base64 encoding.
10537
10538 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10539 .cindex "&%base62d%& expansion item"
10540 .cindex "expansion" "conversion to base 62"
10541 The string must consist entirely of base-62 digits, or, in operating
10542 environments where Exim uses base 36 instead of base 62 for its message
10543 identifiers, base-36 digits. The number is converted to decimal and output as a
10544 string.
10545
10546 .vitem &*${base64:*&<&'string'&>&*}*&
10547 .cindex "expansion" "base64 encoding"
10548 .cindex "base64 encoding" "in string expansion"
10549 .cindex "&%base64%& expansion item"
10550 .cindex certificate "base64 of DER"
10551 This operator converts a string into one that is base64 encoded.
10552
10553 If the string is a single variable of type certificate,
10554 returns the base64 encoding of the DER form of the certificate.
10555
10556
10557 .vitem &*${base64d:*&<&'string'&>&*}*&
10558 .cindex "expansion" "base64 decoding"
10559 .cindex "base64 decoding" "in string expansion"
10560 .cindex "&%base64d%& expansion item"
10561 This operator converts a base64-encoded string into the un-coded form.
10562
10563
10564 .vitem &*${domain:*&<&'string'&>&*}*&
10565 .cindex "domain" "extraction"
10566 .cindex "expansion" "domain extraction"
10567 The string is interpreted as an RFC 2822 address and the domain is extracted
10568 from it. If the string does not parse successfully, the result is empty.
10569
10570
10571 .vitem &*${escape:*&<&'string'&>&*}*&
10572 .cindex "expansion" "escaping non-printing characters"
10573 .cindex "&%escape%& expansion item"
10574 If the string contains any non-printing characters, they are converted to
10575 escape sequences starting with a backslash. Whether characters with the most
10576 significant bit set (so-called &"8-bit characters"&) count as printing or not
10577 is controlled by the &%print_topbitchars%& option.
10578
10579 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10580 .cindex "expansion" "escaping 8-bit characters"
10581 .cindex "&%escape8bit%& expansion item"
10582 If the string contains and characters with the most significant bit set,
10583 they are converted to escape sequences starting with a backslash.
10584 Backslashes and DEL characters are also converted.
10585
10586
10587 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10588 .cindex "expansion" "expression evaluation"
10589 .cindex "expansion" "arithmetic expression"
10590 .cindex "&%eval%& expansion item"
10591 These items supports simple arithmetic and bitwise logical operations in
10592 expansion strings. The string (after expansion) must be a conventional
10593 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10594 logical operators, and parentheses. All operations are carried out using
10595 integer arithmetic. The operator priorities are as follows (the same as in the
10596 C programming language):
10597 .table2 70pt 300pt
10598 .irow &'highest:'& "not (~), negate (-)"
10599 .irow ""   "multiply (*), divide (/), remainder (%)"
10600 .irow ""   "plus (+), minus (-)"
10601 .irow ""   "shift-left (<<), shift-right (>>)"
10602 .irow ""   "and (&&)"
10603 .irow ""   "xor (^)"
10604 .irow &'lowest:'&  "or (|)"
10605 .endtable
10606 Binary operators with the same priority are evaluated from left to right. White
10607 space is permitted before or after operators.
10608
10609 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10610 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10611 decimal, even if they start with a leading zero; hexadecimal numbers are not
10612 permitted. This can be useful when processing numbers extracted from dates or
10613 times, which often do have leading zeros.
10614
10615 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10616 or 1024*1024*1024,
10617 respectively. Negative numbers are supported. The result of the computation is
10618 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10619
10620 .display
10621 &`${eval:1+1}            `&  yields 2
10622 &`${eval:1+2*3}          `&  yields 7
10623 &`${eval:(1+2)*3}        `&  yields 9
10624 &`${eval:2+42%5}         `&  yields 4
10625 &`${eval:0xc&amp;5}          `&  yields 4
10626 &`${eval:0xc|5}          `&  yields 13
10627 &`${eval:0xc^5}          `&  yields 9
10628 &`${eval:0xc>>1}         `&  yields 6
10629 &`${eval:0xc<<1}         `&  yields 24
10630 &`${eval:~255&amp;0x1234}    `&  yields 4608
10631 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10632 .endd
10633
10634 As a more realistic example, in an ACL you might have
10635 .code
10636 deny   message = Too many bad recipients
10637        condition =                    \
10638          ${if and {                   \
10639            {>{$rcpt_count}{10}}       \
10640            {                          \
10641            <                          \
10642              {$recipients_count}      \
10643              {${eval:$rcpt_count/2}}  \
10644            }                          \
10645          }{yes}{no}}
10646 .endd
10647 The condition is true if there have been more than 10 RCPT commands and
10648 fewer than half of them have resulted in a valid recipient.
10649
10650
10651 .vitem &*${expand:*&<&'string'&>&*}*&
10652 .cindex "expansion" "re-expansion of substring"
10653 The &%expand%& operator causes a string to be expanded for a second time. For
10654 example,
10655 .code
10656 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10657 .endd
10658 first looks up a string in a file while expanding the operand for &%expand%&,
10659 and then re-expands what it has found.
10660
10661
10662 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10663 .cindex "Unicode"
10664 .cindex "UTF-8" "conversion from"
10665 .cindex "expansion" "UTF-8 conversion"
10666 .cindex "&%from_utf8%& expansion item"
10667 The world is slowly moving towards Unicode, although there are no standards for
10668 email yet. However, other applications (including some databases) are starting
10669 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10670 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10671 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10672 the result is an undefined sequence of bytes.
10673
10674 Unicode code points with values less than 256 are compatible with ASCII and
10675 ISO-8859-1 (also known as Latin-1).
10676 For example, character 169 is the copyright symbol in both cases, though the
10677 way it is encoded is different. In UTF-8, more than one byte is needed for
10678 characters with code values greater than 127, whereas ISO-8859-1 is a
10679 single-byte encoding (but thereby limited to 256 characters). This makes
10680 translation from UTF-8 to ISO-8859-1 straightforward.
10681
10682
10683 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10684 .cindex "hash function" "textual"
10685 .cindex "expansion" "textual hash"
10686 The &%hash%& operator is a simpler interface to the hashing function that can
10687 be used when the two parameters are fixed numbers (as opposed to strings that
10688 change when expanded). The effect is the same as
10689 .code
10690 ${hash{<n>}{<m>}{<string>}}
10691 .endd
10692 See the description of the general &%hash%& item above for details. The
10693 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10694
10695
10696
10697 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10698 .cindex "base64 encoding" "conversion from hex"
10699 .cindex "expansion" "hex to base64"
10700 .cindex "&%hex2b64%& expansion item"
10701 This operator converts a hex string into one that is base64 encoded. This can
10702 be useful for processing the output of the various hashing functions.
10703
10704
10705
10706 .vitem &*${hexquote:*&<&'string'&>&*}*&
10707 .cindex "quoting" "hex-encoded unprintable characters"
10708 .cindex "&%hexquote%& expansion item"
10709 This operator converts non-printable characters in a string into a hex
10710 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10711 as is, and other byte values are converted to &`\xNN`&, for example, a
10712 byte value 127 is converted to &`\x7f`&.
10713
10714
10715 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10716 .cindex "&%ipv6denorm%& expansion item"
10717 .cindex "IP address" normalisation
10718 This expands an IPv6 address to a full eight-element colon-separated set
10719 of hex digits including leading zeroes.
10720 A trailing ipv4-style dotted-decimal set is converted to hex.
10721 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10722
10723 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10724 .cindex "&%ipv6norm%& expansion item"
10725 .cindex "IP address" normalisation
10726 .cindex "IP address" "canonical form"
10727 This converts an IPv6 address to canonical form.
10728 Leading zeroes of groups are omitted, and the longest
10729 set of zero-valued groups is replaced with a double colon.
10730 A trailing ipv4-style dotted-decimal set is converted to hex.
10731 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10732
10733
10734 .vitem &*${lc:*&<&'string'&>&*}*&
10735 .cindex "case forcing in strings"
10736 .cindex "string" "case forcing"
10737 .cindex "lower casing"
10738 .cindex "expansion" "case forcing"
10739 .cindex "&%lc%& expansion item"
10740 This forces the letters in the string into lower-case, for example:
10741 .code
10742 ${lc:$local_part}
10743 .endd
10744 Case is defined per the system C locale.
10745
10746 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10747 .cindex "expansion" "string truncation"
10748 .cindex "&%length%& expansion item"
10749 The &%length%& operator is a simpler interface to the &%length%& function that
10750 can be used when the parameter is a fixed number (as opposed to a string that
10751 changes when expanded). The effect is the same as
10752 .code
10753 ${length{<number>}{<string>}}
10754 .endd
10755 See the description of the general &%length%& item above for details. Note that
10756 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10757 when &%length%& is used as an operator.
10758 All measurement is done in bytes and is not UTF-8 aware.
10759
10760
10761 .vitem &*${listcount:*&<&'string'&>&*}*&
10762 .cindex "expansion" "list item count"
10763 .cindex "list" "item count"
10764 .cindex "list" "count of items"
10765 .cindex "&%listcount%& expansion item"
10766 The string is interpreted as a list and the number of items is returned.
10767
10768
10769 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10770 .cindex "expansion" "named list"
10771 .cindex "&%listnamed%& expansion item"
10772 The name is interpreted as a named list and the content of the list is returned,
10773 expanding any referenced lists, re-quoting as needed for colon-separation.
10774 If the optional type is given it must be one of "a", "d", "h" or "l"
10775 and selects address-, domain-, host- or localpart- lists to search among respectively.
10776 Otherwise all types are searched in an undefined order and the first
10777 matching list is returned.
10778
10779
10780 .vitem &*${local_part:*&<&'string'&>&*}*&
10781 .cindex "expansion" "local part extraction"
10782 .cindex "&%local_part%& expansion item"
10783 The string is interpreted as an RFC 2822 address and the local part is
10784 extracted from it. If the string does not parse successfully, the result is
10785 empty.
10786 The parsing correctly handles SMTPUTF8 Unicode in the string.
10787
10788
10789 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10790 .cindex "masked IP address"
10791 .cindex "IP address" "masking"
10792 .cindex "CIDR notation"
10793 .cindex "expansion" "IP address masking"
10794 .cindex "&%mask%& expansion item"
10795 If the form of the string to be operated on is not an IP address followed by a
10796 slash and an integer (that is, a network address in CIDR notation), the
10797 expansion fails. Otherwise, this operator converts the IP address to binary,
10798 masks off the least significant bits according to the bit count, and converts
10799 the result back to text, with mask appended. For example,
10800 .code
10801 ${mask:10.111.131.206/28}
10802 .endd
10803 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10804 be mostly used for looking up masked addresses in files, the result for an IPv6
10805 address uses dots to separate components instead of colons, because colon
10806 terminates a key string in lsearch files. So, for example,
10807 .code
10808 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10809 .endd
10810 returns the string
10811 .code
10812 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10813 .endd
10814 Letters in IPv6 addresses are always output in lower case.
10815
10816
10817 .vitem &*${md5:*&<&'string'&>&*}*&
10818 .cindex "MD5 hash"
10819 .cindex "expansion" "MD5 hash"
10820 .cindex certificate fingerprint
10821 .cindex "&%md5%& expansion item"
10822 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10823 as a 32-digit hexadecimal number, in which any letters are in lower case.
10824
10825 If the string is a single variable of type certificate,
10826 returns the MD5 hash fingerprint of the certificate.
10827
10828
10829 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10830 .cindex "expansion" "numeric hash"
10831 .cindex "hash function" "numeric"
10832 The &%nhash%& operator is a simpler interface to the numeric hashing function
10833 that can be used when the two parameters are fixed numbers (as opposed to
10834 strings that change when expanded). The effect is the same as
10835 .code
10836 ${nhash{<n>}{<m>}{<string>}}
10837 .endd
10838 See the description of the general &%nhash%& item above for details.
10839
10840
10841 .vitem &*${quote:*&<&'string'&>&*}*&
10842 .cindex "quoting" "in string expansions"
10843 .cindex "expansion" "quoting"
10844 .cindex "&%quote%& expansion item"
10845 The &%quote%& operator puts its argument into double quotes if it
10846 is an empty string or
10847 contains anything other than letters, digits, underscores, dots, and hyphens.
10848 Any occurrences of double quotes and backslashes are escaped with a backslash.
10849 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10850 respectively For example,
10851 .code
10852 ${quote:ab"*"cd}
10853 .endd
10854 becomes
10855 .code
10856 "ab\"*\"cd"
10857 .endd
10858 The place where this is useful is when the argument is a substitution from a
10859 variable or a message header.
10860
10861 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10862 .cindex "&%quote_local_part%& expansion item"
10863 This operator is like &%quote%&, except that it quotes the string only if
10864 required to do so by the rules of RFC 2822 for quoting local parts. For
10865 example, a plus sign would not cause quoting (but it would for &%quote%&).
10866 If you are creating a new email address from the contents of &$local_part$&
10867 (or any other unknown data), you should always use this operator.
10868
10869 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10870 will likely use the quoting form.
10871 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10872
10873
10874 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10875 .cindex "quoting" "lookup-specific"
10876 This operator applies lookup-specific quoting rules to the string. Each
10877 query-style lookup type has its own quoting rules which are described with
10878 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10879 .code
10880 ${quote_ldap:two * two}
10881 .endd
10882 returns
10883 .code
10884 two%20%5C2A%20two
10885 .endd
10886 For single-key lookup types, no quoting is ever necessary and this operator
10887 yields an unchanged string.
10888
10889
10890 .vitem &*${randint:*&<&'n'&>&*}*&
10891 .cindex "random number"
10892 This operator returns a somewhat random number which is less than the
10893 supplied number and is at least 0.  The quality of this randomness depends
10894 on how Exim was built; the values are not suitable for keying material.
10895 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10896 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10897 for versions of GnuTLS with that function.
10898 Otherwise, the implementation may be arc4random(), random() seeded by
10899 srandomdev() or srandom(), or a custom implementation even weaker than
10900 random().
10901
10902
10903 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10904 .cindex "expansion" "IP address"
10905 This operator reverses an IP address; for IPv4 addresses, the result is in
10906 dotted-quad decimal form, while for IPv6 addresses the result is in
10907 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10908 for DNS.  For example,
10909 .code
10910 ${reverse_ip:192.0.2.4}
10911 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10912 .endd
10913 returns
10914 .code
10915 4.2.0.192
10916 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
10917 .endd
10918
10919
10920 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10921 .cindex "expansion" "RFC 2047"
10922 .cindex "RFC 2047" "expansion operator"
10923 .cindex "&%rfc2047%& expansion item"
10924 This operator encodes text according to the rules of RFC 2047. This is an
10925 encoding that is used in header lines to encode non-ASCII characters. It is
10926 assumed that the input string is in the encoding specified by the
10927 &%headers_charset%& option, which gets its default at build time. If the string
10928 contains only characters in the range 33&--126, and no instances of the
10929 characters
10930 .code
10931 ? = ( ) < > @ , ; : \ " . [ ] _
10932 .endd
10933 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10934 string, using as many &"encoded words"& as necessary to encode all the
10935 characters.
10936
10937
10938 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10939 .cindex "expansion" "RFC 2047"
10940 .cindex "RFC 2047" "decoding"
10941 .cindex "&%rfc2047d%& expansion item"
10942 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10943 bytes are replaced by question marks. Characters are converted into the
10944 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10945 not recognized unless &%check_rfc2047_length%& is set false.
10946
10947 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10948 access a header line, RFC 2047 decoding is done automatically. You do not need
10949 to use this operator as well.
10950
10951
10952
10953 .vitem &*${rxquote:*&<&'string'&>&*}*&
10954 .cindex "quoting" "in regular expressions"
10955 .cindex "regular expressions" "quoting"
10956 .cindex "&%rxquote%& expansion item"
10957 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10958 characters in its argument. This is useful when substituting the values of
10959 variables or headers inside regular expressions.
10960
10961
10962 .vitem &*${sha1:*&<&'string'&>&*}*&
10963 .cindex "SHA-1 hash"
10964 .cindex "expansion" "SHA-1 hashing"
10965 .cindex certificate fingerprint
10966 .cindex "&%sha1%& expansion item"
10967 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10968 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10969
10970 If the string is a single variable of type certificate,
10971 returns the SHA-1 hash fingerprint of the certificate.
10972
10973
10974 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
10975        &*${sha2:*&<&'string'&>&*}*& &&&
10976        &*${sha2_<n>:*&<&'string'&>&*}*&
10977 .cindex "SHA-256 hash"
10978 .cindex "SHA-2 hash"
10979 .cindex certificate fingerprint
10980 .cindex "expansion" "SHA-256 hashing"
10981 .cindex "&%sha256%& expansion item"
10982 .cindex "&%sha2%& expansion item"
10983 The &%sha256%& operator computes the SHA-256 hash value of the string
10984 and returns
10985 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10986
10987 If the string is a single variable of type certificate,
10988 returns the SHA-256 hash fingerprint of the certificate.
10989
10990 .new
10991 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
10992 (except for certificates, which are not supported).
10993 Finally, if an underbar
10994 and a number is appended it specifies the output length, selecting a
10995 member of the SHA-2 family of hash functions.
10996 Values of 256, 384 and 512 are accepted, with 256 being the default.
10997 .wen
10998
10999
11000 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11001        &*${sha3_<n>:*&<&'string'&>&*}*&
11002 .cindex "SHA3 hash"
11003 .cindex "expansion" "SHA3 hashing"
11004 .cindex "&%sha3%& expansion item"
11005 The &%sha3%& operator computes the SHA3-256 hash value of the string
11006 and returns
11007 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11008
11009 If a number is appended, separated by an underbar, it specifies
11010 the output length.  Values of 224, 256, 384 and 512 are accepted;
11011 with 256 being the default.
11012
11013 The &%sha3%& expansion item is only supported if Exim has been
11014 compiled with GnuTLS 3.5.0 or later,
11015 or OpenSSL 1.1.1 or later.
11016 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11017
11018
11019 .vitem &*${stat:*&<&'string'&>&*}*&
11020 .cindex "expansion" "statting a file"
11021 .cindex "file" "extracting characteristics"
11022 .cindex "&%stat%& expansion item"
11023 The string, after expansion, must be a file path. A call to the &[stat()]&
11024 function is made for this path. If &[stat()]& fails, an error occurs and the
11025 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11026 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11027 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11028 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11029 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11030 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11031 can extract individual fields using the &%extract%& expansion item.
11032
11033 The use of the &%stat%& expansion in users' filter files can be locked out by
11034 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11035 systems for files larger than 2GB.
11036
11037 .vitem &*${str2b64:*&<&'string'&>&*}*&
11038 .cindex "&%str2b64%& expansion item"
11039 Now deprecated, a synonym for the &%base64%& expansion operator.
11040
11041
11042
11043 .vitem &*${strlen:*&<&'string'&>&*}*&
11044 .cindex "expansion" "string length"
11045 .cindex "string" "length in expansion"
11046 .cindex "&%strlen%& expansion item"
11047 The item is replace by the length of the expanded string, expressed as a
11048 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11049 All measurement is done in bytes and is not UTF-8 aware.
11050
11051
11052 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11053 .cindex "&%substr%& expansion item"
11054 .cindex "substring extraction"
11055 .cindex "expansion" "substring expansion"
11056 The &%substr%& operator is a simpler interface to the &%substr%& function that
11057 can be used when the two parameters are fixed numbers (as opposed to strings
11058 that change when expanded). The effect is the same as
11059 .code
11060 ${substr{<start>}{<length>}{<string>}}
11061 .endd
11062 See the description of the general &%substr%& item above for details. The
11063 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11064 All measurement is done in bytes and is not UTF-8 aware.
11065
11066 .vitem &*${time_eval:*&<&'string'&>&*}*&
11067 .cindex "&%time_eval%& expansion item"
11068 .cindex "time interval" "decoding"
11069 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11070 seconds.
11071
11072 .vitem &*${time_interval:*&<&'string'&>&*}*&
11073 .cindex "&%time_interval%& expansion item"
11074 .cindex "time interval" "formatting"
11075 The argument (after sub-expansion) must be a sequence of decimal digits that
11076 represents an interval of time as a number of seconds. It is converted into a
11077 number of larger units and output in Exim's normal time format, for example,
11078 &`1w3d4h2m6s`&.
11079
11080 .vitem &*${uc:*&<&'string'&>&*}*&
11081 .cindex "case forcing in strings"
11082 .cindex "string" "case forcing"
11083 .cindex "upper casing"
11084 .cindex "expansion" "case forcing"
11085 .cindex "&%uc%& expansion item"
11086 This forces the letters in the string into upper-case.
11087 Case is defined per the system C locale.
11088
11089 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11090 .cindex "correction of invalid utf-8 sequences in strings"
11091 .cindex "utf-8" "utf-8 sequences"
11092 .cindex "incorrect utf-8"
11093 .cindex "expansion" "utf-8 forcing"
11094 .cindex "&%utf8clean%& expansion item"
11095 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11096 In versions of Exim before 4.92, this did not correctly do so for a truncated
11097 final codepoint's encoding, and the character would be silently dropped.
11098 If you must handle detection of this scenario across both sets of Exim behavior,
11099 the complexity will depend upon the task.
11100 For instance, to detect if the first character is multibyte and a 1-byte
11101 extraction can be successfully used as a path component (as is common for
11102 dividing up delivery folders), you might use:
11103 .code
11104 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11105 .endd
11106 (which will false-positive if the first character of the local part is a
11107 literal question mark).
11108
11109 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11110        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11111        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11112        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11113 .cindex expansion UTF-8
11114 .cindex UTF-8 expansion
11115 .cindex EAI
11116 .cindex internationalisation
11117 .cindex "&%utf8_domain_to_alabel%& expansion item"
11118 .cindex "&%utf8_domain_from_alabel%& expansion item"
11119 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11120 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11121 These convert EAI mail name components between UTF-8 and a-label forms.
11122 For information on internationalisation support see &<<SECTi18nMTA>>&.
11123 .endlist
11124
11125
11126
11127
11128
11129
11130 .section "Expansion conditions" "SECTexpcond"
11131 .scindex IIDexpcond "expansion" "conditions"
11132 The following conditions are available for testing by the &%${if%& construct
11133 while expanding strings:
11134
11135 .vlist
11136 .vitem &*!*&<&'condition'&>
11137 .cindex "expansion" "negating a condition"
11138 .cindex "negation" "in expansion condition"
11139 Preceding any condition with an exclamation mark negates the result of the
11140 condition.
11141
11142 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11143 .cindex "numeric comparison"
11144 .cindex "expansion" "numeric comparison"
11145 There are a number of symbolic operators for doing numeric comparisons. They
11146 are:
11147 .display
11148 &`=   `&   equal
11149 &`==  `&   equal
11150 &`>   `&   greater
11151 &`>=  `&   greater or equal
11152 &`<   `&   less
11153 &`<=  `&   less or equal
11154 .endd
11155 For example:
11156 .code
11157 ${if >{$message_size}{10M} ...
11158 .endd
11159 Note that the general negation operator provides for inequality testing. The
11160 two strings must take the form of optionally signed decimal integers,
11161 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11162 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11163 As a special case, the numerical value of an empty string is taken as
11164 zero.
11165
11166 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11167 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11168 10M, not if 10M is larger than &$message_size$&.
11169
11170
11171 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11172         {*&<&'arg2'&>&*}...}*&
11173 .cindex "expansion" "calling an acl"
11174 .cindex "&%acl%&" "expansion condition"
11175 The name and zero to nine argument strings are first expanded separately.  The expanded
11176 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11177 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11178 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11179 and may use the variables; if another acl expansion is used the values
11180 are restored after it returns.  If the ACL sets
11181 a value using a "message =" modifier the variable $value becomes
11182 the result of the expansion, otherwise it is empty.
11183 If the ACL returns accept the condition is true; if deny, false.
11184 If the ACL returns defer the result is a forced-fail.
11185
11186 .vitem &*bool&~{*&<&'string'&>&*}*&
11187 .cindex "expansion" "boolean parsing"
11188 .cindex "&%bool%& expansion condition"
11189 This condition turns a string holding a true or false representation into
11190 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11191 (case-insensitively); also integer numbers map to true if non-zero,
11192 false if zero.
11193 An empty string is treated as false.
11194 Leading and trailing whitespace is ignored;
11195 thus a string consisting only of whitespace is false.
11196 All other string values will result in expansion failure.
11197
11198 When combined with ACL variables, this expansion condition will let you
11199 make decisions in one place and act on those decisions in another place.
11200 For example:
11201 .code
11202 ${if bool{$acl_m_privileged_sender} ...
11203 .endd
11204
11205
11206 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11207 .cindex "expansion" "boolean parsing"
11208 .cindex "&%bool_lax%& expansion condition"
11209 Like &%bool%&, this condition turns a string into a boolean state.  But
11210 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11211 loose definition that the Router &%condition%& option uses.  The empty string
11212 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11213 true.  Leading and trailing whitespace is ignored.
11214
11215 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11216
11217 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11218 .cindex "expansion" "encrypted comparison"
11219 .cindex "encrypted strings, comparing"
11220 .cindex "&%crypteq%& expansion condition"
11221 This condition is included in the Exim binary if it is built to support any
11222 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11223 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11224 included in the binary.
11225
11226 The &%crypteq%& condition has two arguments. The first is encrypted and
11227 compared against the second, which is already encrypted. The second string may
11228 be in the LDAP form for storing encrypted strings, which starts with the
11229 encryption type in curly brackets, followed by the data. If the second string
11230 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11231 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11232 Typically this will be a field from a password file. An example of an encrypted
11233 string in LDAP form is:
11234 .code
11235 {md5}CY9rzUYh03PK3k6DJie09g==
11236 .endd
11237 If such a string appears directly in an expansion, the curly brackets have to
11238 be quoted, because they are part of the expansion syntax. For example:
11239 .code
11240 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11241 .endd
11242 The following encryption types (whose names are matched case-independently) are
11243 supported:
11244
11245 .ilist
11246 .cindex "MD5 hash"
11247 .cindex "base64 encoding" "in encrypted password"
11248 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11249 printable characters to compare with the remainder of the second string. If the
11250 length of the comparison string is 24, Exim assumes that it is base64 encoded
11251 (as in the above example). If the length is 32, Exim assumes that it is a
11252 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11253 comparison fails.
11254
11255 .next
11256 .cindex "SHA-1 hash"
11257 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11258 printable characters to compare with the remainder of the second string. If the
11259 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11260 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11261 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11262
11263 .next
11264 .cindex "&[crypt()]&"
11265 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11266 only the first eight characters of the password. However, in modern operating
11267 systems this is no longer true, and in many cases the entire password is used,
11268 whatever its length.
11269
11270 .next
11271 .cindex "&[crypt16()]&"
11272 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11273 use up to 16 characters of the password in some operating systems. Again, in
11274 modern operating systems, more characters may be used.
11275 .endlist
11276 Exim has its own version of &[crypt16()]&, which is just a double call to
11277 &[crypt()]&. For operating systems that have their own version, setting
11278 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11279 operating system version instead of its own. This option is set by default in
11280 the OS-dependent &_Makefile_& for those operating systems that are known to
11281 support &[crypt16()]&.
11282
11283 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11284 it was not using the same algorithm as some operating systems' versions. It
11285 turns out that as well as &[crypt16()]& there is a function called
11286 &[bigcrypt()]& in some operating systems. This may or may not use the same
11287 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11288
11289 However, since there is now a move away from the traditional &[crypt()]&
11290 functions towards using SHA1 and other algorithms, tidying up this area of
11291 Exim is seen as very low priority.
11292
11293 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11294 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11295 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11296 default is &`{crypt}`&. Whatever the default, you can always use either
11297 function by specifying it explicitly in curly brackets.
11298
11299 .vitem &*def:*&<&'variable&~name'&>
11300 .cindex "expansion" "checking for empty variable"
11301 .cindex "&%def%& expansion condition"
11302 The &%def%& condition must be followed by the name of one of the expansion
11303 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11304 variable does not contain the empty string. For example:
11305 .code
11306 ${if def:sender_ident {from $sender_ident}}
11307 .endd
11308 Note that the variable name is given without a leading &%$%& character. If the
11309 variable does not exist, the expansion fails.
11310
11311 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11312         &~&*def:h_*&<&'header&~name'&>&*:*&"
11313 .cindex "expansion" "checking header line existence"
11314 This condition is true if a message is being processed and the named header
11315 exists in the message. For example,
11316 .code
11317 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11318 .endd
11319 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11320 the header name must be terminated by a colon if white space does not follow.
11321
11322 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11323        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11324 .cindex "string" "comparison"
11325 .cindex "expansion" "string comparison"
11326 .cindex "&%eq%& expansion condition"
11327 .cindex "&%eqi%& expansion condition"
11328 The two substrings are first expanded. The condition is true if the two
11329 resulting strings are identical. For &%eq%& the comparison includes the case of
11330 letters, whereas for &%eqi%& the comparison is case-independent, where
11331 case is defined per the system C locale.
11332
11333 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11334 .cindex "expansion" "file existence test"
11335 .cindex "file" "existence test"
11336 .cindex "&%exists%&, expansion condition"
11337 The substring is first expanded and then interpreted as an absolute path. The
11338 condition is true if the named file (or directory) exists. The existence test
11339 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11340 users' filter files may be locked out by the system administrator.
11341
11342 .vitem &*first_delivery*&
11343 .cindex "delivery" "first"
11344 .cindex "first delivery"
11345 .cindex "expansion" "first delivery test"
11346 .cindex "&%first_delivery%& expansion condition"
11347 This condition, which has no data, is true during a message's first delivery
11348 attempt. It is false during any subsequent delivery attempts.
11349
11350
11351 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11352        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11353 .cindex "list" "iterative conditions"
11354 .cindex "expansion" "&*forall*& condition"
11355 .cindex "expansion" "&*forany*& condition"
11356 .vindex "&$item$&"
11357 These conditions iterate over a list. The first argument is expanded to form
11358 the list. By default, the list separator is a colon, but it can be changed by
11359 the normal method (&<<SECTlistsepchange>>&).
11360 The second argument is interpreted as a condition that is to
11361 be applied to each item in the list in turn. During the interpretation of the
11362 condition, the current list item is placed in a variable called &$item$&.
11363 .ilist
11364 For &*forany*&, interpretation stops if the condition is true for any item, and
11365 the result of the whole condition is true. If the condition is false for all
11366 items in the list, the overall condition is false.
11367 .next
11368 For &*forall*&, interpretation stops if the condition is false for any item,
11369 and the result of the whole condition is false. If the condition is true for
11370 all items in the list, the overall condition is true.
11371 .endlist
11372 Note that negation of &*forany*& means that the condition must be false for all
11373 items for the overall condition to succeed, and negation of &*forall*& means
11374 that the condition must be false for at least one item. In this example, the
11375 list separator is changed to a comma:
11376 .code
11377 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11378 .endd
11379 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11380 being processed, to enable these expansion items to be nested.
11381
11382 To scan a named list, expand it with the &*listnamed*& operator.
11383
11384 .new
11385 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11386        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11387        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11388        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11389 .cindex JSON "iterative conditions"
11390 .cindex JSON expansions
11391 .cindex expansion "&*forall_json*& condition"
11392 .cindex expansion "&*forany_json*& condition"
11393 .cindex expansion "&*forall_jsons*& condition"
11394 .cindex expansion "&*forany_jsons*& condition"
11395 As for the above, except that the first argument must, after expansion,
11396 be a JSON array.
11397 The array separator is not changeable.
11398 For the &"jsons"& variants the elements are expected to be JSON strings
11399 and have their quotes removed before the evaluation of the condition.
11400 .wen
11401
11402
11403
11404 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11405        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11406 .cindex "string" "comparison"
11407 .cindex "expansion" "string comparison"
11408 .cindex "&%ge%& expansion condition"
11409 .cindex "&%gei%& expansion condition"
11410 The two substrings are first expanded. The condition is true if the first
11411 string is lexically greater than or equal to the second string. For &%ge%& the
11412 comparison includes the case of letters, whereas for &%gei%& the comparison is
11413 case-independent.
11414 Case and collation order are defined per the system C locale.
11415
11416 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11417        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11418 .cindex "string" "comparison"
11419 .cindex "expansion" "string comparison"
11420 .cindex "&%gt%& expansion condition"
11421 .cindex "&%gti%& expansion condition"
11422 The two substrings are first expanded. The condition is true if the first
11423 string is lexically greater than the second string. For &%gt%& the comparison
11424 includes the case of letters, whereas for &%gti%& the comparison is
11425 case-independent.
11426 Case and collation order are defined per the system C locale.
11427
11428 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11429        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11430 .cindex "string" "comparison"
11431 .cindex "list" "iterative conditions"
11432 Both strings are expanded; the second string is treated as a list of simple
11433 strings; if the first string is a member of the second, then the condition
11434 is true.
11435 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11436
11437 These are simpler to use versions of the more powerful &*forany*& condition.
11438 Examples, and the &*forany*& equivalents:
11439 .code
11440 ${if inlist{needle}{foo:needle:bar}}
11441   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11442 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11443   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11444 .endd
11445
11446 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11447        &*isip4&~{*&<&'string'&>&*}*& &&&
11448        &*isip6&~{*&<&'string'&>&*}*&
11449 .cindex "IP address" "testing string format"
11450 .cindex "string" "testing for IP address"
11451 .cindex "&%isip%& expansion condition"
11452 .cindex "&%isip4%& expansion condition"
11453 .cindex "&%isip6%& expansion condition"
11454 The substring is first expanded, and then tested to see if it has the form of
11455 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11456 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11457
11458 For an IPv4 address, the test is for four dot-separated components, each of
11459 which consists of from one to three digits. For an IPv6 address, up to eight
11460 colon-separated components are permitted, each containing from one to four
11461 hexadecimal digits. There may be fewer than eight components if an empty
11462 component (adjacent colons) is present. Only one empty component is permitted.
11463
11464 &*Note*&: The checks used to be just on the form of the address; actual numerical
11465 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11466 check.
11467 This is no longer the case.
11468
11469 The main use of these tests is to distinguish between IP addresses and
11470 host names, or between IPv4 and IPv6 addresses. For example, you could use
11471 .code
11472 ${if isip4{$sender_host_address}...
11473 .endd
11474 to test which IP version an incoming SMTP connection is using.
11475
11476 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11477 .cindex "LDAP" "use for authentication"
11478 .cindex "expansion" "LDAP authentication test"
11479 .cindex "&%ldapauth%& expansion condition"
11480 This condition supports user authentication using LDAP. See section
11481 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11482 queries. For this use, the query must contain a user name and password. The
11483 query itself is not used, and can be empty. The condition is true if the
11484 password is not empty, and the user name and password are accepted by the LDAP
11485 server. An empty password is rejected without calling LDAP because LDAP binds
11486 with an empty password are considered anonymous regardless of the username, and
11487 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11488 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11489 this can be used.
11490
11491
11492 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11493        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11494 .cindex "string" "comparison"
11495 .cindex "expansion" "string comparison"
11496 .cindex "&%le%& expansion condition"
11497 .cindex "&%lei%& expansion condition"
11498 The two substrings are first expanded. The condition is true if the first
11499 string is lexically less than or equal to the second string. For &%le%& the
11500 comparison includes the case of letters, whereas for &%lei%& the comparison is
11501 case-independent.
11502 Case and collation order are defined per the system C locale.
11503
11504 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11505        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11506 .cindex "string" "comparison"
11507 .cindex "expansion" "string comparison"
11508 .cindex "&%lt%& expansion condition"
11509 .cindex "&%lti%& expansion condition"
11510 The two substrings are first expanded. The condition is true if the first
11511 string is lexically less than the second string. For &%lt%& the comparison
11512 includes the case of letters, whereas for &%lti%& the comparison is
11513 case-independent.
11514 Case and collation order are defined per the system C locale.
11515
11516
11517 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11518 .cindex "expansion" "regular expression comparison"
11519 .cindex "regular expressions" "match in expanded string"
11520 .cindex "&%match%& expansion condition"
11521 The two substrings are first expanded. The second is then treated as a regular
11522 expression and applied to the first. Because of the pre-expansion, if the
11523 regular expression contains dollar, or backslash characters, they must be
11524 escaped. Care must also be taken if the regular expression contains braces
11525 (curly brackets). A closing brace must be escaped so that it is not taken as a
11526 premature termination of <&'string2'&>. The easiest approach is to use the
11527 &`\N`& feature to disable expansion of the regular expression.
11528 For example,
11529 .code
11530 ${if match {$local_part}{\N^\d{3}\N} ...
11531 .endd
11532 If the whole expansion string is in double quotes, further escaping of
11533 backslashes is also required.
11534
11535 The condition is true if the regular expression match succeeds.
11536 The regular expression is not required to begin with a circumflex
11537 metacharacter, but if there is no circumflex, the expression is not anchored,
11538 and it may match anywhere in the subject, not just at the start. If you want
11539 the pattern to match at the end of the subject, you must include the &`$`&
11540 metacharacter at an appropriate point.
11541 All character handling is done in bytes and is not UTF-8 aware,
11542 but we might change this in a future Exim release.
11543
11544 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11545 At the start of an &%if%& expansion the values of the numeric variable
11546 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11547 succeeds causes them to be reset to the substrings of that condition and they
11548 will have these values during the expansion of the success string. At the end
11549 of the &%if%& expansion, the previous values are restored. After testing a
11550 combination of conditions using &%or%&, the subsequent values of the numeric
11551 variables are those of the condition that succeeded.
11552
11553 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11554 .cindex "&%match_address%& expansion condition"
11555 See &*match_local_part*&.
11556
11557 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11558 .cindex "&%match_domain%& expansion condition"
11559 See &*match_local_part*&.
11560
11561 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11562 .cindex "&%match_ip%& expansion condition"
11563 This condition matches an IP address to a list of IP address patterns. It must
11564 be followed by two argument strings. The first (after expansion) must be an IP
11565 address or an empty string. The second (not expanded) is a restricted host
11566 list that can match only an IP address, not a host name. For example:
11567 .code
11568 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11569 .endd
11570 The specific types of host list item that are permitted in the list are:
11571
11572 .ilist
11573 An IP address, optionally with a CIDR mask.
11574 .next
11575 A single asterisk, which matches any IP address.
11576 .next
11577 An empty item, which matches only if the IP address is empty. This could be
11578 useful for testing for a locally submitted message or one from specific hosts
11579 in a single test such as
11580 . ==== As this is a nested list, any displays it contains must be indented
11581 . ==== as otherwise they are too far to the left. This comment applies to
11582 . ==== the use of xmlto plus fop. There's no problem when formatting with
11583 . ==== sdop, with or without the extra indent.
11584 .code
11585   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11586 .endd
11587 where the first item in the list is the empty string.
11588 .next
11589 The item @[] matches any of the local host's interface addresses.
11590 .next
11591 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11592 even if &`net-`& is not specified. There is never any attempt to turn the IP
11593 address into a host name. The most common type of linear search for
11594 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11595 masks. For example:
11596 .code
11597   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11598 .endd
11599 It is of course possible to use other kinds of lookup, and in such a case, you
11600 do need to specify the &`net-`& prefix if you want to specify a specific
11601 address mask, for example:
11602 .code
11603   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11604 .endd
11605 However, unless you are combining a &%match_ip%& condition with others, it is
11606 just as easy to use the fact that a lookup is itself a condition, and write:
11607 .code
11608   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11609 .endd
11610 .endlist ilist
11611
11612 Note that <&'string2'&> is not itself subject to string expansion, unless
11613 Exim was built with the EXPAND_LISTMATCH_RHS option.
11614
11615 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11616
11617 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11618 .cindex "domain list" "in expansion condition"
11619 .cindex "address list" "in expansion condition"
11620 .cindex "local part" "list, in expansion condition"
11621 .cindex "&%match_local_part%& expansion condition"
11622 This condition, together with &%match_address%& and &%match_domain%&, make it
11623 possible to test domain, address, and local part lists within expansions. Each
11624 condition requires two arguments: an item and a list to match. A trivial
11625 example is:
11626 .code
11627 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11628 .endd
11629 In each case, the second argument may contain any of the allowable items for a
11630 list of the appropriate type. Also, because the second argument
11631 is a standard form of list, it is possible to refer to a named list.
11632 Thus, you can use conditions like this:
11633 .code
11634 ${if match_domain{$domain}{+local_domains}{...
11635 .endd
11636 .cindex "&`+caseful`&"
11637 For address lists, the matching starts off caselessly, but the &`+caseful`&
11638 item can be used, as in all address lists, to cause subsequent items to
11639 have their local parts matched casefully. Domains are always matched
11640 caselessly.
11641
11642 Note that <&'string2'&> is not itself subject to string expansion, unless
11643 Exim was built with the EXPAND_LISTMATCH_RHS option.
11644
11645 &*Note*&: Host lists are &'not'& supported in this way. This is because
11646 hosts have two identities: a name and an IP address, and it is not clear
11647 how to specify cleanly how such a test would work. However, IP addresses can be
11648 matched using &%match_ip%&.
11649
11650 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11651 .cindex "PAM authentication"
11652 .cindex "AUTH" "with PAM"
11653 .cindex "Solaris" "PAM support"
11654 .cindex "expansion" "PAM authentication test"
11655 .cindex "&%pam%& expansion condition"
11656 &'Pluggable Authentication Modules'&
11657 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11658 available in the latest releases of Solaris and in some GNU/Linux
11659 distributions. The Exim support, which is intended for use in conjunction with
11660 the SMTP AUTH command, is available only if Exim is compiled with
11661 .code
11662 SUPPORT_PAM=yes
11663 .endd
11664 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11665 in some releases of GNU/Linux &%-ldl%& is also needed.
11666
11667 The argument string is first expanded, and the result must be a
11668 colon-separated list of strings. Leading and trailing white space is ignored.
11669 The PAM module is initialized with the service name &"exim"& and the user name
11670 taken from the first item in the colon-separated data string (<&'string1'&>).
11671 The remaining items in the data string are passed over in response to requests
11672 from the authentication function. In the simple case there will only be one
11673 request, for a password, so the data consists of just two strings.
11674
11675 There can be problems if any of the strings are permitted to contain colon
11676 characters. In the usual way, these have to be doubled to avoid being taken as
11677 separators. If the data is being inserted from a variable, the &%sg%& expansion
11678 item can be used to double any existing colons. For example, the configuration
11679 of a LOGIN authenticator might contain this setting:
11680 .code
11681 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11682 .endd
11683 For a PLAIN authenticator you could use:
11684 .code
11685 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11686 .endd
11687 In some operating systems, PAM authentication can be done only from a process
11688 running as root. Since Exim is running as the Exim user when receiving
11689 messages, this means that PAM cannot be used directly in those systems.
11690 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11691
11692
11693 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11694 .cindex "&'pwcheck'& daemon"
11695 .cindex "Cyrus"
11696 .cindex "expansion" "&'pwcheck'& authentication test"
11697 .cindex "&%pwcheck%& expansion condition"
11698 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11699 This is one way of making it possible for passwords to be checked by a process
11700 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11701 deprecated. Its replacement is &'saslauthd'& (see below).
11702
11703 The pwcheck support is not included in Exim by default. You need to specify
11704 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11705 building Exim. For example:
11706 .code
11707 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11708 .endd
11709 You do not need to install the full Cyrus software suite in order to use
11710 the pwcheck daemon. You can compile and install just the daemon alone
11711 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11712 access to the &_/var/pwcheck_& directory.
11713
11714 The &%pwcheck%& condition takes one argument, which must be the user name and
11715 password, separated by a colon. For example, in a LOGIN authenticator
11716 configuration, you might have this:
11717 .code
11718 server_condition = ${if pwcheck{$auth1:$auth2}}
11719 .endd
11720 Again, for a PLAIN authenticator configuration, this would be:
11721 .code
11722 server_condition = ${if pwcheck{$auth2:$auth3}}
11723 .endd
11724 .vitem &*queue_running*&
11725 .cindex "queue runner" "detecting when delivering from"
11726 .cindex "expansion" "queue runner test"
11727 .cindex "&%queue_running%& expansion condition"
11728 This condition, which has no data, is true during delivery attempts that are
11729 initiated by queue runner processes, and false otherwise.
11730
11731
11732 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11733 .cindex "Radius"
11734 .cindex "expansion" "Radius authentication"
11735 .cindex "&%radius%& expansion condition"
11736 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11737 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11738 the Radius client configuration file in order to build Exim with Radius
11739 support.
11740
11741 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11742 library, using the original API. If you are using release 0.4.0 or later of
11743 this library, you need to set
11744 .code
11745 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11746 .endd
11747 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11748 &%libradius%& library that comes with FreeBSD. To do this, set
11749 .code
11750 RADIUS_LIB_TYPE=RADLIB
11751 .endd
11752 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11753 You may also have to supply a suitable setting in EXTRALIBS so that the
11754 Radius library can be found when Exim is linked.
11755
11756 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11757 Radius client library, which calls the Radius server. The condition is true if
11758 the authentication is successful. For example:
11759 .code
11760 server_condition = ${if radius{<arguments>}}
11761 .endd
11762
11763
11764 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11765         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11766 .cindex "&'saslauthd'& daemon"
11767 .cindex "Cyrus"
11768 .cindex "expansion" "&'saslauthd'& authentication test"
11769 .cindex "&%saslauthd%& expansion condition"
11770 This condition supports user authentication using the Cyrus &'saslauthd'&
11771 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11772 Using this daemon is one way of making it possible for passwords to be checked
11773 by a process that is not running as root.
11774
11775 The saslauthd support is not included in Exim by default. You need to specify
11776 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11777 building Exim. For example:
11778 .code
11779 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11780 .endd
11781 You do not need to install the full Cyrus software suite in order to use
11782 the saslauthd daemon. You can compile and install just the daemon alone
11783 from the Cyrus SASL library.
11784
11785 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11786 two are mandatory. For example:
11787 .code
11788 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11789 .endd
11790 The service and the realm are optional (which is why the arguments are enclosed
11791 in their own set of braces). For details of the meaning of the service and
11792 realm, and how to run the daemon, consult the Cyrus documentation.
11793 .endlist vlist
11794
11795
11796
11797 .section "Combining expansion conditions" "SECID84"
11798 .cindex "expansion" "combining conditions"
11799 Several conditions can be tested at once by combining them using the &%and%&
11800 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11801 conditions on their own, and precede their lists of sub-conditions. Each
11802 sub-condition must be enclosed in braces within the overall braces that contain
11803 the list. No repetition of &%if%& is used.
11804
11805
11806 .vlist
11807 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11808 .cindex "&""or""& expansion condition"
11809 .cindex "expansion" "&""or""& of conditions"
11810 The sub-conditions are evaluated from left to right. The condition is true if
11811 any one of the sub-conditions is true.
11812 For example,
11813 .code
11814 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11815 .endd
11816 When a true sub-condition is found, the following ones are parsed but not
11817 evaluated. If there are several &"match"& sub-conditions the values of the
11818 numeric variables afterwards are taken from the first one that succeeds.
11819
11820 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11821 .cindex "&""and""& expansion condition"
11822 .cindex "expansion" "&""and""& of conditions"
11823 The sub-conditions are evaluated from left to right. The condition is true if
11824 all of the sub-conditions are true. If there are several &"match"&
11825 sub-conditions, the values of the numeric variables afterwards are taken from
11826 the last one. When a false sub-condition is found, the following ones are
11827 parsed but not evaluated.
11828 .endlist
11829 .ecindex IIDexpcond
11830
11831
11832
11833
11834 .section "Expansion variables" "SECTexpvar"
11835 .cindex "expansion" "variables, list of"
11836 This section contains an alphabetical list of all the expansion variables. Some
11837 of them are available only when Exim is compiled with specific options such as
11838 support for TLS or the content scanning extension.
11839
11840 .vlist
11841 .vitem "&$0$&, &$1$&, etc"
11842 .cindex "numerical variables (&$1$& &$2$& etc)"
11843 When a &%match%& expansion condition succeeds, these variables contain the
11844 captured substrings identified by the regular expression during subsequent
11845 processing of the success string of the containing &%if%& expansion item.
11846 In the expansion condition case
11847 they do not retain their values afterwards; in fact, their previous
11848 values are restored at the end of processing an &%if%& item. The numerical
11849 variables may also be set externally by some other matching process which
11850 precedes the expansion of the string. For example, the commands available in
11851 Exim filter files include an &%if%& command with its own regular expression
11852 matching condition.
11853
11854 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11855 Within an acl condition, expansion condition or expansion item
11856 any arguments are copied to these variables,
11857 any unused variables being made empty.
11858
11859 .vitem "&$acl_c...$&"
11860 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11861 can be given any name that starts with &$acl_c$& and is at least six characters
11862 long, but the sixth character must be either a digit or an underscore. For
11863 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11864 variables persist throughout the lifetime of an SMTP connection. They can be
11865 used to pass information between ACLs and between different invocations of the
11866 same ACL. When a message is received, the values of these variables are saved
11867 with the message, and can be accessed by filters, routers, and transports
11868 during subsequent delivery.
11869
11870 .vitem "&$acl_m...$&"
11871 These variables are like the &$acl_c...$& variables, except that their values
11872 are reset after a message has been received. Thus, if several messages are
11873 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11874 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11875 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11876 message is received, the values of these variables are saved with the message,
11877 and can be accessed by filters, routers, and transports during subsequent
11878 delivery.
11879
11880 .vitem &$acl_narg$&
11881 Within an acl condition, expansion condition or expansion item
11882 this variable has the number of arguments.
11883
11884 .vitem &$acl_verify_message$&
11885 .vindex "&$acl_verify_message$&"
11886 After an address verification has failed, this variable contains the failure
11887 message. It retains its value for use in subsequent modifiers. The message can
11888 be preserved by coding like this:
11889 .code
11890 warn !verify = sender
11891      set acl_m0 = $acl_verify_message
11892 .endd
11893 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11894 &%log_message%& modifiers, to include information about the verification
11895 failure.
11896
11897 .vitem &$address_data$&
11898 .vindex "&$address_data$&"
11899 This variable is set by means of the &%address_data%& option in routers. The
11900 value then remains with the address while it is processed by subsequent routers
11901 and eventually a transport. If the transport is handling multiple addresses,
11902 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11903 for more details. &*Note*&: The contents of &$address_data$& are visible in
11904 user filter files.
11905
11906 If &$address_data$& is set when the routers are called from an ACL to verify
11907 a recipient address, the final value is still in the variable for subsequent
11908 conditions and modifiers of the ACL statement. If routing the address caused it
11909 to be redirected to just one address, the child address is also routed as part
11910 of the verification, and in this case the final value of &$address_data$& is
11911 from the child's routing.
11912
11913 If &$address_data$& is set when the routers are called from an ACL to verify a
11914 sender address, the final value is also preserved, but this time in
11915 &$sender_address_data$&, to distinguish it from data from a recipient
11916 address.
11917
11918 In both cases (recipient and sender verification), the value does not persist
11919 after the end of the current ACL statement. If you want to preserve
11920 these values for longer, you can save them in ACL variables.
11921
11922 .vitem &$address_file$&
11923 .vindex "&$address_file$&"
11924 When, as a result of aliasing, forwarding, or filtering, a message is directed
11925 to a specific file, this variable holds the name of the file when the transport
11926 is running. At other times, the variable is empty. For example, using the
11927 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11928 .code
11929 /home/r2d2/savemail
11930 .endd
11931 then when the &(address_file)& transport is running, &$address_file$&
11932 contains the text string &`/home/r2d2/savemail`&.
11933 .cindex "Sieve filter" "value of &$address_file$&"
11934 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11935 then up to the transport configuration to generate an appropriate absolute path
11936 to the relevant file.
11937
11938 .vitem &$address_pipe$&
11939 .vindex "&$address_pipe$&"
11940 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11941 this variable holds the pipe command when the transport is running.
11942
11943 .vitem "&$auth1$& &-- &$auth3$&"
11944 .vindex "&$auth1$&, &$auth2$&, etc"
11945 These variables are used in SMTP authenticators (see chapters
11946 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11947
11948 .vitem &$authenticated_id$&
11949 .cindex "authentication" "id"
11950 .vindex "&$authenticated_id$&"
11951 When a server successfully authenticates a client it may be configured to
11952 preserve some of the authentication information in the variable
11953 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11954 user/password authenticator configuration might preserve the user name for use
11955 in the routers. Note that this is not the same information that is saved in
11956 &$sender_host_authenticated$&.
11957
11958 When a message is submitted locally (that is, not over a TCP connection)
11959 the value of &$authenticated_id$& is normally the login name of the calling
11960 process. However, a trusted user can override this by means of the &%-oMai%&
11961 command line option.
11962 This second case also sets up information used by the
11963 &$authresults$& expansion item.
11964
11965 .vitem &$authenticated_fail_id$&
11966 .cindex "authentication" "fail" "id"
11967 .vindex "&$authenticated_fail_id$&"
11968 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11969 will contain the failed authentication id. If more than one authentication
11970 id is attempted, it will contain only the last one. The variable is
11971 available for processing in the ACL's, generally the quit or notquit ACL.
11972 A message to a local recipient could still be accepted without requiring
11973 authentication, which means this variable could also be visible in all of
11974 the ACL's as well.
11975
11976
11977 .vitem &$authenticated_sender$&
11978 .cindex "sender" "authenticated"
11979 .cindex "authentication" "sender"
11980 .cindex "AUTH" "on MAIL command"
11981 .vindex "&$authenticated_sender$&"
11982 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11983 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11984 described in section &<<SECTauthparamail>>&. Unless the data is the string
11985 &"<>"&, it is set as the authenticated sender of the message, and the value is
11986 available during delivery in the &$authenticated_sender$& variable. If the
11987 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11988
11989 .vindex "&$qualify_domain$&"
11990 When a message is submitted locally (that is, not over a TCP connection), the
11991 value of &$authenticated_sender$& is an address constructed from the login
11992 name of the calling process and &$qualify_domain$&, except that a trusted user
11993 can override this by means of the &%-oMas%& command line option.
11994
11995
11996 .vitem &$authentication_failed$&
11997 .cindex "authentication" "failure"
11998 .vindex "&$authentication_failed$&"
11999 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12000 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12001 possible to distinguish between &"did not try to authenticate"&
12002 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12003 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12004 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12005 negative response to an AUTH command, including (for example) an attempt to use
12006 an undefined mechanism.
12007
12008 .vitem &$av_failed$&
12009 .cindex "content scanning" "AV scanner failure"
12010 This variable is available when Exim is compiled with the content-scanning
12011 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12012 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12013 the ACL malware condition.
12014
12015 .vitem &$body_linecount$&
12016 .cindex "message body" "line count"
12017 .cindex "body of message" "line count"
12018 .vindex "&$body_linecount$&"
12019 When a message is being received or delivered, this variable contains the
12020 number of lines in the message's body. See also &$message_linecount$&.
12021
12022 .vitem &$body_zerocount$&
12023 .cindex "message body" "binary zero count"
12024 .cindex "body of message" "binary zero count"
12025 .cindex "binary zero" "in message body"
12026 .vindex "&$body_zerocount$&"
12027 When a message is being received or delivered, this variable contains the
12028 number of binary zero bytes (ASCII NULs) in the message's body.
12029
12030 .vitem &$bounce_recipient$&
12031 .vindex "&$bounce_recipient$&"
12032 This is set to the recipient address of a bounce message while Exim is creating
12033 it. It is useful if a customized bounce message text file is in use (see
12034 chapter &<<CHAPemsgcust>>&).
12035
12036 .vitem &$bounce_return_size_limit$&
12037 .vindex "&$bounce_return_size_limit$&"
12038 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12039 up to a multiple of 1000. It is useful when a customized error message text
12040 file is in use (see chapter &<<CHAPemsgcust>>&).
12041
12042 .vitem &$caller_gid$&
12043 .cindex "gid (group id)" "caller"
12044 .vindex "&$caller_gid$&"
12045 The real group id under which the process that called Exim was running. This is
12046 not the same as the group id of the originator of a message (see
12047 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12048 incarnation normally contains the Exim gid.
12049
12050 .vitem &$caller_uid$&
12051 .cindex "uid (user id)" "caller"
12052 .vindex "&$caller_uid$&"
12053 The real user id under which the process that called Exim was running. This is
12054 not the same as the user id of the originator of a message (see
12055 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12056 incarnation normally contains the Exim uid.
12057
12058 .vitem &$callout_address$&
12059 .vindex "&$callout_address$&"
12060 After a callout for verification, spamd or malware daemon service, the
12061 address that was connected to.
12062
12063 .vitem &$compile_number$&
12064 .vindex "&$compile_number$&"
12065 The building process for Exim keeps a count of the number
12066 of times it has been compiled. This serves to distinguish different
12067 compilations of the same version of Exim.
12068
12069 .vitem &$config_dir$&
12070 .vindex "&$config_dir$&"
12071 The directory name of the main configuration file. That is, the content of
12072 &$config_file$& with the last component stripped. The value does not
12073 contain the trailing slash. If &$config_file$& does not contain a slash,
12074 &$config_dir$& is ".".
12075
12076 .vitem &$config_file$&
12077 .vindex "&$config_file$&"
12078 The name of the main configuration file Exim is using.
12079
12080 .vitem &$dkim_verify_status$&
12081 Results of DKIM verification.
12082 For details see section &<<SECDKIMVFY>>&.
12083
12084 .vitem &$dkim_cur_signer$& &&&
12085        &$dkim_verify_reason$& &&&
12086        &$dkim_domain$& &&&
12087        &$dkim_identity$& &&&
12088        &$dkim_selector$& &&&
12089        &$dkim_algo$& &&&
12090        &$dkim_canon_body$& &&&
12091        &$dkim_canon_headers$& &&&
12092        &$dkim_copiedheaders$& &&&
12093        &$dkim_bodylength$& &&&
12094        &$dkim_created$& &&&
12095        &$dkim_expires$& &&&
12096        &$dkim_headernames$& &&&
12097        &$dkim_key_testing$& &&&
12098        &$dkim_key_nosubdomains$& &&&
12099        &$dkim_key_srvtype$& &&&
12100        &$dkim_key_granularity$& &&&
12101        &$dkim_key_notes$& &&&
12102        &$dkim_key_length$&
12103 These variables are only available within the DKIM ACL.
12104 For details see section &<<SECDKIMVFY>>&.
12105
12106 .vitem &$dkim_signers$&
12107 .vindex &$dkim_signers$&
12108 When a message has been received this variable contains
12109 a colon-separated list of signer domains and identities for the message.
12110 For details see section &<<SECDKIMVFY>>&.
12111
12112 .vitem &$dnslist_domain$& &&&
12113        &$dnslist_matched$& &&&
12114        &$dnslist_text$& &&&
12115        &$dnslist_value$&
12116 .vindex "&$dnslist_domain$&"
12117 .vindex "&$dnslist_matched$&"
12118 .vindex "&$dnslist_text$&"
12119 .vindex "&$dnslist_value$&"
12120 .cindex "black list (DNS)"
12121 When a DNS (black) list lookup succeeds, these variables are set to contain
12122 the following data from the lookup: the list's domain name, the key that was
12123 looked up, the contents of any associated TXT record, and the value from the
12124 main A record. See section &<<SECID204>>& for more details.
12125
12126 .vitem &$domain$&
12127 .vindex "&$domain$&"
12128 When an address is being routed, or delivered on its own, this variable
12129 contains the domain. Uppercase letters in the domain are converted into lower
12130 case for &$domain$&.
12131
12132 Global address rewriting happens when a message is received, so the value of
12133 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12134 is set during user filtering, but not during system filtering, because a
12135 message may have many recipients and the system filter is called just once.
12136
12137 When more than one address is being delivered at once (for example, several
12138 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12139 have the same domain. Transports can be restricted to handling only one domain
12140 at a time if the value of &$domain$& is required at transport time &-- this is
12141 the default for local transports. For further details of the environment in
12142 which local transports are run, see chapter &<<CHAPenvironment>>&.
12143
12144 .oindex "&%delay_warning_condition%&"
12145 At the end of a delivery, if all deferred addresses have the same domain, it is
12146 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12147
12148 The &$domain$& variable is also used in some other circumstances:
12149
12150 .ilist
12151 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12152 the recipient address. The domain of the &'sender'& address is in
12153 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12154 normally set during the running of the MAIL ACL. However, if the sender address
12155 is verified with a callout during the MAIL ACL, the sender domain is placed in
12156 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12157 the &(smtp)& transport.
12158
12159 .next
12160 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12161 &$domain$& contains the domain portion of the address that is being rewritten;
12162 it can be used in the expansion of the replacement address, for example, to
12163 rewrite domains by file lookup.
12164
12165 .next
12166 With one important exception, whenever a domain list is being scanned,
12167 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12168 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12169 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12170 that, in a RCPT ACL, the sender domain list can be dependent on the
12171 recipient domain (which is what is in &$domain$& at this time).
12172
12173 .next
12174 .cindex "ETRN" "value of &$domain$&"
12175 .oindex "&%smtp_etrn_command%&"
12176 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12177 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12178 .endlist
12179
12180
12181 .vitem &$domain_data$&
12182 .vindex "&$domain_data$&"
12183 When the &%domains%& option on a router matches a domain by
12184 means of a lookup, the data read by the lookup is available during the running
12185 of the router as &$domain_data$&. In addition, if the driver routes the
12186 address to a transport, the value is available in that transport. If the
12187 transport is handling multiple addresses, the value from the first address is
12188 used.
12189
12190 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12191 domain by means of a lookup. The data read by the lookup is available during
12192 the rest of the ACL statement. In all other situations, this variable expands
12193 to nothing.
12194
12195 .vitem &$exim_gid$&
12196 .vindex "&$exim_gid$&"
12197 This variable contains the numerical value of the Exim group id.
12198
12199 .vitem &$exim_path$&
12200 .vindex "&$exim_path$&"
12201 This variable contains the path to the Exim binary.
12202
12203 .vitem &$exim_uid$&
12204 .vindex "&$exim_uid$&"
12205 This variable contains the numerical value of the Exim user id.
12206
12207 .vitem &$exim_version$&
12208 .vindex "&$exim_version$&"
12209 This variable contains the version string of the Exim build.
12210 The first character is a major version number, currently 4.
12211 Then after a dot, the next group of digits is a minor version number.
12212 There may be other characters following the minor version.
12213 This value may be overridden by the &%exim_version%& main config option.
12214
12215 .vitem &$header_$&<&'name'&>
12216 This is not strictly an expansion variable. It is expansion syntax for
12217 inserting the message header line with the given name. Note that the name must
12218 be terminated by colon or white space, because it may contain a wide variety of
12219 characters. Note also that braces must &'not'& be used.
12220 See the full description in section &<<SECTexpansionitems>>& above.
12221
12222 .vitem &$headers_added$&
12223 .vindex "&$headers_added$&"
12224 Within an ACL this variable contains the headers added so far by
12225 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12226 The headers are a newline-separated list.
12227
12228 .vitem &$home$&
12229 .vindex "&$home$&"
12230 When the &%check_local_user%& option is set for a router, the user's home
12231 directory is placed in &$home$& when the check succeeds. In particular, this
12232 means it is set during the running of users' filter files. A router may also
12233 explicitly set a home directory for use by a transport; this can be overridden
12234 by a setting on the transport itself.
12235
12236 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12237 of the environment variable HOME, which is subject to the
12238 &%keep_environment%& and &%add_environment%& main config options.
12239
12240 .vitem &$host$&
12241 .vindex "&$host$&"
12242 If a router assigns an address to a transport (any transport), and passes a
12243 list of hosts with the address, the value of &$host$& when the transport starts
12244 to run is the name of the first host on the list. Note that this applies both
12245 to local and remote transports.
12246
12247 .cindex "transport" "filter"
12248 .cindex "filter" "transport filter"
12249 For the &(smtp)& transport, if there is more than one host, the value of
12250 &$host$& changes as the transport works its way through the list. In
12251 particular, when the &(smtp)& transport is expanding its options for encryption
12252 using TLS, or for specifying a transport filter (see chapter
12253 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12254 is connected.
12255
12256 When used in the client part of an authenticator configuration (see chapter
12257 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12258 client is connected.
12259
12260
12261 .vitem &$host_address$&
12262 .vindex "&$host_address$&"
12263 This variable is set to the remote host's IP address whenever &$host$& is set
12264 for a remote connection. It is also set to the IP address that is being checked
12265 when the &%ignore_target_hosts%& option is being processed.
12266
12267 .vitem &$host_data$&
12268 .vindex "&$host_data$&"
12269 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12270 result of the lookup is made available in the &$host_data$& variable. This
12271 allows you, for example, to do things like this:
12272 .code
12273 deny  hosts = net-lsearch;/some/file
12274 message = $host_data
12275 .endd
12276 .vitem &$host_lookup_deferred$&
12277 .cindex "host name" "lookup, failure of"
12278 .vindex "&$host_lookup_deferred$&"
12279 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12280 message comes from a remote host and there is an attempt to look up the host's
12281 name from its IP address, and the attempt is not successful, one of these
12282 variables is set to &"1"&.
12283
12284 .ilist
12285 If the lookup receives a definite negative response (for example, a DNS lookup
12286 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12287
12288 .next
12289 If there is any kind of problem during the lookup, such that Exim cannot
12290 tell whether or not the host name is defined (for example, a timeout for a DNS
12291 lookup), &$host_lookup_deferred$& is set to &"1"&.
12292 .endlist ilist
12293
12294 Looking up a host's name from its IP address consists of more than just a
12295 single reverse lookup. Exim checks that a forward lookup of at least one of the
12296 names it receives from a reverse lookup yields the original IP address. If this
12297 is not the case, Exim does not accept the looked up name(s), and
12298 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12299 IP address (for example, the existence of a PTR record in the DNS) is not
12300 sufficient on its own for the success of a host name lookup. If the reverse
12301 lookup succeeds, but there is a lookup problem such as a timeout when checking
12302 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12303 &"1"&. See also &$sender_host_name$&.
12304
12305 .cindex authentication "expansion item"
12306 Performing these checks sets up information used by the
12307 &$authresults$& expansion item.
12308
12309
12310 .vitem &$host_lookup_failed$&
12311 .vindex "&$host_lookup_failed$&"
12312 See &$host_lookup_deferred$&.
12313
12314 .vitem &$host_port$&
12315 .vindex "&$host_port$&"
12316 This variable is set to the remote host's TCP port whenever &$host$& is set
12317 for an outbound connection.
12318
12319 .vitem &$initial_cwd$&
12320 .vindex "&$initial_cwd$&
12321 This variable contains the full path name of the initial working
12322 directory of the current Exim process. This may differ from the current
12323 working directory, as Exim changes this to "/" during early startup, and
12324 to &$spool_directory$& later.
12325
12326 .vitem &$inode$&
12327 .vindex "&$inode$&"
12328 The only time this variable is set is while expanding the &%directory_file%&
12329 option in the &(appendfile)& transport. The variable contains the inode number
12330 of the temporary file which is about to be renamed. It can be used to construct
12331 a unique name for the file.
12332
12333 .vitem &$interface_address$&
12334 .vindex "&$interface_address$&"
12335 This is an obsolete name for &$received_ip_address$&.
12336
12337 .vitem &$interface_port$&
12338 .vindex "&$interface_port$&"
12339 This is an obsolete name for &$received_port$&.
12340
12341 .vitem &$item$&
12342 .vindex "&$item$&"
12343 This variable is used during the expansion of &*forall*& and &*forany*&
12344 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12345 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12346 empty.
12347
12348 .vitem &$ldap_dn$&
12349 .vindex "&$ldap_dn$&"
12350 This variable, which is available only when Exim is compiled with LDAP support,
12351 contains the DN from the last entry in the most recently successful LDAP
12352 lookup.
12353
12354 .vitem &$load_average$&
12355 .vindex "&$load_average$&"
12356 This variable contains the system load average, multiplied by 1000 so that it
12357 is an integer. For example, if the load average is 0.21, the value of the
12358 variable is 210. The value is recomputed every time the variable is referenced.
12359
12360 .vitem &$local_part$&
12361 .vindex "&$local_part$&"
12362 When an address is being routed, or delivered on its own, this
12363 variable contains the local part. When a number of addresses are being
12364 delivered together (for example, multiple RCPT commands in an SMTP
12365 session), &$local_part$& is not set.
12366
12367 Global address rewriting happens when a message is received, so the value of
12368 &$local_part$& during routing and delivery is the value after rewriting.
12369 &$local_part$& is set during user filtering, but not during system filtering,
12370 because a message may have many recipients and the system filter is called just
12371 once.
12372
12373 .vindex "&$local_part_prefix$&"
12374 .vindex "&$local_part_suffix$&"
12375 .cindex affix variables
12376 If a local part prefix or suffix has been recognized, it is not included in the
12377 value of &$local_part$& during routing and subsequent delivery. The values of
12378 any prefix or suffix are in &$local_part_prefix$& and
12379 &$local_part_suffix$&, respectively.
12380
12381 When a message is being delivered to a file, pipe, or autoreply transport as a
12382 result of aliasing or forwarding, &$local_part$& is set to the local part of
12383 the parent address, not to the filename or command (see &$address_file$& and
12384 &$address_pipe$&).
12385
12386 When an ACL is running for a RCPT command, &$local_part$& contains the
12387 local part of the recipient address.
12388
12389 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12390 &$local_part$& contains the local part of the address that is being rewritten;
12391 it can be used in the expansion of the replacement address, for example.
12392
12393 In all cases, all quoting is removed from the local part. For example, for both
12394 the addresses
12395 .code
12396 "abc:xyz"@test.example
12397 abc\:xyz@test.example
12398 .endd
12399 the value of &$local_part$& is
12400 .code
12401 abc:xyz
12402 .endd
12403 If you use &$local_part$& to create another address, you should always wrap it
12404 inside a quoting operator. For example, in a &(redirect)& router you could
12405 have:
12406 .code
12407 data = ${quote_local_part:$local_part}@new.domain.example
12408 .endd
12409 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12410 to process local parts in a case-dependent manner in a router, you can set the
12411 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12412
12413 .vitem &$local_part_data$&
12414 .vindex "&$local_part_data$&"
12415 When the &%local_parts%& option on a router matches a local part by means of a
12416 lookup, the data read by the lookup is available during the running of the
12417 router as &$local_part_data$&. In addition, if the driver routes the address
12418 to a transport, the value is available in that transport. If the transport is
12419 handling multiple addresses, the value from the first address is used.
12420
12421 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12422 matches a local part by means of a lookup. The data read by the lookup is
12423 available during the rest of the ACL statement. In all other situations, this
12424 variable expands to nothing.
12425
12426 .vitem &$local_part_prefix$&
12427 .vindex "&$local_part_prefix$&"
12428 .cindex affix variables
12429 When an address is being routed or delivered, and a
12430 specific prefix for the local part was recognized, it is available in this
12431 variable, having been removed from &$local_part$&.
12432
12433 .vitem &$local_part_suffix$&
12434 .vindex "&$local_part_suffix$&"
12435 When an address is being routed or delivered, and a
12436 specific suffix for the local part was recognized, it is available in this
12437 variable, having been removed from &$local_part$&.
12438
12439 .vitem &$local_scan_data$&
12440 .vindex "&$local_scan_data$&"
12441 This variable contains the text returned by the &[local_scan()]& function when
12442 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12443
12444 .vitem &$local_user_gid$&
12445 .vindex "&$local_user_gid$&"
12446 See &$local_user_uid$&.
12447
12448 .vitem &$local_user_uid$&
12449 .vindex "&$local_user_uid$&"
12450 This variable and &$local_user_gid$& are set to the uid and gid after the
12451 &%check_local_user%& router precondition succeeds. This means that their values
12452 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12453 and &%condition%&), for the &%address_data%& expansion, and for any
12454 router-specific expansions. At all other times, the values in these variables
12455 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12456
12457 .vitem &$localhost_number$&
12458 .vindex "&$localhost_number$&"
12459 This contains the expanded value of the
12460 &%localhost_number%& option. The expansion happens after the main options have
12461 been read.
12462
12463 .vitem &$log_inodes$&
12464 .vindex "&$log_inodes$&"
12465 The number of free inodes in the disk partition where Exim's
12466 log files are being written. The value is recalculated whenever the variable is
12467 referenced. If the relevant file system does not have the concept of inodes,
12468 the value of is -1. See also the &%check_log_inodes%& option.
12469
12470 .vitem &$log_space$&
12471 .vindex "&$log_space$&"
12472 The amount of free space (as a number of kilobytes) in the disk
12473 partition where Exim's log files are being written. The value is recalculated
12474 whenever the variable is referenced. If the operating system does not have the
12475 ability to find the amount of free space (only true for experimental systems),
12476 the space value is -1. See also the &%check_log_space%& option.
12477
12478
12479 .vitem &$lookup_dnssec_authenticated$&
12480 .vindex "&$lookup_dnssec_authenticated$&"
12481 This variable is set after a DNS lookup done by
12482 a dnsdb lookup expansion, dnslookup router or smtp transport.
12483 .cindex "DNS" "DNSSEC"
12484 It will be empty if &(DNSSEC)& was not requested,
12485 &"no"& if the result was not labelled as authenticated data
12486 and &"yes"& if it was.
12487 Results that are labelled as authoritative answer that match
12488 the &%dns_trust_aa%& configuration variable count also
12489 as authenticated data.
12490
12491 .vitem &$mailstore_basename$&
12492 .vindex "&$mailstore_basename$&"
12493 This variable is set only when doing deliveries in &"mailstore"& format in the
12494 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12495 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12496 contains the basename of the files that are being written, that is, the name
12497 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12498 variable is empty.
12499
12500 .vitem &$malware_name$&
12501 .vindex "&$malware_name$&"
12502 This variable is available when Exim is compiled with the
12503 content-scanning extension. It is set to the name of the virus that was found
12504 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12505
12506 .vitem &$max_received_linelength$&
12507 .vindex "&$max_received_linelength$&"
12508 .cindex "maximum" "line length"
12509 .cindex "line length" "maximum"
12510 This variable contains the number of bytes in the longest line that was
12511 received as part of the message, not counting the line termination
12512 character(s).
12513 It is not valid if the &%spool_files_wireformat%& option is used.
12514
12515 .vitem &$message_age$&
12516 .cindex "message" "age of"
12517 .vindex "&$message_age$&"
12518 This variable is set at the start of a delivery attempt to contain the number
12519 of seconds since the message was received. It does not change during a single
12520 delivery attempt.
12521
12522 .vitem &$message_body$&
12523 .cindex "body of message" "expansion variable"
12524 .cindex "message body" "in expansion"
12525 .cindex "binary zero" "in message body"
12526 .vindex "&$message_body$&"
12527 .oindex "&%message_body_visible%&"
12528 This variable contains the initial portion of a message's body while it is
12529 being delivered, and is intended mainly for use in filter files. The maximum
12530 number of characters of the body that are put into the variable is set by the
12531 &%message_body_visible%& configuration option; the default is 500.
12532
12533 .oindex "&%message_body_newlines%&"
12534 By default, newlines are converted into spaces in &$message_body$&, to make it
12535 easier to search for phrases that might be split over a line break. However,
12536 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12537 zeros are always converted into spaces.
12538
12539 .vitem &$message_body_end$&
12540 .cindex "body of message" "expansion variable"
12541 .cindex "message body" "in expansion"
12542 .vindex "&$message_body_end$&"
12543 This variable contains the final portion of a message's
12544 body while it is being delivered. The format and maximum size are as for
12545 &$message_body$&.
12546
12547 .vitem &$message_body_size$&
12548 .cindex "body of message" "size"
12549 .cindex "message body" "size"
12550 .vindex "&$message_body_size$&"
12551 When a message is being delivered, this variable contains the size of the body
12552 in bytes. The count starts from the character after the blank line that
12553 separates the body from the header. Newlines are included in the count. See
12554 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12555
12556 If the spool file is wireformat
12557 (see the &%spool_files_wireformat%& main option)
12558 the CRLF line-terminators are included in the count.
12559
12560 .vitem &$message_exim_id$&
12561 .vindex "&$message_exim_id$&"
12562 When a message is being received or delivered, this variable contains the
12563 unique message id that is generated and used by Exim to identify the message.
12564 An id is not created for a message until after its header has been successfully
12565 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12566 line; it is the local id that Exim assigns to the message, for example:
12567 &`1BXTIK-0001yO-VA`&.
12568
12569 .vitem &$message_headers$&
12570 .vindex &$message_headers$&
12571 This variable contains a concatenation of all the header lines when a message
12572 is being processed, except for lines added by routers or transports. The header
12573 lines are separated by newline characters. Their contents are decoded in the
12574 same way as a header line that is inserted by &%bheader%&.
12575
12576 .vitem &$message_headers_raw$&
12577 .vindex &$message_headers_raw$&
12578 This variable is like &$message_headers$& except that no processing of the
12579 contents of header lines is done.
12580
12581 .vitem &$message_id$&
12582 This is an old name for &$message_exim_id$&. It is now deprecated.
12583
12584 .vitem &$message_linecount$&
12585 .vindex "&$message_linecount$&"
12586 This variable contains the total number of lines in the header and body of the
12587 message. Compare &$body_linecount$&, which is the count for the body only.
12588 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12589 number of lines received. Before delivery happens (that is, before filters,
12590 routers, and transports run) the count is increased to include the
12591 &'Received:'& header line that Exim standardly adds, and also any other header
12592 lines that are added by ACLs. The blank line that separates the message header
12593 from the body is not counted.
12594
12595 As with the special case of &$message_size$&, during the expansion of the
12596 appendfile transport's maildir_tag option in maildir format, the value of
12597 &$message_linecount$& is the precise size of the number of newlines in the
12598 file that has been written (minus one for the blank line between the
12599 header and the body).
12600
12601 Here is an example of the use of this variable in a DATA ACL:
12602 .code
12603 deny message   = Too many lines in message header
12604      condition = \
12605       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12606 .endd
12607 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12608 message has not yet been received.
12609
12610 This variable is not valid if the &%spool_files_wireformat%& option is used.
12611
12612 .vitem &$message_size$&
12613 .cindex "size" "of message"
12614 .cindex "message" "size"
12615 .vindex "&$message_size$&"
12616 When a message is being processed, this variable contains its size in bytes. In
12617 most cases, the size includes those headers that were received with the
12618 message, but not those (such as &'Envelope-to:'&) that are added to individual
12619 deliveries as they are written. However, there is one special case: during the
12620 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12621 doing a delivery in maildir format, the value of &$message_size$& is the
12622 precise size of the file that has been written. See also
12623 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12624
12625 .cindex "RCPT" "value of &$message_size$&"
12626 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12627 contains the size supplied on the MAIL command, or -1 if no size was given. The
12628 value may not, of course, be truthful.
12629
12630 .vitem &$mime_$&&'xxx'&
12631 A number of variables whose names start with &$mime$& are
12632 available when Exim is compiled with the content-scanning extension. For
12633 details, see section &<<SECTscanmimepart>>&.
12634
12635 .vitem "&$n0$& &-- &$n9$&"
12636 These variables are counters that can be incremented by means
12637 of the &%add%& command in filter files.
12638
12639 .vitem &$original_domain$&
12640 .vindex "&$domain$&"
12641 .vindex "&$original_domain$&"
12642 When a top-level address is being processed for delivery, this contains the
12643 same value as &$domain$&. However, if a &"child"& address (for example,
12644 generated by an alias, forward, or filter file) is being processed, this
12645 variable contains the domain of the original address (lower cased). This
12646 differs from &$parent_domain$& only when there is more than one level of
12647 aliasing or forwarding. When more than one address is being delivered in a
12648 single transport run, &$original_domain$& is not set.
12649
12650 If a new address is created by means of a &%deliver%& command in a system
12651 filter, it is set up with an artificial &"parent"& address. This has the local
12652 part &'system-filter'& and the default qualify domain.
12653
12654 .vitem &$original_local_part$&
12655 .vindex "&$local_part$&"
12656 .vindex "&$original_local_part$&"
12657 When a top-level address is being processed for delivery, this contains the
12658 same value as &$local_part$&, unless a prefix or suffix was removed from the
12659 local part, because &$original_local_part$& always contains the full local
12660 part. When a &"child"& address (for example, generated by an alias, forward, or
12661 filter file) is being processed, this variable contains the full local part of
12662 the original address.
12663
12664 If the router that did the redirection processed the local part
12665 case-insensitively, the value in &$original_local_part$& is in lower case.
12666 This variable differs from &$parent_local_part$& only when there is more than
12667 one level of aliasing or forwarding. When more than one address is being
12668 delivered in a single transport run, &$original_local_part$& is not set.
12669
12670 If a new address is created by means of a &%deliver%& command in a system
12671 filter, it is set up with an artificial &"parent"& address. This has the local
12672 part &'system-filter'& and the default qualify domain.
12673
12674 .vitem &$originator_gid$&
12675 .cindex "gid (group id)" "of originating user"
12676 .cindex "sender" "gid"
12677 .vindex "&$caller_gid$&"
12678 .vindex "&$originator_gid$&"
12679 This variable contains the value of &$caller_gid$& that was set when the
12680 message was received. For messages received via the command line, this is the
12681 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12682 normally the gid of the Exim user.
12683
12684 .vitem &$originator_uid$&
12685 .cindex "uid (user id)" "of originating user"
12686 .cindex "sender" "uid"
12687 .vindex "&$caller_uid$&"
12688 .vindex "&$originator_uid$&"
12689 The value of &$caller_uid$& that was set when the message was received. For
12690 messages received via the command line, this is the uid of the sending user.
12691 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12692 user.
12693
12694 .vitem &$parent_domain$&
12695 .vindex "&$parent_domain$&"
12696 This variable is similar to &$original_domain$& (see
12697 above), except that it refers to the immediately preceding parent address.
12698
12699 .vitem &$parent_local_part$&
12700 .vindex "&$parent_local_part$&"
12701 This variable is similar to &$original_local_part$&
12702 (see above), except that it refers to the immediately preceding parent address.
12703
12704 .vitem &$pid$&
12705 .cindex "pid (process id)" "of current process"
12706 .vindex "&$pid$&"
12707 This variable contains the current process id.
12708
12709 .vitem &$pipe_addresses$&
12710 .cindex "filter" "transport filter"
12711 .cindex "transport" "filter"
12712 .vindex "&$pipe_addresses$&"
12713 This is not an expansion variable, but is mentioned here because the string
12714 &`$pipe_addresses`& is handled specially in the command specification for the
12715 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12716 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12717 It cannot be used in general expansion strings, and provokes an &"unknown
12718 variable"& error if encountered.
12719
12720 .vitem &$primary_hostname$&
12721 .vindex "&$primary_hostname$&"
12722 This variable contains the value set by &%primary_hostname%& in the
12723 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12724 a single-component name, Exim calls &[gethostbyname()]& (or
12725 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12726 qualified host name. See also &$smtp_active_hostname$&.
12727
12728
12729 .vitem &$proxy_external_address$& &&&
12730        &$proxy_external_port$& &&&
12731        &$proxy_local_address$& &&&
12732        &$proxy_local_port$& &&&
12733        &$proxy_session$&
12734 These variables are only available when built with Proxy Protocol
12735 or SOCKS5 support.
12736 For details see chapter &<<SECTproxyInbound>>&.
12737
12738 .vitem &$prdr_requested$&
12739 .cindex "PRDR" "variable for"
12740 This variable is set to &"yes"& if PRDR was requested by the client for the
12741 current message, otherwise &"no"&.
12742
12743 .vitem &$prvscheck_address$&
12744 This variable is used in conjunction with the &%prvscheck%& expansion item,
12745 which is described in sections &<<SECTexpansionitems>>& and
12746 &<<SECTverifyPRVS>>&.
12747
12748 .vitem &$prvscheck_keynum$&
12749 This variable is used in conjunction with the &%prvscheck%& expansion item,
12750 which is described in sections &<<SECTexpansionitems>>& and
12751 &<<SECTverifyPRVS>>&.
12752
12753 .vitem &$prvscheck_result$&
12754 This variable is used in conjunction with the &%prvscheck%& expansion item,
12755 which is described in sections &<<SECTexpansionitems>>& and
12756 &<<SECTverifyPRVS>>&.
12757
12758 .vitem &$qualify_domain$&
12759 .vindex "&$qualify_domain$&"
12760 The value set for the &%qualify_domain%& option in the configuration file.
12761
12762 .vitem &$qualify_recipient$&
12763 .vindex "&$qualify_recipient$&"
12764 The value set for the &%qualify_recipient%& option in the configuration file,
12765 or if not set, the value of &$qualify_domain$&.
12766
12767 .vitem &$queue_name$&
12768 .vindex &$queue_name$&
12769 .cindex "named queues"
12770 .cindex queues named
12771 The name of the spool queue in use; empty for the default queue.
12772
12773 .new
12774 .vitem &$r_...$&
12775 .vindex &$r_...$&
12776 .cindex router variables
12777 Values can be placed in these variables by the &%set%& option of a router.
12778 They can be given any name that starts with &$r_$&.
12779 The values persist for the address being handled through subsequent routers
12780 and the eventual transport.
12781 .wen
12782
12783 .vitem &$rcpt_count$&
12784 .vindex "&$rcpt_count$&"
12785 When a message is being received by SMTP, this variable contains the number of
12786 RCPT commands received for the current message. If this variable is used in a
12787 RCPT ACL, its value includes the current command.
12788
12789 .vitem &$rcpt_defer_count$&
12790 .vindex "&$rcpt_defer_count$&"
12791 .cindex "4&'xx'& responses" "count of"
12792 When a message is being received by SMTP, this variable contains the number of
12793 RCPT commands in the current message that have previously been rejected with a
12794 temporary (4&'xx'&) response.
12795
12796 .vitem &$rcpt_fail_count$&
12797 .vindex "&$rcpt_fail_count$&"
12798 When a message is being received by SMTP, this variable contains the number of
12799 RCPT commands in the current message that have previously been rejected with a
12800 permanent (5&'xx'&) response.
12801
12802 .vitem &$received_count$&
12803 .vindex "&$received_count$&"
12804 This variable contains the number of &'Received:'& header lines in the message,
12805 including the one added by Exim (so its value is always greater than zero). It
12806 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12807 delivering.
12808
12809 .vitem &$received_for$&
12810 .vindex "&$received_for$&"
12811 If there is only a single recipient address in an incoming message, this
12812 variable contains that address when the &'Received:'& header line is being
12813 built. The value is copied after recipient rewriting has happened, but before
12814 the &[local_scan()]& function is run.
12815
12816 .vitem &$received_ip_address$&
12817 .vindex "&$received_ip_address$&"
12818 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12819 variable is set to the address of the local IP interface, and &$received_port$&
12820 is set to the local port number. (The remote IP address and port are in
12821 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12822 the port value is -1 unless it has been set using the &%-oMi%& command line
12823 option.
12824
12825 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12826 could be used, for example, to make the filename for a TLS certificate depend
12827 on which interface and/or port is being used for the incoming connection. The
12828 values of &$received_ip_address$& and &$received_port$& are saved with any
12829 messages that are received, thus making these variables available at delivery
12830 time.
12831 For outbound connections see &$sending_ip_address$&.
12832
12833 .vitem &$received_port$&
12834 .vindex "&$received_port$&"
12835 See &$received_ip_address$&.
12836
12837 .vitem &$received_protocol$&
12838 .vindex "&$received_protocol$&"
12839 When a message is being processed, this variable contains the name of the
12840 protocol by which it was received. Most of the names used by Exim are defined
12841 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12842 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12843 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12844 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12845 connection and the client was successfully authenticated.
12846
12847 Exim uses the protocol name &"smtps"& for the case when encryption is
12848 automatically set up on connection without the use of STARTTLS (see
12849 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12850 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12851 where the client initially uses EHLO, sets up an encrypted connection using
12852 STARTTLS, and then uses HELO afterwards.
12853
12854 The &%-oMr%& option provides a way of specifying a custom protocol name for
12855 messages that are injected locally by trusted callers. This is commonly used to
12856 identify messages that are being re-injected after some kind of scanning.
12857
12858 .vitem &$received_time$&
12859 .vindex "&$received_time$&"
12860 This variable contains the date and time when the current message was received,
12861 as a number of seconds since the start of the Unix epoch.
12862
12863 .vitem &$recipient_data$&
12864 .vindex "&$recipient_data$&"
12865 This variable is set after an indexing lookup success in an ACL &%recipients%&
12866 condition. It contains the data from the lookup, and the value remains set
12867 until the next &%recipients%& test. Thus, you can do things like this:
12868 .display
12869 &`require recipients  = cdb*@;/some/file`&
12870 &`deny    `&&'some further test involving'& &`$recipient_data`&
12871 .endd
12872 &*Warning*&: This variable is set only when a lookup is used as an indexing
12873 method in the address list, using the semicolon syntax as in the example above.
12874 The variable is not set for a lookup that is used as part of the string
12875 expansion that all such lists undergo before being interpreted.
12876
12877 .vitem &$recipient_verify_failure$&
12878 .vindex "&$recipient_verify_failure$&"
12879 In an ACL, when a recipient verification fails, this variable contains
12880 information about the failure. It is set to one of the following words:
12881
12882 .ilist
12883 &"qualify"&: The address was unqualified (no domain), and the message
12884 was neither local nor came from an exempted host.
12885
12886 .next
12887 &"route"&: Routing failed.
12888
12889 .next
12890 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12891 or before the MAIL command (that is, on initial connection, HELO, or
12892 MAIL).
12893
12894 .next
12895 &"recipient"&: The RCPT command in a callout was rejected.
12896 .next
12897
12898 &"postmaster"&: The postmaster check in a callout was rejected.
12899 .endlist
12900
12901 The main use of this variable is expected to be to distinguish between
12902 rejections of MAIL and rejections of RCPT.
12903
12904 .vitem &$recipients$&
12905 .vindex "&$recipients$&"
12906 This variable contains a list of envelope recipients for a message. A comma and
12907 a space separate the addresses in the replacement text. However, the variable
12908 is not generally available, to prevent exposure of Bcc recipients in
12909 unprivileged users' filter files. You can use &$recipients$& only in these
12910 cases:
12911
12912 .olist
12913 In a system filter file.
12914 .next
12915 In the ACLs associated with the DATA command and with non-SMTP messages, that
12916 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12917 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12918 &%acl_not_smtp_mime%&.
12919 .next
12920 From within a &[local_scan()]& function.
12921 .endlist
12922
12923
12924 .vitem &$recipients_count$&
12925 .vindex "&$recipients_count$&"
12926 When a message is being processed, this variable contains the number of
12927 envelope recipients that came with the message. Duplicates are not excluded
12928 from the count. While a message is being received over SMTP, the number
12929 increases for each accepted recipient. It can be referenced in an ACL.
12930
12931
12932 .vitem &$regex_match_string$&
12933 .vindex "&$regex_match_string$&"
12934 This variable is set to contain the matching regular expression after a
12935 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12936
12937 .vitem "&$regex1$&, &$regex2$&, etc"
12938 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12939 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12940 these variables contain the
12941 captured substrings identified by the regular expression.
12942
12943
12944 .vitem &$reply_address$&
12945 .vindex "&$reply_address$&"
12946 When a message is being processed, this variable contains the contents of the
12947 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12948 contents of the &'From:'& header line. Apart from the removal of leading
12949 white space, the value is not processed in any way. In particular, no RFC 2047
12950 decoding or character code translation takes place.
12951
12952 .vitem &$return_path$&
12953 .vindex "&$return_path$&"
12954 When a message is being delivered, this variable contains the return path &--
12955 the sender field that will be sent as part of the envelope. It is not enclosed
12956 in <> characters. At the start of routing an address, &$return_path$& has the
12957 same value as &$sender_address$&, but if, for example, an incoming message to a
12958 mailing list has been expanded by a router which specifies a different address
12959 for bounce messages, &$return_path$& subsequently contains the new bounce
12960 address, whereas &$sender_address$& always contains the original sender address
12961 that was received with the message. In other words, &$sender_address$& contains
12962 the incoming envelope sender, and &$return_path$& contains the outgoing
12963 envelope sender.
12964
12965 .vitem &$return_size_limit$&
12966 .vindex "&$return_size_limit$&"
12967 This is an obsolete name for &$bounce_return_size_limit$&.
12968
12969 .vitem &$router_name$&
12970 .cindex "router" "name"
12971 .cindex "name" "of router"
12972 .vindex "&$router_name$&"
12973 During the running of a router this variable contains its name.
12974
12975 .vitem &$runrc$&
12976 .cindex "return code" "from &%run%& expansion"
12977 .vindex "&$runrc$&"
12978 This variable contains the return code from a command that is run by the
12979 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12980 assume the order in which option values are expanded, except for those
12981 preconditions whose order of testing is documented. Therefore, you cannot
12982 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12983 another.
12984
12985 .vitem &$self_hostname$&
12986 .oindex "&%self%&" "value of host name"
12987 .vindex "&$self_hostname$&"
12988 When an address is routed to a supposedly remote host that turns out to be the
12989 local host, what happens is controlled by the &%self%& generic router option.
12990 One of its values causes the address to be passed to another router. When this
12991 happens, &$self_hostname$& is set to the name of the local host that the
12992 original router encountered. In other circumstances its contents are null.
12993
12994 .vitem &$sender_address$&
12995 .vindex "&$sender_address$&"
12996 When a message is being processed, this variable contains the sender's address
12997 that was received in the message's envelope. The case of letters in the address
12998 is retained, in both the local part and the domain. For bounce messages, the
12999 value of this variable is the empty string. See also &$return_path$&.
13000
13001 .vitem &$sender_address_data$&
13002 .vindex "&$address_data$&"
13003 .vindex "&$sender_address_data$&"
13004 If &$address_data$& is set when the routers are called from an ACL to verify a
13005 sender address, the final value is preserved in &$sender_address_data$&, to
13006 distinguish it from data from a recipient address. The value does not persist
13007 after the end of the current ACL statement. If you want to preserve it for
13008 longer, you can save it in an ACL variable.
13009
13010 .vitem &$sender_address_domain$&
13011 .vindex "&$sender_address_domain$&"
13012 The domain portion of &$sender_address$&.
13013
13014 .vitem &$sender_address_local_part$&
13015 .vindex "&$sender_address_local_part$&"
13016 The local part portion of &$sender_address$&.
13017
13018 .vitem &$sender_data$&
13019 .vindex "&$sender_data$&"
13020 This variable is set after a lookup success in an ACL &%senders%& condition or
13021 in a router &%senders%& option. It contains the data from the lookup, and the
13022 value remains set until the next &%senders%& test. Thus, you can do things like
13023 this:
13024 .display
13025 &`require senders      = cdb*@;/some/file`&
13026 &`deny    `&&'some further test involving'& &`$sender_data`&
13027 .endd
13028 &*Warning*&: This variable is set only when a lookup is used as an indexing
13029 method in the address list, using the semicolon syntax as in the example above.
13030 The variable is not set for a lookup that is used as part of the string
13031 expansion that all such lists undergo before being interpreted.
13032
13033 .vitem &$sender_fullhost$&
13034 .vindex "&$sender_fullhost$&"
13035 When a message is received from a remote host, this variable contains the host
13036 name and IP address in a single string. It ends with the IP address in square
13037 brackets, followed by a colon and a port number if the logging of ports is
13038 enabled. The format of the rest of the string depends on whether the host
13039 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13040 looking up its IP address. (Looking up the IP address can be forced by the
13041 &%host_lookup%& option, independent of verification.) A plain host name at the
13042 start of the string is a verified host name; if this is not present,
13043 verification either failed or was not requested. A host name in parentheses is
13044 the argument of a HELO or EHLO command. This is omitted if it is identical to
13045 the verified host name or to the host's IP address in square brackets.
13046
13047 .vitem &$sender_helo_dnssec$&
13048 .vindex "&$sender_helo_dnssec$&"
13049 This boolean variable is true if a successful HELO verification was
13050 .cindex "DNS" "DNSSEC"
13051 done using DNS information the resolver library stated was authenticated data.
13052
13053 .vitem &$sender_helo_name$&
13054 .vindex "&$sender_helo_name$&"
13055 When a message is received from a remote host that has issued a HELO or EHLO
13056 command, the argument of that command is placed in this variable. It is also
13057 set if HELO or EHLO is used when a message is received using SMTP locally via
13058 the &%-bs%& or &%-bS%& options.
13059
13060 .vitem &$sender_host_address$&
13061 .vindex "&$sender_host_address$&"
13062 When a message is received from a remote host using SMTP,
13063 this variable contains that
13064 host's IP address. For locally non-SMTP submitted messages, it is empty.
13065
13066 .vitem &$sender_host_authenticated$&
13067 .vindex "&$sender_host_authenticated$&"
13068 This variable contains the name (not the public name) of the authenticator
13069 driver that successfully authenticated the client from which the message was
13070 received. It is empty if there was no successful authentication. See also
13071 &$authenticated_id$&.
13072
13073 .vitem &$sender_host_dnssec$&
13074 .vindex "&$sender_host_dnssec$&"
13075 If an attempt to populate &$sender_host_name$& has been made
13076 (by reference, &%hosts_lookup%& or
13077 otherwise) then this boolean will have been set true if, and only if, the
13078 resolver library states that both
13079 the reverse and forward DNS were authenticated data.  At all
13080 other times, this variable is false.
13081
13082 .cindex "DNS" "DNSSEC"
13083 It is likely that you will need to coerce DNSSEC support on in the resolver
13084 library, by setting:
13085 .code
13086 dns_dnssec_ok = 1
13087 .endd
13088
13089 Exim does not perform DNSSEC validation itself, instead leaving that to a
13090 validating resolver (e.g. unbound, or bind with suitable configuration).
13091
13092 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13093 mechanism in the list, then this variable will be false.
13094
13095 This requires that your system resolver library support EDNS0 (and that
13096 DNSSEC flags exist in the system headers).  If the resolver silently drops
13097 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13098 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13099
13100
13101 .vitem &$sender_host_name$&
13102 .vindex "&$sender_host_name$&"
13103 When a message is received from a remote host, this variable contains the
13104 host's name as obtained by looking up its IP address. For messages received by
13105 other means, this variable is empty.
13106
13107 .vindex "&$host_lookup_failed$&"
13108 If the host name has not previously been looked up, a reference to
13109 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13110 A looked up name is accepted only if it leads back to the original IP address
13111 via a forward lookup. If either the reverse or the forward lookup fails to find
13112 any data, or if the forward lookup does not yield the original IP address,
13113 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13114
13115 .vindex "&$host_lookup_deferred$&"
13116 However, if either of the lookups cannot be completed (for example, there is a
13117 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13118 &$host_lookup_failed$& remains set to &"0"&.
13119
13120 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13121 host name again if there is a subsequent reference to &$sender_host_name$&
13122 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13123 is set to &"1"&.
13124
13125 Exim does not automatically look up every calling host's name. If you want
13126 maximum efficiency, you should arrange your configuration so that it avoids
13127 these lookups altogether. The lookup happens only if one or more of the
13128 following are true:
13129
13130 .ilist
13131 A string containing &$sender_host_name$& is expanded.
13132 .next
13133 The calling host matches the list in &%host_lookup%&. In the default
13134 configuration, this option is set to *, so it must be changed if lookups are
13135 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13136 .next
13137 Exim needs the host name in order to test an item in a host list. The items
13138 that require this are described in sections &<<SECThoslispatnam>>& and
13139 &<<SECThoslispatnamsk>>&.
13140 .next
13141 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13142 In this case, the host name is required to compare with the name quoted in any
13143 EHLO or HELO commands that the client issues.
13144 .next
13145 The remote host issues a EHLO or HELO command that quotes one of the
13146 domains in &%helo_lookup_domains%&. The default value of this option is
13147 . ==== As this is a nested list, any displays it contains must be indented
13148 . ==== as otherwise they are too far to the left.
13149 .code
13150   helo_lookup_domains = @ : @[]
13151 .endd
13152 which causes a lookup if a remote host (incorrectly) gives the server's name or
13153 IP address in an EHLO or HELO command.
13154 .endlist
13155
13156
13157 .vitem &$sender_host_port$&
13158 .vindex "&$sender_host_port$&"
13159 When a message is received from a remote host, this variable contains the port
13160 number that was used on the remote host.
13161
13162 .vitem &$sender_ident$&
13163 .vindex "&$sender_ident$&"
13164 When a message is received from a remote host, this variable contains the
13165 identification received in response to an RFC 1413 request. When a message has
13166 been received locally, this variable contains the login name of the user that
13167 called Exim.
13168
13169 .vitem &$sender_rate_$&&'xxx'&
13170 A number of variables whose names begin &$sender_rate_$& are set as part of the
13171 &%ratelimit%& ACL condition. Details are given in section
13172 &<<SECTratelimiting>>&.
13173
13174 .vitem &$sender_rcvhost$&
13175 .cindex "DNS" "reverse lookup"
13176 .cindex "reverse DNS lookup"
13177 .vindex "&$sender_rcvhost$&"
13178 This is provided specifically for use in &'Received:'& headers. It starts with
13179 either the verified host name (as obtained from a reverse DNS lookup) or, if
13180 there is no verified host name, the IP address in square brackets. After that
13181 there may be text in parentheses. When the first item is a verified host name,
13182 the first thing in the parentheses is the IP address in square brackets,
13183 followed by a colon and a port number if port logging is enabled. When the
13184 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13185 the parentheses.
13186
13187 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13188 was used and its argument was not identical to the real host name or IP
13189 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13190 all three items are present in the parentheses, a newline and tab are inserted
13191 into the string, to improve the formatting of the &'Received:'& header.
13192
13193 .vitem &$sender_verify_failure$&
13194 .vindex "&$sender_verify_failure$&"
13195 In an ACL, when a sender verification fails, this variable contains information
13196 about the failure. The details are the same as for
13197 &$recipient_verify_failure$&.
13198
13199 .vitem &$sending_ip_address$&
13200 .vindex "&$sending_ip_address$&"
13201 This variable is set whenever an outgoing SMTP connection to another host has
13202 been set up. It contains the IP address of the local interface that is being
13203 used. This is useful if a host that has more than one IP address wants to take
13204 on different personalities depending on which one is being used. For incoming
13205 connections, see &$received_ip_address$&.
13206
13207 .vitem &$sending_port$&
13208 .vindex "&$sending_port$&"
13209 This variable is set whenever an outgoing SMTP connection to another host has
13210 been set up. It contains the local port that is being used. For incoming
13211 connections, see &$received_port$&.
13212
13213 .vitem &$smtp_active_hostname$&
13214 .vindex "&$smtp_active_hostname$&"
13215 During an incoming SMTP session, this variable contains the value of the active
13216 host name, as specified by the &%smtp_active_hostname%& option. The value of
13217 &$smtp_active_hostname$& is saved with any message that is received, so its
13218 value can be consulted during routing and delivery.
13219
13220 .vitem &$smtp_command$&
13221 .vindex "&$smtp_command$&"
13222 During the processing of an incoming SMTP command, this variable contains the
13223 entire command. This makes it possible to distinguish between HELO and EHLO in
13224 the HELO ACL, and also to distinguish between commands such as these:
13225 .code
13226 MAIL FROM:<>
13227 MAIL FROM: <>
13228 .endd
13229 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13230 command, the address in &$smtp_command$& is the original address before any
13231 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13232 the address after SMTP-time rewriting.
13233
13234 .vitem &$smtp_command_argument$&
13235 .cindex "SMTP" "command, argument for"
13236 .vindex "&$smtp_command_argument$&"
13237 While an ACL is running to check an SMTP command, this variable contains the
13238 argument, that is, the text that follows the command name, with leading white
13239 space removed. Following the introduction of &$smtp_command$&, this variable is
13240 somewhat redundant, but is retained for backwards compatibility.
13241
13242 .vitem &$smtp_command_history$&
13243 .cindex SMTP "command history"
13244 .vindex "&$smtp_command_history$&"
13245 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13246 received, in time-order left to right.  Only a limited number of commands
13247 are remembered.
13248
13249 .vitem &$smtp_count_at_connection_start$&
13250 .vindex "&$smtp_count_at_connection_start$&"
13251 This variable is set greater than zero only in processes spawned by the Exim
13252 daemon for handling incoming SMTP connections. The name is deliberately long,
13253 in order to emphasize what the contents are. When the daemon accepts a new
13254 connection, it increments this variable. A copy of the variable is passed to
13255 the child process that handles the connection, but its value is fixed, and
13256 never changes. It is only an approximation of how many incoming connections
13257 there actually are, because many other connections may come and go while a
13258 single connection is being processed. When a child process terminates, the
13259 daemon decrements its copy of the variable.
13260
13261 .vitem "&$sn0$& &-- &$sn9$&"
13262 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13263 that were current at the end of the system filter file. This allows a system
13264 filter file to set values that can be tested in users' filter files. For
13265 example, a system filter could set a value indicating how likely it is that a
13266 message is junk mail.
13267
13268 .vitem &$spam_$&&'xxx'&
13269 A number of variables whose names start with &$spam$& are available when Exim
13270 is compiled with the content-scanning extension. For details, see section
13271 &<<SECTscanspamass>>&.
13272
13273 .vitem &$spf_header_comment$& &&&
13274        &$spf_received$& &&&
13275        &$spf_result$& &&&
13276        &$spf_result_guessed$& &&&
13277        &$spf_smtp_comment$&
13278 These variables are only available if Exim is built with SPF support.
13279 For details see section &<<SECSPF>>&.
13280
13281 .vitem &$spool_directory$&
13282 .vindex "&$spool_directory$&"
13283 The name of Exim's spool directory.
13284
13285 .vitem &$spool_inodes$&
13286 .vindex "&$spool_inodes$&"
13287 The number of free inodes in the disk partition where Exim's spool files are
13288 being written. The value is recalculated whenever the variable is referenced.
13289 If the relevant file system does not have the concept of inodes, the value of
13290 is -1. See also the &%check_spool_inodes%& option.
13291
13292 .vitem &$spool_space$&
13293 .vindex "&$spool_space$&"
13294 The amount of free space (as a number of kilobytes) in the disk partition where
13295 Exim's spool files are being written. The value is recalculated whenever the
13296 variable is referenced. If the operating system does not have the ability to
13297 find the amount of free space (only true for experimental systems), the space
13298 value is -1. For example, to check in an ACL that there is at least 50
13299 megabytes free on the spool, you could write:
13300 .code
13301 condition = ${if > {$spool_space}{50000}}
13302 .endd
13303 See also the &%check_spool_space%& option.
13304
13305
13306 .vitem &$thisaddress$&
13307 .vindex "&$thisaddress$&"
13308 This variable is set only during the processing of the &%foranyaddress%&
13309 command in a filter file. Its use is explained in the description of that
13310 command, which can be found in the separate document entitled &'Exim's
13311 interfaces to mail filtering'&.
13312
13313 .vitem &$tls_in_bits$&
13314 .vindex "&$tls_in_bits$&"
13315 Contains an approximation of the TLS cipher's bit-strength
13316 on the inbound connection; the meaning of
13317 this depends upon the TLS implementation used.
13318 If TLS has not been negotiated, the value will be 0.
13319 The value of this is automatically fed into the Cyrus SASL authenticator
13320 when acting as a server, to specify the "external SSF" (a SASL term).
13321
13322 The deprecated &$tls_bits$& variable refers to the inbound side
13323 except when used in the context of an outbound SMTP delivery, when it refers to
13324 the outbound.
13325
13326 .vitem &$tls_out_bits$&
13327 .vindex "&$tls_out_bits$&"
13328 Contains an approximation of the TLS cipher's bit-strength
13329 on an outbound SMTP connection; the meaning of
13330 this depends upon the TLS implementation used.
13331 If TLS has not been negotiated, the value will be 0.
13332
13333 .vitem &$tls_in_ourcert$&
13334 .vindex "&$tls_in_ourcert$&"
13335 .cindex certificate variables
13336 This variable refers to the certificate presented to the peer of an
13337 inbound connection when the message was received.
13338 It is only useful as the argument of a
13339 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13340 or a &%def%& condition.
13341
13342 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13343 when a list of more than one
13344 file is used for &%tls_certificate%&, this variable is not reliable.
13345
13346 .vitem &$tls_in_peercert$&
13347 .vindex "&$tls_in_peercert$&"
13348 This variable refers to the certificate presented by the peer of an
13349 inbound connection when the message was received.
13350 It is only useful as the argument of a
13351 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13352 or a &%def%& condition.
13353 If certificate verification fails it may refer to a failing chain element
13354 which is not the leaf.
13355
13356 .vitem &$tls_out_ourcert$&
13357 .vindex "&$tls_out_ourcert$&"
13358 This variable refers to the certificate presented to the peer of an
13359 outbound connection.  It is only useful as the argument of a
13360 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13361 or a &%def%& condition.
13362
13363 .vitem &$tls_out_peercert$&
13364 .vindex "&$tls_out_peercert$&"
13365 This variable refers to the certificate presented by the peer of an
13366 outbound connection.  It is only useful as the argument of a
13367 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13368 or a &%def%& condition.
13369 If certificate verification fails it may refer to a failing chain element
13370 which is not the leaf.
13371
13372 .vitem &$tls_in_certificate_verified$&
13373 .vindex "&$tls_in_certificate_verified$&"
13374 This variable is set to &"1"& if a TLS certificate was verified when the
13375 message was received, and &"0"& otherwise.
13376
13377 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13378 except when used in the context of an outbound SMTP delivery, when it refers to
13379 the outbound.
13380
13381 .vitem &$tls_out_certificate_verified$&
13382 .vindex "&$tls_out_certificate_verified$&"
13383 This variable is set to &"1"& if a TLS certificate was verified when an
13384 outbound SMTP connection was made,
13385 and &"0"& otherwise.
13386
13387 .vitem &$tls_in_cipher$&
13388 .vindex "&$tls_in_cipher$&"
13389 .vindex "&$tls_cipher$&"
13390 When a message is received from a remote host over an encrypted SMTP
13391 connection, this variable is set to the cipher suite that was negotiated, for
13392 example DES-CBC3-SHA. In other circumstances, in particular, for message
13393 received over unencrypted connections, the variable is empty. Testing
13394 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13395 non-encrypted connections during ACL processing.
13396
13397 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13398 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13399 becomes the same as &$tls_out_cipher$&.
13400
13401 .new
13402 .vitem &$tls_in_cipher_std$&
13403 .vindex "&$tls_in_cipher_std$&"
13404 As above, but returning the RFC standard name for the cipher suite.
13405 .wen
13406
13407 .vitem &$tls_out_cipher$&
13408 .vindex "&$tls_out_cipher$&"
13409 This variable is
13410 cleared before any outgoing SMTP connection is made,
13411 and then set to the outgoing cipher suite if one is negotiated. See chapter
13412 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13413 details of the &(smtp)& transport.
13414
13415 ,new
13416 .vitem &$tls_out_cipher_std$&
13417 .vindex "&$tls_out_cipher_std$&"
13418 As above, but returning the RFC standard name for the cipher suite.
13419 .wen
13420
13421 .vitem &$tls_out_dane$&
13422 .vindex &$tls_out_dane$&
13423 DANE active status.  See section &<<SECDANE>>&.
13424
13425 .vitem &$tls_in_ocsp$&
13426 .vindex "&$tls_in_ocsp$&"
13427 When a message is received from a remote client connection
13428 the result of any OCSP request from the client is encoded in this variable:
13429 .code
13430 0 OCSP proof was not requested (default value)
13431 1 No response to request
13432 2 Response not verified
13433 3 Verification failed
13434 4 Verification succeeded
13435 .endd
13436
13437 .vitem &$tls_out_ocsp$&
13438 .vindex "&$tls_out_ocsp$&"
13439 When a message is sent to a remote host connection
13440 the result of any OCSP request made is encoded in this variable.
13441 See &$tls_in_ocsp$& for values.
13442
13443 .vitem &$tls_in_peerdn$&
13444 .vindex "&$tls_in_peerdn$&"
13445 .vindex "&$tls_peerdn$&"
13446 .cindex certificate "extracting fields"
13447 When a message is received from a remote host over an encrypted SMTP
13448 connection, and Exim is configured to request a certificate from the client,
13449 the value of the Distinguished Name of the certificate is made available in the
13450 &$tls_in_peerdn$& during subsequent processing.
13451 If certificate verification fails it may refer to a failing chain element
13452 which is not the leaf.
13453
13454 The deprecated &$tls_peerdn$& variable refers to the inbound side
13455 except when used in the context of an outbound SMTP delivery, when it refers to
13456 the outbound.
13457
13458 .vitem &$tls_out_peerdn$&
13459 .vindex "&$tls_out_peerdn$&"
13460 When a message is being delivered to a remote host over an encrypted SMTP
13461 connection, and Exim is configured to request a certificate from the server,
13462 the value of the Distinguished Name of the certificate is made available in the
13463 &$tls_out_peerdn$& during subsequent processing.
13464 If certificate verification fails it may refer to a failing chain element
13465 which is not the leaf.
13466
13467 .vitem &$tls_in_sni$&
13468 .vindex "&$tls_in_sni$&"
13469 .vindex "&$tls_sni$&"
13470 .cindex "TLS" "Server Name Indication"
13471 When a TLS session is being established, if the client sends the Server
13472 Name Indication extension, the value will be placed in this variable.
13473 If the variable appears in &%tls_certificate%& then this option and
13474 some others, described in &<<SECTtlssni>>&,
13475 will be re-expanded early in the TLS session, to permit
13476 a different certificate to be presented (and optionally a different key to be
13477 used) to the client, based upon the value of the SNI extension.
13478
13479 The deprecated &$tls_sni$& variable refers to the inbound side
13480 except when used in the context of an outbound SMTP delivery, when it refers to
13481 the outbound.
13482
13483 .vitem &$tls_out_sni$&
13484 .vindex "&$tls_out_sni$&"
13485 .cindex "TLS" "Server Name Indication"
13486 During outbound
13487 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13488 the transport.
13489
13490 .vitem &$tls_out_tlsa_usage$&
13491 .vindex &$tls_out_tlsa_usage$&
13492 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13493
13494 .vitem &$tod_bsdinbox$&
13495 .vindex "&$tod_bsdinbox$&"
13496 The time of day and the date, in the format required for BSD-style mailbox
13497 files, for example: Thu Oct 17 17:14:09 1995.
13498
13499 .vitem &$tod_epoch$&
13500 .vindex "&$tod_epoch$&"
13501 The time and date as a number of seconds since the start of the Unix epoch.
13502
13503 .vitem &$tod_epoch_l$&
13504 .vindex "&$tod_epoch_l$&"
13505 The time and date as a number of microseconds since the start of the Unix epoch.
13506
13507 .vitem &$tod_full$&
13508 .vindex "&$tod_full$&"
13509 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13510 +0100. The timezone is always given as a numerical offset from UTC, with
13511 positive values used for timezones that are ahead (east) of UTC, and negative
13512 values for those that are behind (west).
13513
13514 .vitem &$tod_log$&
13515 .vindex "&$tod_log$&"
13516 The time and date in the format used for writing Exim's log files, for example:
13517 1995-10-12 15:32:29, but without a timezone.
13518
13519 .vitem &$tod_logfile$&
13520 .vindex "&$tod_logfile$&"
13521 This variable contains the date in the format yyyymmdd. This is the format that
13522 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13523 flag.
13524
13525 .vitem &$tod_zone$&
13526 .vindex "&$tod_zone$&"
13527 This variable contains the numerical value of the local timezone, for example:
13528 -0500.
13529
13530 .vitem &$tod_zulu$&
13531 .vindex "&$tod_zulu$&"
13532 This variable contains the UTC date and time in &"Zulu"& format, as specified
13533 by ISO 8601, for example: 20030221154023Z.
13534
13535 .vitem &$transport_name$&
13536 .cindex "transport" "name"
13537 .cindex "name" "of transport"
13538 .vindex "&$transport_name$&"
13539 During the running of a transport, this variable contains its name.
13540
13541 .vitem &$value$&
13542 .vindex "&$value$&"
13543 This variable contains the result of an expansion lookup, extraction operation,
13544 or external command, as described above. It is also used during a
13545 &*reduce*& expansion.
13546
13547 .vitem &$verify_mode$&
13548 .vindex "&$verify_mode$&"
13549 While a router or transport is being run in verify mode or for cutthrough delivery,
13550 contains "S" for sender-verification or "R" for recipient-verification.
13551 Otherwise, empty.
13552
13553 .vitem &$version_number$&
13554 .vindex "&$version_number$&"
13555 The version number of Exim. Same as &$exim_version$&, may be overridden
13556 by the &%exim_version%& main config option.
13557
13558 .vitem &$warn_message_delay$&
13559 .vindex "&$warn_message_delay$&"
13560 This variable is set only during the creation of a message warning about a
13561 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13562
13563 .vitem &$warn_message_recipients$&
13564 .vindex "&$warn_message_recipients$&"
13565 This variable is set only during the creation of a message warning about a
13566 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13567 .endlist
13568 .ecindex IIDstrexp
13569
13570
13571
13572 . ////////////////////////////////////////////////////////////////////////////
13573 . ////////////////////////////////////////////////////////////////////////////
13574
13575 .chapter "Embedded Perl" "CHAPperl"
13576 .scindex IIDperl "Perl" "calling from Exim"
13577 Exim can be built to include an embedded Perl interpreter. When this is done,
13578 Perl subroutines can be called as part of the string expansion process. To make
13579 use of the Perl support, you need version 5.004 or later of Perl installed on
13580 your system. To include the embedded interpreter in the Exim binary, include
13581 the line
13582 .code
13583 EXIM_PERL = perl.o
13584 .endd
13585 in your &_Local/Makefile_& and then build Exim in the normal way.
13586
13587
13588 .section "Setting up so Perl can be used" "SECID85"
13589 .oindex "&%perl_startup%&"
13590 Access to Perl subroutines is via a global configuration option called
13591 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13592 no &%perl_startup%& option in the Exim configuration file then no Perl
13593 interpreter is started and there is almost no overhead for Exim (since none of
13594 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13595 option then the associated value is taken to be Perl code which is executed in
13596 a newly created Perl interpreter.
13597
13598 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13599 need backslashes before any characters to escape special meanings. The option
13600 should usually be something like
13601 .code
13602 perl_startup = do '/etc/exim.pl'
13603 .endd
13604 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13605 use from Exim. Exim can be configured either to start up a Perl interpreter as
13606 soon as it is entered, or to wait until the first time it is needed. Starting
13607 the interpreter at the beginning ensures that it is done while Exim still has
13608 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13609 fact used in a particular run. Also, note that this does not mean that Exim is
13610 necessarily running as root when Perl is called at a later time. By default,
13611 the interpreter is started only when it is needed, but this can be changed in
13612 two ways:
13613
13614 .ilist
13615 .oindex "&%perl_at_start%&"
13616 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13617 a startup when Exim is entered.
13618 .next
13619 The command line option &%-ps%& also requests a startup when Exim is entered,
13620 overriding the setting of &%perl_at_start%&.
13621 .endlist
13622
13623 There is also a command line option &%-pd%& (for delay) which suppresses the
13624 initial startup, even if &%perl_at_start%& is set.
13625
13626 .ilist
13627 .oindex "&%perl_taintmode%&"
13628 .cindex "Perl" "taintmode"
13629 To provide more security executing Perl code via the embedded Perl
13630 interpreter, the &%perl_taintmode%& option can be set. This enables the
13631 taint mode of the Perl interpreter. You are encouraged to set this
13632 option to a true value. To avoid breaking existing installations, it
13633 defaults to false.
13634
13635
13636 .section "Calling Perl subroutines" "SECID86"
13637 When the configuration file includes a &%perl_startup%& option you can make use
13638 of the string expansion item to call the Perl subroutines that are defined
13639 by the &%perl_startup%& code. The operator is used in any of the following
13640 forms:
13641 .code
13642 ${perl{foo}}
13643 ${perl{foo}{argument}}
13644 ${perl{foo}{argument1}{argument2} ... }
13645 .endd
13646 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13647 arguments may be passed. Passing more than this results in an expansion failure
13648 with an error message of the form
13649 .code
13650 Too many arguments passed to Perl subroutine "foo" (max is 8)
13651 .endd
13652 The return value of the Perl subroutine is evaluated in a scalar context before
13653 it is passed back to Exim to be inserted into the expanded string. If the
13654 return value is &'undef'&, the expansion is forced to fail in the same way as
13655 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13656 by obeying Perl's &%die%& function, the expansion fails with the error message
13657 that was passed to &%die%&.
13658
13659
13660 .section "Calling Exim functions from Perl" "SECID87"
13661 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13662 is available to call back into Exim's string expansion function. For example,
13663 the Perl code
13664 .code
13665 my $lp = Exim::expand_string('$local_part');
13666 .endd
13667 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13668 Note those are single quotes and not double quotes to protect against
13669 &$local_part$& being interpolated as a Perl variable.
13670
13671 If the string expansion is forced to fail by a &"fail"& item, the result of
13672 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13673 expansion string, the Perl call from the original expansion string fails with
13674 an appropriate error message, in the same way as if &%die%& were used.
13675
13676 .cindex "debugging" "from embedded Perl"
13677 .cindex "log" "writing from embedded Perl"
13678 Two other Exim functions are available for use from within Perl code.
13679 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13680 debugging is enabled. If you want a newline at the end, you must supply it.
13681 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13682 timestamp. In this case, you should not supply a terminating newline.
13683
13684
13685 .section "Use of standard output and error by Perl" "SECID88"
13686 .cindex "Perl" "standard output and error"
13687 You should not write to the standard error or output streams from within your
13688 Perl code, as it is not defined how these are set up. In versions of Exim
13689 before 4.50, it is possible for the standard output or error to refer to the
13690 SMTP connection during message reception via the daemon. Writing to this stream
13691 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13692 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13693 avoided, but the output is lost.
13694
13695 .cindex "Perl" "use of &%warn%&"
13696 The Perl &%warn%& statement writes to the standard error stream by default.
13697 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13698 you have no control. When Exim starts up the Perl interpreter, it arranges for
13699 output from the &%warn%& statement to be written to the Exim main log. You can
13700 change this by including appropriate Perl magic somewhere in your Perl code.
13701 For example, to discard &%warn%& output completely, you need this:
13702 .code
13703 $SIG{__WARN__} = sub { };
13704 .endd
13705 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13706 example, the code for the subroutine is empty, so it does nothing, but you can
13707 include any Perl code that you like. The text of the &%warn%& message is passed
13708 as the first subroutine argument.
13709 .ecindex IIDperl
13710
13711
13712 . ////////////////////////////////////////////////////////////////////////////
13713 . ////////////////////////////////////////////////////////////////////////////
13714
13715 .chapter "Starting the daemon and the use of network interfaces" &&&
13716          "CHAPinterfaces" &&&
13717          "Starting the daemon"
13718 .cindex "daemon" "starting"
13719 .cindex "interface" "listening"
13720 .cindex "network interface"
13721 .cindex "interface" "network"
13722 .cindex "IP address" "for listening"
13723 .cindex "daemon" "listening IP addresses"
13724 .cindex "TCP/IP" "setting listening interfaces"
13725 .cindex "TCP/IP" "setting listening ports"
13726 A host that is connected to a TCP/IP network may have one or more physical
13727 hardware network interfaces. Each of these interfaces may be configured as one
13728 or more &"logical"& interfaces, which are the entities that a program actually
13729 works with. Each of these logical interfaces is associated with an IP address.
13730 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13731 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13732 knowledge about the host's interfaces for use in three different circumstances:
13733
13734 .olist
13735 When a listening daemon is started, Exim needs to know which interfaces
13736 and ports to listen on.
13737 .next
13738 When Exim is routing an address, it needs to know which IP addresses
13739 are associated with local interfaces. This is required for the correct
13740 processing of MX lists by removing the local host and others with the
13741 same or higher priority values. Also, Exim needs to detect cases
13742 when an address is routed to an IP address that in fact belongs to the
13743 local host. Unless the &%self%& router option or the &%allow_localhost%&
13744 option of the smtp transport is set (as appropriate), this is treated
13745 as an error situation.
13746 .next
13747 When Exim connects to a remote host, it may need to know which interface to use
13748 for the outgoing connection.
13749 .endlist
13750
13751
13752 Exim's default behaviour is likely to be appropriate in the vast majority
13753 of cases. If your host has only one interface, and you want all its IP
13754 addresses to be treated in the same way, and you are using only the
13755 standard SMTP port, you should not need to take any special action. The
13756 rest of this chapter does not apply to you.
13757
13758 In a more complicated situation you may want to listen only on certain
13759 interfaces, or on different ports, and for this reason there are a number of
13760 options that can be used to influence Exim's behaviour. The rest of this
13761 chapter describes how they operate.
13762
13763 When a message is received over TCP/IP, the interface and port that were
13764 actually used are set in &$received_ip_address$& and &$received_port$&.
13765
13766
13767
13768 .section "Starting a listening daemon" "SECID89"
13769 When a listening daemon is started (by means of the &%-bd%& command line
13770 option), the interfaces and ports on which it listens are controlled by the
13771 following options:
13772
13773 .ilist
13774 &%daemon_smtp_ports%& contains a list of default ports
13775 or service names.
13776 (For backward compatibility, this option can also be specified in the singular.)
13777 .next
13778 &%local_interfaces%& contains list of interface IP addresses on which to
13779 listen. Each item may optionally also specify a port.
13780 .endlist
13781
13782 The default list separator in both cases is a colon, but this can be changed as
13783 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13784 it is usually best to change the separator to avoid having to double all the
13785 colons. For example:
13786 .code
13787 local_interfaces = <; 127.0.0.1 ; \
13788                       192.168.23.65 ; \
13789                       ::1 ; \
13790                       3ffe:ffff:836f::fe86:a061
13791 .endd
13792 There are two different formats for specifying a port along with an IP address
13793 in &%local_interfaces%&:
13794
13795 .olist
13796 The port is added onto the address with a dot separator. For example, to listen
13797 on port 1234 on two different IP addresses:
13798 .code
13799 local_interfaces = <; 192.168.23.65.1234 ; \
13800                       3ffe:ffff:836f::fe86:a061.1234
13801 .endd
13802 .next
13803 The IP address is enclosed in square brackets, and the port is added
13804 with a colon separator, for example:
13805 .code
13806 local_interfaces = <; [192.168.23.65]:1234 ; \
13807                       [3ffe:ffff:836f::fe86:a061]:1234
13808 .endd
13809 .endlist
13810
13811 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13812 default setting contains just one port:
13813 .code
13814 daemon_smtp_ports = smtp
13815 .endd
13816 If more than one port is listed, each interface that does not have its own port
13817 specified listens on all of them. Ports that are listed in
13818 &%daemon_smtp_ports%& can be identified either by name (defined in
13819 &_/etc/services_&) or by number. However, when ports are given with individual
13820 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13821
13822
13823
13824 .section "Special IP listening addresses" "SECID90"
13825 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13826 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13827 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13828 instead of setting up separate listening sockets for each interface. The
13829 default value of &%local_interfaces%& is
13830 .code
13831 local_interfaces = 0.0.0.0
13832 .endd
13833 when Exim is built without IPv6 support; otherwise it is:
13834 .code
13835 local_interfaces = <; ::0 ; 0.0.0.0
13836 .endd
13837 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13838
13839
13840
13841 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13842 The &%-oX%& command line option can be used to override the values of
13843 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13844 instance. Another way of doing this would be to use macros and the &%-D%&
13845 option. However, &%-oX%& can be used by any admin user, whereas modification of
13846 the runtime configuration by &%-D%& is allowed only when the caller is root or
13847 exim.
13848
13849 The value of &%-oX%& is a list of items. The default colon separator can be
13850 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13851 If there are any items that do not
13852 contain dots or colons (that is, are not IP addresses), the value of
13853 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13854 items that do contain dots or colons, the value of &%local_interfaces%& is
13855 replaced by those items. Thus, for example,
13856 .code
13857 -oX 1225
13858 .endd
13859 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13860 whereas
13861 .code
13862 -oX 192.168.34.5.1125
13863 .endd
13864 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13865 (However, since &%local_interfaces%& now contains no items without ports, the
13866 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13867
13868
13869
13870 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13871 .cindex "submissions protocol"
13872 .cindex "ssmtp protocol"
13873 .cindex "smtps protocol"
13874 .cindex "SMTP" "ssmtp protocol"
13875 .cindex "SMTP" "smtps protocol"
13876 Exim supports the use of TLS-on-connect, used by mail clients in the
13877 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13878 For some years, IETF Standards Track documents only blessed the
13879 STARTTLS-based Submission service (port 587) while common practice was to support
13880 the same feature set on port 465, but using TLS-on-connect.
13881 If your installation needs to provide service to mail clients
13882 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13883 the 465 TCP ports.
13884
13885 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13886 service names, connections to those ports must first establish TLS, before
13887 proceeding to the application layer use of the SMTP protocol.
13888
13889 The common use of this option is expected to be
13890 .code
13891 tls_on_connect_ports = 465
13892 .endd
13893 per RFC 8314.
13894 There is also a command line option &%-tls-on-connect%&, which forces all ports
13895 to behave in this way when a daemon is started.
13896
13897 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13898 daemon to listen on those ports. You must still specify them in
13899 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13900 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13901 connections via the daemon.)
13902
13903
13904
13905
13906 .section "IPv6 address scopes" "SECID92"
13907 .cindex "IPv6" "address scopes"
13908 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13909 can, in principle, have the same link-local IPv6 address on different
13910 interfaces. Thus, additional information is needed, over and above the IP
13911 address, to distinguish individual interfaces. A convention of using a
13912 percent sign followed by something (often the interface name) has been
13913 adopted in some cases, leading to addresses like this:
13914 .code
13915 fe80::202:b3ff:fe03:45c1%eth0
13916 .endd
13917 To accommodate this usage, a percent sign followed by an arbitrary string is
13918 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13919 to convert a textual IPv6 address for actual use. This function recognizes the
13920 percent convention in operating systems that support it, and it processes the
13921 address appropriately. Unfortunately, some older libraries have problems with
13922 &[getaddrinfo()]&. If
13923 .code
13924 IPV6_USE_INET_PTON=yes
13925 .endd
13926 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13927 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13928 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13929 function.) Of course, this means that the additional functionality of
13930 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13931
13932 .section "Disabling IPv6" "SECID93"
13933 .cindex "IPv6" "disabling"
13934 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13935 run on a host whose kernel does not support IPv6. The binary will fall back to
13936 using IPv4, but it may waste resources looking up AAAA records, and trying to
13937 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13938 .oindex "&%disable_ipv6%&"
13939 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13940 activities take place. AAAA records are never looked up, and any IPv6 addresses
13941 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13942 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13943 to handle IPv6 literal addresses.
13944
13945 On the other hand, when IPv6 is in use, there may be times when you want to
13946 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13947 option to globally suppress the lookup of AAAA records for specified domains,
13948 and you can use the &%ignore_target_hosts%& generic router option to ignore
13949 IPv6 addresses in an individual router.
13950
13951
13952
13953 .section "Examples of starting a listening daemon" "SECID94"
13954 The default case in an IPv6 environment is
13955 .code
13956 daemon_smtp_ports = smtp
13957 local_interfaces = <; ::0 ; 0.0.0.0
13958 .endd
13959 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13960 Either one or two sockets may be used, depending on the characteristics of
13961 the TCP/IP stack. (This is complicated and messy; for more information,
13962 read the comments in the &_daemon.c_& source file.)
13963
13964 To specify listening on ports 25 and 26 on all interfaces:
13965 .code
13966 daemon_smtp_ports = 25 : 26
13967 .endd
13968 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13969 .code
13970 local_interfaces = <; ::0.25     ; ::0.26 \
13971                       0.0.0.0.25 ; 0.0.0.0.26
13972 .endd
13973 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13974 IPv4 loopback address only:
13975 .code
13976 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13977 .endd
13978 To specify listening on the default port on specific interfaces only:
13979 .code
13980 local_interfaces = 10.0.0.67 : 192.168.34.67
13981 .endd
13982 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13983
13984
13985
13986 .section "Recognizing the local host" "SECTreclocipadd"
13987 The &%local_interfaces%& option is also used when Exim needs to determine
13988 whether or not an IP address refers to the local host. That is, the IP
13989 addresses of all the interfaces on which a daemon is listening are always
13990 treated as local.
13991
13992 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13993 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13994 available interfaces from the operating system, and extracts the relevant
13995 (that is, IPv4 or IPv6) addresses to use for checking.
13996
13997 Some systems set up large numbers of virtual interfaces in order to provide
13998 many virtual web servers. In this situation, you may want to listen for
13999 email on only a few of the available interfaces, but nevertheless treat all
14000 interfaces as local when routing. You can do this by setting
14001 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14002 &"all"& wildcard values. These addresses are recognized as local, but are not
14003 used for listening. Consider this example:
14004 .code
14005 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14006                       192.168.53.235 ; \
14007                       3ffe:2101:12:1:a00:20ff:fe86:a061
14008
14009 extra_local_interfaces = <; ::0 ; 0.0.0.0
14010 .endd
14011 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14012 address, but all available interface addresses are treated as local when
14013 Exim is routing.
14014
14015 In some environments the local host name may be in an MX list, but with an IP
14016 address that is not assigned to any local interface. In other cases it may be
14017 desirable to treat other host names as if they referred to the local host. Both
14018 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14019 This contains host names rather than IP addresses. When a host is referenced
14020 during routing, either via an MX record or directly, it is treated as the local
14021 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14022 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14023
14024
14025
14026 .section "Delivering to a remote host" "SECID95"
14027 Delivery to a remote host is handled by the smtp transport. By default, it
14028 allows the system's TCP/IP functions to choose which interface to use (if
14029 there is more than one) when connecting to a remote host. However, the
14030 &%interface%& option can be set to specify which interface is used. See the
14031 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14032 details.
14033
14034
14035
14036
14037 . ////////////////////////////////////////////////////////////////////////////
14038 . ////////////////////////////////////////////////////////////////////////////
14039
14040 .chapter "Main configuration" "CHAPmainconfig"
14041 .scindex IIDconfima "configuration file" "main section"
14042 .scindex IIDmaiconf "main configuration"
14043 The first part of the runtime configuration file contains three types of item:
14044
14045 .ilist
14046 Macro definitions: These lines start with an upper case letter. See section
14047 &<<SECTmacrodefs>>& for details of macro processing.
14048 .next
14049 Named list definitions: These lines start with one of the words &"domainlist"&,
14050 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14051 section &<<SECTnamedlists>>&.
14052 .next
14053 Main configuration settings: Each setting occupies one line of the file
14054 (with possible continuations). If any setting is preceded by the word
14055 &"hide"&, the &%-bP%& command line option displays its value to admin users
14056 only. See section &<<SECTcos>>& for a description of the syntax of these option
14057 settings.
14058 .endlist
14059
14060 This chapter specifies all the main configuration options, along with their
14061 types and default values. For ease of finding a particular option, they appear
14062 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14063 are now so many options, they are first listed briefly in functional groups, as
14064 an aid to finding the name of the option you are looking for. Some options are
14065 listed in more than one group.
14066
14067 .section "Miscellaneous" "SECID96"
14068 .table2
14069 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14070 .row &%debug_store%&                 "do extra internal checks"
14071 .row &%disable_ipv6%&                "do no IPv6 processing"
14072 .row &%keep_malformed%&              "for broken files &-- should not happen"
14073 .row &%localhost_number%&            "for unique message ids in clusters"
14074 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14075 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14076 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14077 .row &%print_topbitchars%&           "top-bit characters are printing"
14078 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14079 .row &%timezone%&                    "force time zone"
14080 .endtable
14081
14082
14083 .section "Exim parameters" "SECID97"
14084 .table2
14085 .row &%exim_group%&                  "override compiled-in value"
14086 .row &%exim_path%&                   "override compiled-in value"
14087 .row &%exim_user%&                   "override compiled-in value"
14088 .row &%primary_hostname%&            "default from &[uname()]&"
14089 .row &%split_spool_directory%&       "use multiple directories"
14090 .row &%spool_directory%&             "override compiled-in value"
14091 .endtable
14092
14093
14094
14095 .section "Privilege controls" "SECID98"
14096 .table2
14097 .row &%admin_groups%&                "groups that are Exim admin users"
14098 .row &%commandline_checks_require_admin%& "require admin for various checks"
14099 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14100 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14101 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14102 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14103 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14104 .row &%never_users%&                 "do not run deliveries as these"
14105 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14106 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14107 .row &%trusted_groups%&              "groups that are trusted"
14108 .row &%trusted_users%&               "users that are trusted"
14109 .endtable
14110
14111
14112
14113 .section "Logging" "SECID99"
14114 .table2
14115 .row &%event_action%&                "custom logging"
14116 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14117 .row &%log_file_path%&               "override compiled-in value"
14118 .row &%log_selector%&                "set/unset optional logging"
14119 .row &%log_timezone%&                "add timezone to log lines"
14120 .row &%message_logs%&                "create per-message logs"
14121 .row &%preserve_message_logs%&       "after message completion"
14122 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14123 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14124 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14125 .row &%syslog_facility%&             "set syslog &""facility""& field"
14126 .row &%syslog_pid%&                  "pid in syslog lines"
14127 .row &%syslog_processname%&          "set syslog &""ident""& field"
14128 .row &%syslog_timestamp%&            "timestamp syslog lines"
14129 .row &%write_rejectlog%&             "control use of message log"
14130 .endtable
14131
14132
14133
14134 .section "Frozen messages" "SECID100"
14135 .table2
14136 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14137 .row &%freeze_tell%&                 "send message when freezing"
14138 .row &%move_frozen_messages%&        "to another directory"
14139 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14140 .endtable
14141
14142
14143
14144 .section "Data lookups" "SECID101"
14145 .table2
14146 .row &%ibase_servers%&               "InterBase servers"
14147 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14148 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14149 .row &%ldap_cert_file%&              "client cert file for LDAP"
14150 .row &%ldap_cert_key%&               "client key file for LDAP"
14151 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14152 .row &%ldap_default_servers%&        "used if no server in query"
14153 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14154 .row &%ldap_start_tls%&              "require TLS within LDAP"
14155 .row &%ldap_version%&                "set protocol version"
14156 .row &%lookup_open_max%&             "lookup files held open"
14157 .row &%mysql_servers%&               "default MySQL servers"
14158 .row &%oracle_servers%&              "Oracle servers"
14159 .row &%pgsql_servers%&               "default PostgreSQL servers"
14160 .row &%sqlite_lock_timeout%&         "as it says"
14161 .endtable
14162
14163
14164
14165 .section "Message ids" "SECID102"
14166 .table2
14167 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14168 .row &%message_id_header_text%&      "ditto"
14169 .endtable
14170
14171
14172
14173 .section "Embedded Perl Startup" "SECID103"
14174 .table2
14175 .row &%perl_at_start%&               "always start the interpreter"
14176 .row &%perl_startup%&                "code to obey when starting Perl"
14177 .row &%perl_taintmode%&              "enable taint mode in Perl"
14178 .endtable
14179
14180
14181
14182 .section "Daemon" "SECID104"
14183 .table2
14184 .row &%daemon_smtp_ports%&           "default ports"
14185 .row &%daemon_startup_retries%&      "number of times to retry"
14186 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14187 .row &%extra_local_interfaces%&      "not necessarily listened on"
14188 .row &%local_interfaces%&            "on which to listen, with optional ports"
14189 .row &%pid_file_path%&               "override compiled-in value"
14190 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14191 .endtable
14192
14193
14194
14195 .section "Resource control" "SECID105"
14196 .table2
14197 .row &%check_log_inodes%&            "before accepting a message"
14198 .row &%check_log_space%&             "before accepting a message"
14199 .row &%check_spool_inodes%&          "before accepting a message"
14200 .row &%check_spool_space%&           "before accepting a message"
14201 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14202 .row &%queue_only_load%&             "queue incoming if load high"
14203 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14204 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14205 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14206 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14207 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14208 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14209 .row &%smtp_accept_max_per_connection%& "messages per connection"
14210 .row &%smtp_accept_max_per_host%&    "connections from one host"
14211 .row &%smtp_accept_queue%&           "queue mail if more connections"
14212 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14213                                            connection"
14214 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14215 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14216 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14217 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14218 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14219 .endtable
14220
14221
14222
14223 .section "Policy controls" "SECID106"
14224 .table2
14225 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14226 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14227 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14228 .row &%acl_smtp_auth%&               "ACL for AUTH"
14229 .row &%acl_smtp_connect%&            "ACL for connection"
14230 .row &%acl_smtp_data%&               "ACL for DATA"
14231 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14232 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14233 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14234 .row &%acl_smtp_expn%&               "ACL for EXPN"
14235 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14236 .row &%acl_smtp_mail%&               "ACL for MAIL"
14237 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14238 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14239 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14240 .row &%acl_smtp_predata%&            "ACL for start of data"
14241 .row &%acl_smtp_quit%&               "ACL for QUIT"
14242 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14243 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14244 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14245 .row &%av_scanner%&                  "specify virus scanner"
14246 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14247                                       words""&"
14248 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14249 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14250 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14251 .row &%header_maxsize%&              "total size of message header"
14252 .row &%header_line_maxsize%&         "individual header line limit"
14253 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14254 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14255 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14256 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14257 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14258 .row &%host_lookup%&                 "host name looked up for these hosts"
14259 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14260 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14261 .row &%host_reject_connection%&      "reject connection from these hosts"
14262 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14263 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14264 .row &%message_size_limit%&          "for all messages"
14265 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14266 .row &%spamd_address%&               "set interface to SpamAssassin"
14267 .row &%strict_acl_vars%&             "object to unset ACL variables"
14268 .endtable
14269
14270
14271
14272 .section "Callout cache" "SECID107"
14273 .table2
14274 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14275                                          item"
14276 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14277                                          item"
14278 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14279 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14280 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14281 .endtable
14282
14283
14284
14285 .section "TLS" "SECID108"
14286 .table2
14287 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14288 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14289 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14290 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14291 .row &%tls_certificate%&             "location of server certificate"
14292 .row &%tls_crl%&                     "certificate revocation list"
14293 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14294 .row &%tls_dhparam%&                 "DH parameters for server"
14295 .row &%tls_eccurve%&                 "EC curve selection for server"
14296 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14297 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14298 .row &%tls_privatekey%&              "location of server private key"
14299 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14300 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14301 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14302 .row &%tls_verify_certificates%&     "expected client certificates"
14303 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14304 .endtable
14305
14306
14307
14308 .section "Local user handling" "SECID109"
14309 .table2
14310 .row &%finduser_retries%&            "useful in NIS environments"
14311 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14312 .row &%gecos_pattern%&               "ditto"
14313 .row &%max_username_length%&         "for systems that truncate"
14314 .row &%unknown_login%&               "used when no login name found"
14315 .row &%unknown_username%&            "ditto"
14316 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14317 .row &%uucp_from_sender%&            "ditto"
14318 .endtable
14319
14320
14321
14322 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14323 .table2
14324 .row &%header_maxsize%&              "total size of message header"
14325 .row &%header_line_maxsize%&         "individual header line limit"
14326 .row &%message_size_limit%&          "applies to all messages"
14327 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14328 .row &%received_header_text%&        "expanded to make &'Received:'&"
14329 .row &%received_headers_max%&        "for mail loop detection"
14330 .row &%recipients_max%&              "limit per message"
14331 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14332 .endtable
14333
14334
14335
14336
14337 .section "Non-SMTP incoming messages" "SECID111"
14338 .table2
14339 .row &%receive_timeout%&             "for non-SMTP messages"
14340 .endtable
14341
14342
14343
14344
14345
14346 .section "Incoming SMTP messages" "SECID112"
14347 See also the &'Policy controls'& section above.
14348
14349 .table2
14350 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14351 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14352 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14353 .row &%host_lookup%&                 "host name looked up for these hosts"
14354 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14355 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14356 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14357 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14358 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14359 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14360 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14361 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14362 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14363 .row &%smtp_accept_max_per_connection%& "messages per connection"
14364 .row &%smtp_accept_max_per_host%&    "connections from one host"
14365 .row &%smtp_accept_queue%&           "queue mail if more connections"
14366 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14367                                            connection"
14368 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14369 .row &%smtp_active_hostname%&        "host name to use in messages"
14370 .row &%smtp_banner%&                 "text for welcome banner"
14371 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14372 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14373 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14374 .row &%smtp_etrn_command%&           "what to run for ETRN"
14375 .row &%smtp_etrn_serialize%&         "only one at once"
14376 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14377 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14378 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14379 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14380 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14381 .row &%smtp_receive_timeout%&        "per command or data line"
14382 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14383 .row &%smtp_return_error_details%&   "give detail on rejections"
14384 .endtable
14385
14386
14387
14388 .section "SMTP extensions" "SECID113"
14389 .table2
14390 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14391 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14392 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14393 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14394 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14395 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14396 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14397 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14398 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14399 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14400 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14401 .endtable
14402
14403
14404
14405 .section "Processing messages" "SECID114"
14406 .table2
14407 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14408 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14409 .row &%allow_utf8_domains%&          "in addresses"
14410 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14411                                       words""&"
14412 .row &%delivery_date_remove%&        "from incoming messages"
14413 .row &%envelope_to_remove%&          "from incoming messages"
14414 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14415 .row &%headers_charset%&             "default for translations"
14416 .row &%qualify_domain%&              "default for senders"
14417 .row &%qualify_recipient%&           "default for recipients"
14418 .row &%return_path_remove%&          "from incoming messages"
14419 .row &%strip_excess_angle_brackets%& "in addresses"
14420 .row &%strip_trailing_dot%&          "at end of addresses"
14421 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14422 .endtable
14423
14424
14425
14426 .section "System filter" "SECID115"
14427 .table2
14428 .row &%system_filter%&               "locate system filter"
14429 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14430                                             directory"
14431 .row &%system_filter_file_transport%& "transport for delivery to a file"
14432 .row &%system_filter_group%&         "group for filter running"
14433 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14434 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14435 .row &%system_filter_user%&          "user for filter running"
14436 .endtable
14437
14438
14439
14440 .section "Routing and delivery" "SECID116"
14441 .table2
14442 .row &%disable_ipv6%&                "do no IPv6 processing"
14443 .row &%dns_again_means_nonexist%&    "for broken domains"
14444 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14445 .row &%dns_dnssec_ok%&               "parameter for resolver"
14446 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14447 .row &%dns_retrans%&                 "parameter for resolver"
14448 .row &%dns_retry%&                   "parameter for resolver"
14449 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14450 .row &%dns_use_edns0%&               "parameter for resolver"
14451 .row &%hold_domains%&                "hold delivery for these domains"
14452 .row &%local_interfaces%&            "for routing checks"
14453 .row &%queue_domains%&               "no immediate delivery for these"
14454 .row &%queue_only%&                  "no immediate delivery at all"
14455 .row &%queue_only_file%&             "no immediate delivery if file exists"
14456 .row &%queue_only_load%&             "no immediate delivery if load is high"
14457 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14458 .row &%queue_only_override%&         "allow command line to override"
14459 .row &%queue_run_in_order%&          "order of arrival"
14460 .row &%queue_run_max%&               "of simultaneous queue runners"
14461 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14462 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14463 .row &%remote_sort_domains%&         "order of remote deliveries"
14464 .row &%retry_data_expire%&           "timeout for retry data"
14465 .row &%retry_interval_max%&          "safety net for retry rules"
14466 .endtable
14467
14468
14469
14470 .section "Bounce and warning messages" "SECID117"
14471 .table2
14472 .row &%bounce_message_file%&         "content of bounce"
14473 .row &%bounce_message_text%&         "content of bounce"
14474 .row &%bounce_return_body%&          "include body if returning message"
14475 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14476 .row &%bounce_return_message%&       "include original message in bounce"
14477 .row &%bounce_return_size_limit%&    "limit on returned message"
14478 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14479 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14480 .row &%errors_copy%&                 "copy bounce messages"
14481 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14482 .row &%delay_warning%&               "time schedule"
14483 .row &%delay_warning_condition%&     "condition for warning messages"
14484 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14485 .row &%smtp_return_error_details%&   "give detail on rejections"
14486 .row &%warn_message_file%&           "content of warning message"
14487 .endtable
14488
14489
14490
14491 .section "Alphabetical list of main options" "SECTalomo"
14492 Those options that undergo string expansion before use are marked with
14493 &dagger;.
14494
14495 .option accept_8bitmime main boolean true
14496 .cindex "8BITMIME"
14497 .cindex "8-bit characters"
14498 .cindex "log" "selectors"
14499 .cindex "log" "8BITMIME"
14500 This option causes Exim to send 8BITMIME in its response to an SMTP
14501 EHLO command, and to accept the BODY= parameter on MAIL commands.
14502 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14503 takes no steps to do anything special with messages received by this route.
14504
14505 Historically Exim kept this option off by default, but the maintainers
14506 feel that in today's Internet, this causes more problems than it solves.
14507 It now defaults to true.
14508 A more detailed analysis of the issues is provided by Dan Bernstein:
14509 .display
14510 &url(https://cr.yp.to/smtp/8bitmime.html)
14511 .endd
14512
14513 To log received 8BITMIME status use
14514 .code
14515 log_selector = +8bitmime
14516 .endd
14517
14518 .option acl_not_smtp main string&!! unset
14519 .cindex "&ACL;" "for non-SMTP messages"
14520 .cindex "non-SMTP messages" "ACLs for"
14521 This option defines the ACL that is run when a non-SMTP message has been
14522 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14523 further details.
14524
14525 .option acl_not_smtp_mime main string&!! unset
14526 This option defines the ACL that is run for individual MIME parts of non-SMTP
14527 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14528 SMTP messages.
14529
14530 .option acl_not_smtp_start main string&!! unset
14531 .cindex "&ACL;" "at start of non-SMTP message"
14532 .cindex "non-SMTP messages" "ACLs for"
14533 This option defines the ACL that is run before Exim starts reading a
14534 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14535
14536 .option acl_smtp_auth main string&!! unset
14537 .cindex "&ACL;" "setting up for SMTP commands"
14538 .cindex "AUTH" "ACL for"
14539 This option defines the ACL that is run when an SMTP AUTH command is
14540 received. See chapter &<<CHAPACL>>& for further details.
14541
14542 .option acl_smtp_connect main string&!! unset
14543 .cindex "&ACL;" "on SMTP connection"
14544 This option defines the ACL that is run when an SMTP connection is received.
14545 See chapter &<<CHAPACL>>& for further details.
14546
14547 .option acl_smtp_data main string&!! unset
14548 .cindex "DATA" "ACL for"
14549 This option defines the ACL that is run after an SMTP DATA command has been
14550 processed and the message itself has been received, but before the final
14551 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14552
14553 .option acl_smtp_data_prdr main string&!! accept
14554 .cindex "PRDR" "ACL for"
14555 .cindex "DATA" "PRDR ACL for"
14556 .cindex "&ACL;" "PRDR-related"
14557 .cindex "&ACL;" "per-user data processing"
14558 This option defines the ACL that,
14559 if the PRDR feature has been negotiated,
14560 is run for each recipient after an SMTP DATA command has been
14561 processed and the message itself has been received, but before the
14562 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14563
14564 .option acl_smtp_dkim main string&!! unset
14565 .cindex DKIM "ACL for"
14566 This option defines the ACL that is run for each DKIM signature
14567 (by default, or as specified in the dkim_verify_signers option)
14568 of a received message.
14569 See section &<<SECDKIMVFY>>& for further details.
14570
14571 .option acl_smtp_etrn main string&!! unset
14572 .cindex "ETRN" "ACL for"
14573 This option defines the ACL that is run when an SMTP ETRN command is
14574 received. See chapter &<<CHAPACL>>& for further details.
14575
14576 .option acl_smtp_expn main string&!! unset
14577 .cindex "EXPN" "ACL for"
14578 This option defines the ACL that is run when an SMTP EXPN command is
14579 received. See chapter &<<CHAPACL>>& for further details.
14580
14581 .option acl_smtp_helo main string&!! unset
14582 .cindex "EHLO" "ACL for"
14583 .cindex "HELO" "ACL for"
14584 This option defines the ACL that is run when an SMTP EHLO or HELO
14585 command is received. See chapter &<<CHAPACL>>& for further details.
14586
14587
14588 .option acl_smtp_mail main string&!! unset
14589 .cindex "MAIL" "ACL for"
14590 This option defines the ACL that is run when an SMTP MAIL command is
14591 received. See chapter &<<CHAPACL>>& for further details.
14592
14593 .option acl_smtp_mailauth main string&!! unset
14594 .cindex "AUTH" "on MAIL command"
14595 This option defines the ACL that is run when there is an AUTH parameter on
14596 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14597 &<<CHAPSMTPAUTH>>& for details of authentication.
14598
14599 .option acl_smtp_mime main string&!! unset
14600 .cindex "MIME content scanning" "ACL for"
14601 This option is available when Exim is built with the content-scanning
14602 extension. It defines the ACL that is run for each MIME part in a message. See
14603 section &<<SECTscanmimepart>>& for details.
14604
14605 .option acl_smtp_notquit main string&!! unset
14606 .cindex "not-QUIT, ACL for"
14607 This option defines the ACL that is run when an SMTP session
14608 ends without a QUIT command being received.
14609 See chapter &<<CHAPACL>>& for further details.
14610
14611 .option acl_smtp_predata main string&!! unset
14612 This option defines the ACL that is run when an SMTP DATA command is
14613 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14614 further details.
14615
14616 .option acl_smtp_quit main string&!! unset
14617 .cindex "QUIT, ACL for"
14618 This option defines the ACL that is run when an SMTP QUIT command is
14619 received. See chapter &<<CHAPACL>>& for further details.
14620
14621 .option acl_smtp_rcpt main string&!! unset
14622 .cindex "RCPT" "ACL for"
14623 This option defines the ACL that is run when an SMTP RCPT command is
14624 received. See chapter &<<CHAPACL>>& for further details.
14625
14626 .option acl_smtp_starttls main string&!! unset
14627 .cindex "STARTTLS, ACL for"
14628 This option defines the ACL that is run when an SMTP STARTTLS command is
14629 received. See chapter &<<CHAPACL>>& for further details.
14630
14631 .option acl_smtp_vrfy main string&!! unset
14632 .cindex "VRFY" "ACL for"
14633 This option defines the ACL that is run when an SMTP VRFY command is
14634 received. See chapter &<<CHAPACL>>& for further details.
14635
14636 .option add_environment main "string list" empty
14637 .cindex "environment" "set values"
14638 This option allows to set individual environment variables that the
14639 currently linked libraries and programs in child processes use.
14640 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14641
14642 .option admin_groups main "string list&!!" unset
14643 .cindex "admin user"
14644 This option is expanded just once, at the start of Exim's processing. If the
14645 current group or any of the supplementary groups of an Exim caller is in this
14646 colon-separated list, the caller has admin privileges. If all your system
14647 programmers are in a specific group, for example, you can give them all Exim
14648 admin privileges by putting that group in &%admin_groups%&. However, this does
14649 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14650 To permit this, you have to add individuals to the Exim group.
14651
14652 .option allow_domain_literals main boolean false
14653 .cindex "domain literal"
14654 If this option is set, the RFC 2822 domain literal format is permitted in
14655 email addresses. The option is not set by default, because the domain literal
14656 format is not normally required these days, and few people know about it. It
14657 has, however, been exploited by mail abusers.
14658
14659 Unfortunately, it seems that some DNS black list maintainers are using this
14660 format to report black listing to postmasters. If you want to accept messages
14661 addressed to your hosts by IP address, you need to set
14662 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14663 domains (defined in the named domain list &%local_domains%& in the default
14664 configuration). This &"magic string"& matches the domain literal form of all
14665 the local host's IP addresses.
14666
14667
14668 .option allow_mx_to_ip main boolean false
14669 .cindex "MX record" "pointing to IP address"
14670 It appears that more and more DNS zone administrators are breaking the rules
14671 and putting domain names that look like IP addresses on the right hand side of
14672 MX records. Exim follows the rules and rejects this, giving an error message
14673 that explains the misconfiguration. However, some other MTAs support this
14674 practice, so to avoid &"Why can't Exim do this?"& complaints,
14675 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14676 recommended, except when you have no other choice.
14677
14678 .option allow_utf8_domains main boolean false
14679 .cindex "domain" "UTF-8 characters in"
14680 .cindex "UTF-8" "in domain name"
14681 Lots of discussion is going on about internationalized domain names. One
14682 camp is strongly in favour of just using UTF-8 characters, and it seems
14683 that at least two other MTAs permit this. This option allows Exim users to
14684 experiment if they wish.
14685
14686 If it is set true, Exim's domain parsing function allows valid
14687 UTF-8 multicharacters to appear in domain name components, in addition to
14688 letters, digits, and hyphens. However, just setting this option is not
14689 enough; if you want to look up these domain names in the DNS, you must also
14690 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14691 suitable setting is:
14692 .code
14693 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14694   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14695 .endd
14696 Alternatively, you can just disable this feature by setting
14697 .code
14698 dns_check_names_pattern =
14699 .endd
14700 That is, set the option to an empty string so that no check is done.
14701
14702
14703 .option auth_advertise_hosts main "host list&!!" *
14704 .cindex "authentication" "advertising"
14705 .cindex "AUTH" "advertising"
14706 If any server authentication mechanisms are configured, Exim advertises them in
14707 response to an EHLO command only if the calling host matches this list.
14708 Otherwise, Exim does not advertise AUTH.
14709 Exim does not accept AUTH commands from clients to which it has not
14710 advertised the availability of AUTH. The advertising of individual
14711 authentication mechanisms can be controlled by the use of the
14712 &%server_advertise_condition%& generic authenticator option on the individual
14713 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14714
14715 Certain mail clients (for example, Netscape) require the user to provide a name
14716 and password for authentication if AUTH is advertised, even though it may
14717 not be needed (the host may accept messages from hosts on its local LAN without
14718 authentication, for example). The &%auth_advertise_hosts%& option can be used
14719 to make these clients more friendly by excluding them from the set of hosts to
14720 which Exim advertises AUTH.
14721
14722 .cindex "AUTH" "advertising when encrypted"
14723 If you want to advertise the availability of AUTH only when the connection
14724 is encrypted using TLS, you can make use of the fact that the value of this
14725 option is expanded, with a setting like this:
14726 .code
14727 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14728 .endd
14729 .vindex "&$tls_in_cipher$&"
14730 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14731 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14732 expansion is *, which matches all hosts.
14733
14734
14735 .option auto_thaw main time 0s
14736 .cindex "thawing messages"
14737 .cindex "unfreezing messages"
14738 If this option is set to a time greater than zero, a queue runner will try a
14739 new delivery attempt on any frozen message, other than a bounce message, if
14740 this much time has passed since it was frozen. This may result in the message
14741 being re-frozen if nothing has changed since the last attempt. It is a way of
14742 saying &"keep on trying, even though there are big problems"&.
14743
14744 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14745 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14746 thought to be very useful any more, and its use should probably be avoided.
14747
14748
14749 .option av_scanner main string "see below"
14750 This option is available if Exim is built with the content-scanning extension.
14751 It specifies which anti-virus scanner to use. The default value is:
14752 .code
14753 sophie:/var/run/sophie
14754 .endd
14755 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14756 before use. See section &<<SECTscanvirus>>& for further details.
14757
14758
14759 .option bi_command main string unset
14760 .oindex "&%-bi%&"
14761 This option supplies the name of a command that is run when Exim is called with
14762 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14763 just the command name, it is not a complete command line. If an argument is
14764 required, it must come from the &%-oA%& command line option.
14765
14766
14767 .option bounce_message_file main string unset
14768 .cindex "bounce message" "customizing"
14769 .cindex "customizing" "bounce message"
14770 This option defines a template file containing paragraphs of text to be used
14771 for constructing bounce messages.  Details of the file's contents are given in
14772 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14773
14774
14775 .option bounce_message_text main string unset
14776 When this option is set, its contents are included in the default bounce
14777 message immediately after &"This message was created automatically by mail
14778 delivery software."& It is not used if &%bounce_message_file%& is set.
14779
14780 .option bounce_return_body main boolean true
14781 .cindex "bounce message" "including body"
14782 This option controls whether the body of an incoming message is included in a
14783 bounce message when &%bounce_return_message%& is true. The default setting
14784 causes the entire message, both header and body, to be returned (subject to the
14785 value of &%bounce_return_size_limit%&). If this option is false, only the
14786 message header is included. In the case of a non-SMTP message containing an
14787 error that is detected during reception, only those header lines preceding the
14788 point at which the error was detected are returned.
14789 .cindex "bounce message" "including original"
14790
14791 .option bounce_return_linesize_limit main integer 998
14792 .cindex "size" "of bounce lines, limit"
14793 .cindex "bounce message" "line length limit"
14794 .cindex "limit" "bounce message line length"
14795 This option sets a limit in bytes on the line length of messages
14796 that are returned to senders due to delivery problems,
14797 when &%bounce_return_message%& is true.
14798 The default value corresponds to RFC limits.
14799 If the message being returned has lines longer than this value it is
14800 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14801
14802 The option also applies to bounces returned when an error is detected
14803 during reception of a message.
14804 In this case lines from the original are truncated.
14805
14806 The option does not apply to messages generated by an &(autoreply)& transport.
14807
14808
14809 .option bounce_return_message main boolean true
14810 If this option is set false, none of the original message is included in
14811 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14812 &%bounce_return_body%&.
14813
14814
14815 .option bounce_return_size_limit main integer 100K
14816 .cindex "size" "of bounce, limit"
14817 .cindex "bounce message" "size limit"
14818 .cindex "limit" "bounce message size"
14819 This option sets a limit in bytes on the size of messages that are returned to
14820 senders as part of bounce messages when &%bounce_return_message%& is true. The
14821 limit should be less than the value of the global &%message_size_limit%& and of
14822 any &%message_size_limit%& settings on transports, to allow for the bounce text
14823 that Exim generates. If this option is set to zero there is no limit.
14824
14825 When the body of any message that is to be included in a bounce message is
14826 greater than the limit, it is truncated, and a comment pointing this out is
14827 added at the top. The actual cutoff may be greater than the value given, owing
14828 to the use of buffering for transferring the message in chunks (typically 8K in
14829 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14830 messages.
14831
14832 .option bounce_sender_authentication main string unset
14833 .cindex "bounce message" "sender authentication"
14834 .cindex "authentication" "bounce message"
14835 .cindex "AUTH" "on bounce message"
14836 This option provides an authenticated sender address that is sent with any
14837 bounce messages generated by Exim that are sent over an authenticated SMTP
14838 connection. A typical setting might be:
14839 .code
14840 bounce_sender_authentication = mailer-daemon@my.domain.example
14841 .endd
14842 which would cause bounce messages to be sent using the SMTP command:
14843 .code
14844 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14845 .endd
14846 The value of &%bounce_sender_authentication%& must always be a complete email
14847 address.
14848
14849 .option callout_domain_negative_expire main time 3h
14850 .cindex "caching" "callout timeouts"
14851 .cindex "callout" "caching timeouts"
14852 This option specifies the expiry time for negative callout cache data for a
14853 domain. See section &<<SECTcallver>>& for details of callout verification, and
14854 section &<<SECTcallvercache>>& for details of the caching.
14855
14856
14857 .option callout_domain_positive_expire main time 7d
14858 This option specifies the expiry time for positive callout cache data for a
14859 domain. See section &<<SECTcallver>>& for details of callout verification, and
14860 section &<<SECTcallvercache>>& for details of the caching.
14861
14862
14863 .option callout_negative_expire main time 2h
14864 This option specifies the expiry time for negative callout cache data for an
14865 address. See section &<<SECTcallver>>& for details of callout verification, and
14866 section &<<SECTcallvercache>>& for details of the caching.
14867
14868
14869 .option callout_positive_expire main time 24h
14870 This option specifies the expiry time for positive callout cache data for an
14871 address. See section &<<SECTcallver>>& for details of callout verification, and
14872 section &<<SECTcallvercache>>& for details of the caching.
14873
14874
14875 .option callout_random_local_part main string&!! "see below"
14876 This option defines the &"random"& local part that can be used as part of
14877 callout verification. The default value is
14878 .code
14879 $primary_hostname-$tod_epoch-testing
14880 .endd
14881 See section &<<CALLaddparcall>>& for details of how this value is used.
14882
14883
14884 .option check_log_inodes main integer 100
14885 See &%check_spool_space%& below.
14886
14887
14888 .option check_log_space main integer 10M
14889 See &%check_spool_space%& below.
14890
14891 .oindex "&%check_rfc2047_length%&"
14892 .cindex "RFC 2047" "disabling length check"
14893 .option check_rfc2047_length main boolean true
14894 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14895 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14896 word; strings to be encoded that exceed this length are supposed to use
14897 multiple encoded words. By default, Exim does not recognize encoded words that
14898 exceed the maximum length. However, it seems that some software, in violation
14899 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14900 set false, Exim recognizes encoded words of any length.
14901
14902
14903 .option check_spool_inodes main integer 100
14904 See &%check_spool_space%& below.
14905
14906
14907 .option check_spool_space main integer 10M
14908 .cindex "checking disk space"
14909 .cindex "disk space, checking"
14910 .cindex "spool directory" "checking space"
14911 The four &%check_...%& options allow for checking of disk resources before a
14912 message is accepted.
14913
14914 .vindex "&$log_inodes$&"
14915 .vindex "&$log_space$&"
14916 .vindex "&$spool_inodes$&"
14917 .vindex "&$spool_space$&"
14918 When any of these options are nonzero, they apply to all incoming messages. If you
14919 want to apply different checks to different kinds of message, you can do so by
14920 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14921 &$spool_space$& in an ACL with appropriate additional conditions.
14922
14923
14924 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14925 either value is greater than zero, for example:
14926 .code
14927 check_spool_space = 100M
14928 check_spool_inodes = 100
14929 .endd
14930 The spool partition is the one that contains the directory defined by
14931 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14932 transit.
14933
14934 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14935 files are written if either is greater than zero. These should be set only if
14936 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14937
14938 If there is less space or fewer inodes than requested, Exim refuses to accept
14939 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14940 error response to the MAIL command. If ESMTP is in use and there was a
14941 SIZE parameter on the MAIL command, its value is added to the
14942 &%check_spool_space%& value, and the check is performed even if
14943 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14944
14945 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14946 number of kilobytes (though specified in bytes).
14947 If a non-multiple of 1024 is specified, it is rounded up.
14948
14949 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14950 failure a message is written to stderr and Exim exits with a non-zero code, as
14951 it obviously cannot send an error message of any kind.
14952
14953 There is a slight performance penalty for these checks.
14954 Versions of Exim preceding 4.88 had these disabled by default;
14955 high-rate installations confident they will never run out of resources
14956 may wish to deliberately disable them.
14957
14958 .option chunking_advertise_hosts main "host list&!!" *
14959 .cindex CHUNKING advertisement
14960 .cindex "RFC 3030" "CHUNKING"
14961 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14962 these hosts.
14963 Hosts may use the BDAT command as an alternate to DATA.
14964
14965 .option commandline_checks_require_admin main boolean &`false`&
14966 .cindex "restricting access to features"
14967 This option restricts various basic checking features to require an
14968 administrative user.
14969 This affects most of the &%-b*%& options, such as &%-be%&.
14970
14971 .option debug_store main boolean &`false`&
14972 .cindex debugging "memory corruption"
14973 .cindex memory debugging
14974 This option, when true, enables extra checking in Exim's internal memory
14975 management.  For use when a memory corruption issue is being investigated,
14976 it should normally be left as default.
14977
14978 .option daemon_smtp_ports main string &`smtp`&
14979 .cindex "port" "for daemon"
14980 .cindex "TCP/IP" "setting listening ports"
14981 This option specifies one or more default SMTP ports on which the Exim daemon
14982 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14983 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14984
14985 .option daemon_startup_retries main integer 9
14986 .cindex "daemon startup, retrying"
14987 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14988 the daemon at startup when it cannot immediately bind a listening socket
14989 (typically because the socket is already in use): &%daemon_startup_retries%&
14990 defines the number of retries after the first failure, and
14991 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14992
14993 .option daemon_startup_sleep main time 30s
14994 See &%daemon_startup_retries%&.
14995
14996 .option delay_warning main "time list" 24h
14997 .cindex "warning of delay"
14998 .cindex "delay warning, specifying"
14999 .cindex "queue" "delay warning"
15000 When a message is delayed, Exim sends a warning message to the sender at
15001 intervals specified by this option. The data is a colon-separated list of times
15002 after which to send warning messages. If the value of the option is an empty
15003 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15004 message has been in the queue for longer than the last time, the last interval
15005 between the times is used to compute subsequent warning times. For example,
15006 with
15007 .code
15008 delay_warning = 4h:8h:24h
15009 .endd
15010 the first message is sent after 4 hours, the second after 8 hours, and
15011 the third one after 24 hours. After that, messages are sent every 16 hours,
15012 because that is the interval between the last two times on the list. If you set
15013 just one time, it specifies the repeat interval. For example, with:
15014 .code
15015 delay_warning = 6h
15016 .endd
15017 messages are repeated every six hours. To stop warnings after a given time, set
15018 a very large time at the end of the list. For example:
15019 .code
15020 delay_warning = 2h:12h:99d
15021 .endd
15022 Note that the option is only evaluated at the time a delivery attempt fails,
15023 which depends on retry and queue-runner configuration.
15024 Typically retries will be configured more frequently than warning messages.
15025
15026 .option delay_warning_condition main string&!! "see below"
15027 .vindex "&$domain$&"
15028 The string is expanded at the time a warning message might be sent. If all the
15029 deferred addresses have the same domain, it is set in &$domain$& during the
15030 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15031 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15032 &"false"& (the comparison being done caselessly) then the warning message is
15033 not sent. The default is:
15034 .code
15035 delay_warning_condition = ${if or {\
15036   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15037   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15038   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15039   } {no}{yes}}
15040 .endd
15041 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15042 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15043 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15044 &"auto-replied"& in an &'Auto-Submitted:'& header.
15045
15046 .option deliver_drop_privilege main boolean false
15047 .cindex "unprivileged delivery"
15048 .cindex "delivery" "unprivileged"
15049 If this option is set true, Exim drops its root privilege at the start of a
15050 delivery process, and runs as the Exim user throughout. This severely restricts
15051 the kinds of local delivery that are possible, but is viable in certain types
15052 of configuration. There is a discussion about the use of root privilege in
15053 chapter &<<CHAPsecurity>>&.
15054
15055 .option deliver_queue_load_max main fixed-point unset
15056 .cindex "load average"
15057 .cindex "queue runner" "abandoning"
15058 When this option is set, a queue run is abandoned if the system load average
15059 becomes greater than the value of the option. The option has no effect on
15060 ancient operating systems on which Exim cannot determine the load average.
15061 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15062
15063
15064 .option delivery_date_remove main boolean true
15065 .cindex "&'Delivery-date:'& header line"
15066 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15067 message when it is delivered, in exactly the same way as &'Return-path:'& is
15068 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15069 should not be present in incoming messages, and this option causes them to be
15070 removed at the time the message is received, to avoid any problems that might
15071 occur when a delivered message is subsequently sent on to some other recipient.
15072
15073 .option disable_fsync main boolean false
15074 .cindex "&[fsync()]&, disabling"
15075 This option is available only if Exim was built with the compile-time option
15076 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15077 a runtime configuration generates an &"unknown option"& error. You should not
15078 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15079 really, really, really understand what you are doing. &'No pre-compiled
15080 distributions of Exim should ever make this option available.'&
15081
15082 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15083 updated files' data to be written to disc before continuing. Unexpected events
15084 such as crashes and power outages may cause data to be lost or scrambled.
15085 Here be Dragons. &*Beware.*&
15086
15087
15088 .option disable_ipv6 main boolean false
15089 .cindex "IPv6" "disabling"
15090 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15091 activities take place. AAAA records are never looked up, and any IPv6 addresses
15092 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15093 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15094 to handle IPv6 literal addresses.
15095
15096
15097 .new
15098 .option dkim_verify_hashes main "string list" "sha256 : sha512 : sha1"
15099 .cindex DKIM "selecting signature algorithms"
15100 This option gives a list of hash types which are acceptable in signatures,
15101 and an order of processing.
15102 Signatures with algorithms not in the list will be ignored.
15103
15104 Note that the presence of sha1 violates RFC 8301.
15105 Signatures using the rsa-sha1 are however (as of writing) still common.
15106 The default inclusion of sha1 may be dropped in a future release.
15107
15108 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15109 This option gives a list of key types which are acceptable in signatures,
15110 and an order of processing.
15111 Signatures with algorithms not in the list will be ignored.
15112
15113 .option dkim_verify_minimal main boolean false
15114 If set to true, verification of signatures will terminate after the
15115 first success.
15116 .wen
15117
15118 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15119 .cindex DKIM "controlling calls to the ACL"
15120 This option gives a list of DKIM domains for which the DKIM ACL is run.
15121 It is expanded after the message is received; by default it runs
15122 the ACL once for each signature in the message.
15123 See section &<<SECDKIMVFY>>&.
15124
15125
15126 .option dns_again_means_nonexist main "domain list&!!" unset
15127 .cindex "DNS" "&""try again""& response; overriding"
15128 DNS lookups give a &"try again"& response for the DNS errors
15129 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15130 keep trying to deliver a message, or to give repeated temporary errors to
15131 incoming mail. Sometimes the effect is caused by a badly set up name server and
15132 may persist for a long time. If a domain which exhibits this problem matches
15133 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15134 This option should be used with care. You can make it apply to reverse lookups
15135 by a setting such as this:
15136 .code
15137 dns_again_means_nonexist = *.in-addr.arpa
15138 .endd
15139 This option applies to all DNS lookups that Exim does. It also applies when the
15140 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15141 since these are most likely to be caused by DNS lookup problems. The
15142 &(dnslookup)& router has some options of its own for controlling what happens
15143 when lookups for MX or SRV records give temporary errors. These more specific
15144 options are applied after this global option.
15145
15146 .option dns_check_names_pattern main string "see below"
15147 .cindex "DNS" "pre-check of name syntax"
15148 When this option is set to a non-empty string, it causes Exim to check domain
15149 names for characters that are not allowed in host names before handing them to
15150 the DNS resolver, because some resolvers give temporary errors for names that
15151 contain unusual characters. If a domain name contains any unwanted characters,
15152 a &"not found"& result is forced, and the resolver is not called. The check is
15153 done by matching the domain name against a regular expression, which is the
15154 value of this option. The default pattern is
15155 .code
15156 dns_check_names_pattern = \
15157   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15158 .endd
15159 which permits only letters, digits, slashes, and hyphens in components, but
15160 they must start and end with a letter or digit. Slashes are not, in fact,
15161 permitted in host names, but they are found in certain NS records (which can be
15162 accessed in Exim by using a &%dnsdb%& lookup). If you set
15163 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15164 empty string.
15165
15166 .option dns_csa_search_limit main integer 5
15167 This option controls the depth of parental searching for CSA SRV records in the
15168 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15169
15170 .option dns_csa_use_reverse main boolean true
15171 This option controls whether or not an IP address, given as a CSA domain, is
15172 reversed and looked up in the reverse DNS, as described in more detail in
15173 section &<<SECTverifyCSA>>&.
15174
15175 .option dns_cname_loops main integer 1
15176 .cindex DNS "CNAME following"
15177 This option controls the following of CNAME chains, needed if the resolver does
15178 not do it internally.
15179 As of 2018 most should, and the default can be left.
15180 If you have an ancient one, a value of 10 is likely needed.
15181
15182 The default value of one CNAME-follow is needed
15183 thanks to the observed return for an MX request,
15184 given no MX presence but a CNAME to an A, of the CNAME.
15185
15186
15187 .option dns_dnssec_ok main integer -1
15188 .cindex "DNS" "resolver options"
15189 .cindex "DNS" "DNSSEC"
15190 If this option is set to a non-negative number then Exim will initialise the
15191 DNS resolver library to either use or not use DNSSEC, overriding the system
15192 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15193
15194 If the resolver library does not support DNSSEC then this option has no effect.
15195
15196
15197 .option dns_ipv4_lookup main "domain list&!!" unset
15198 .cindex "IPv6" "DNS lookup for AAAA records"
15199 .cindex "DNS" "IPv6 lookup for AAAA records"
15200 .cindex DNS "IPv6 disabling"
15201 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15202 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15203 (A records) when trying to find IP addresses for hosts, unless the host's
15204 domain matches this list.
15205
15206 This is a fudge to help with name servers that give big delays or otherwise do
15207 not work for the AAAA record type. In due course, when the world's name
15208 servers have all been upgraded, there should be no need for this option.
15209 .new
15210 Note that all lookups, including those done for verification, are affected;
15211 this will result in verify failure for IPv6 connections or ones using names
15212 only valid for IPv6 addresses.
15213 .wen
15214
15215
15216 .option dns_retrans main time 0s
15217 .cindex "DNS" "resolver options"
15218 .cindex timeout "dns lookup"
15219 .cindex "DNS" timeout
15220 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15221 retransmission and retry parameters for DNS lookups. Values of zero (the
15222 defaults) leave the system default settings unchanged. The first value is the
15223 time between retries, and the second is the number of retries. It isn't
15224 totally clear exactly how these settings affect the total time a DNS lookup may
15225 take. I haven't found any documentation about timeouts on DNS lookups; these
15226 parameter values are available in the external resolver interface structure,
15227 but nowhere does it seem to describe how they are used or what you might want
15228 to set in them.
15229 See also the &%slow_lookup_log%& option.
15230
15231
15232 .option dns_retry main integer 0
15233 See &%dns_retrans%& above.
15234
15235
15236 .option dns_trust_aa main "domain list&!!" unset
15237 .cindex "DNS" "resolver options"
15238 .cindex "DNS" "DNSSEC"
15239 If this option is set then lookup results marked with the AA bit
15240 (Authoritative Answer) are trusted the same way as if they were
15241 DNSSEC-verified. The authority section's name of the answer must
15242 match with this expanded domain list.
15243
15244 Use this option only if you talk directly to a resolver that is
15245 authoritative for some zones and does not set the AD (Authentic Data)
15246 bit in the answer. Some DNS servers may have an configuration option to
15247 mark the answers from their own zones as verified (they set the AD bit).
15248 Others do not have this option. It is considered as poor practice using
15249 a resolver that is an authoritative server for some zones.
15250
15251 Use this option only if you really have to (e.g. if you want
15252 to use DANE for remote delivery to a server that is listed in the DNS
15253 zones that your resolver is authoritative for).
15254
15255 If the DNS answer packet has the AA bit set and contains resource record
15256 in the answer section, the name of the first NS record appearing in the
15257 authority section is compared against the list. If the answer packet is
15258 authoritative but the answer section is empty, the name of the first SOA
15259 record in the authoritative section is used instead.
15260
15261 .cindex "DNS" "resolver options"
15262 .option dns_use_edns0 main integer -1
15263 .cindex "DNS" "resolver options"
15264 .cindex "DNS" "EDNS0"
15265 .cindex "DNS" "OpenBSD
15266 If this option is set to a non-negative number then Exim will initialise the
15267 DNS resolver library to either use or not use EDNS0 extensions, overriding
15268 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15269 on.
15270
15271 If the resolver library does not support EDNS0 then this option has no effect.
15272
15273 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15274 means that DNSSEC will not work with Exim on that platform either, unless Exim
15275 is linked against an alternative DNS client library.
15276
15277
15278 .option drop_cr main boolean false
15279 This is an obsolete option that is now a no-op. It used to affect the way Exim
15280 handled CR and LF characters in incoming messages. What happens now is
15281 described in section &<<SECTlineendings>>&.
15282
15283 .option dsn_advertise_hosts main "host list&!!" unset
15284 .cindex "bounce messages" "success"
15285 .cindex "DSN" "success"
15286 .cindex "Delivery Status Notification" "success"
15287 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15288 and accepted from, these hosts.
15289 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15290 and RET and ORCPT options on MAIL FROM commands.
15291 A NOTIFY=SUCCESS option requests success-DSN messages.
15292 A NOTIFY= option with no argument requests that no delay or failure DSNs
15293 are sent.
15294
15295 .option dsn_from main "string&!!" "see below"
15296 .cindex "&'From:'& header line" "in bounces"
15297 .cindex "bounce messages" "&'From:'& line, specifying"
15298 This option can be used to vary the contents of &'From:'& header lines in
15299 bounces and other automatically generated messages (&"Delivery Status
15300 Notifications"& &-- hence the name of the option). The default setting is:
15301 .code
15302 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15303 .endd
15304 The value is expanded every time it is needed. If the expansion fails, a
15305 panic is logged, and the default value is used.
15306
15307 .option envelope_to_remove main boolean true
15308 .cindex "&'Envelope-to:'& header line"
15309 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15310 message when it is delivered, in exactly the same way as &'Return-path:'& is
15311 handled. &'Envelope-to:'& records the original recipient address from the
15312 message's envelope that caused the delivery to happen. Such headers should not
15313 be present in incoming messages, and this option causes them to be removed at
15314 the time the message is received, to avoid any problems that might occur when a
15315 delivered message is subsequently sent on to some other recipient.
15316
15317
15318 .option errors_copy main "string list&!!" unset
15319 .cindex "bounce message" "copy to other address"
15320 .cindex "copy of bounce message"
15321 Setting this option causes Exim to send bcc copies of bounce messages that it
15322 generates to other addresses. &*Note*&: This does not apply to bounce messages
15323 coming from elsewhere. The value of the option is a colon-separated list of
15324 items. Each item consists of a pattern, terminated by white space, followed by
15325 a comma-separated list of email addresses. If a pattern contains spaces, it
15326 must be enclosed in double quotes.
15327
15328 Each pattern is processed in the same way as a single item in an address list
15329 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15330 the bounce message, the message is copied to the addresses on the list. The
15331 items are scanned in order, and once a matching one is found, no further items
15332 are examined. For example:
15333 .code
15334 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15335               rqps@mydomain   hostmaster@mydomain.example,\
15336                               postmaster@mydomain.example
15337 .endd
15338 .vindex "&$domain$&"
15339 .vindex "&$local_part$&"
15340 The address list is expanded before use. The expansion variables &$local_part$&
15341 and &$domain$& are set from the original recipient of the error message, and if
15342 there was any wildcard matching in the pattern, the expansion
15343 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15344 variables &$0$&, &$1$&, etc. are set in the normal way.
15345
15346
15347 .option errors_reply_to main string unset
15348 .cindex "bounce message" "&'Reply-to:'& in"
15349 By default, Exim's bounce and delivery warning messages contain the header line
15350 .display
15351 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15352 .endd
15353 .oindex &%quota_warn_message%&
15354 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15355 A warning message that is generated by the &%quota_warn_message%& option in an
15356 &(appendfile)& transport may contain its own &'From:'& header line that
15357 overrides the default.
15358
15359 Experience shows that people reply to bounce messages. If the
15360 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15361 and warning messages. For example:
15362 .code
15363 errors_reply_to = postmaster@my.domain.example
15364 .endd
15365 The value of the option is not expanded. It must specify a valid RFC 2822
15366 address. However, if a warning message that is generated by the
15367 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15368 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15369 not used.
15370
15371
15372 .option event_action main string&!! unset
15373 .cindex events
15374 This option declares a string to be expanded for Exim's events mechanism.
15375 For details see chapter &<<CHAPevents>>&.
15376
15377
15378 .option exim_group main string "compile-time configured"
15379 .cindex "gid (group id)" "Exim's own"
15380 .cindex "Exim group"
15381 This option changes the gid under which Exim runs when it gives up root
15382 privilege. The default value is compiled into the binary. The value of this
15383 option is used only when &%exim_user%& is also set. Unless it consists entirely
15384 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15385 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15386 security issues.
15387
15388
15389 .option exim_path main string "see below"
15390 .cindex "Exim binary, path name"
15391 This option specifies the path name of the Exim binary, which is used when Exim
15392 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15393 the directory configured at compile time by the BIN_DIRECTORY setting. It
15394 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15395 other place.
15396 &*Warning*&: Do not use a macro to define the value of this option, because
15397 you will break those Exim utilities that scan the configuration file to find
15398 where the binary is. (They then use the &%-bP%& option to extract option
15399 settings such as the value of &%spool_directory%&.)
15400
15401
15402 .option exim_user main string "compile-time configured"
15403 .cindex "uid (user id)" "Exim's own"
15404 .cindex "Exim user"
15405 This option changes the uid under which Exim runs when it gives up root
15406 privilege. The default value is compiled into the binary. Ownership of the run
15407 time configuration file and the use of the &%-C%& and &%-D%& command line
15408 options is checked against the values in the binary, not what is set here.
15409
15410 Unless it consists entirely of digits, the string is looked up using
15411 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15412 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15413 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15414
15415
15416 .option exim_version main string "current version"
15417 .cindex "Exim version"
15418 .cindex customizing "version number"
15419 .cindex "version number of Exim" override
15420 This option allows to override the &$version_number$&/&$exim_version$& Exim reports in
15421 various places.  Use with care, this may fool stupid security scanners.
15422
15423
15424 .option extra_local_interfaces main "string list" unset
15425 This option defines network interfaces that are to be considered local when
15426 routing, but which are not used for listening by the daemon. See section
15427 &<<SECTreclocipadd>>& for details.
15428
15429
15430 . Allow this long option name to split; give it unsplit as a fifth argument
15431 . for the automatic .oindex that is generated by .option.
15432
15433 .option "extract_addresses_remove_arguments" main boolean true &&&
15434          extract_addresses_remove_arguments
15435 .oindex "&%-t%&"
15436 .cindex "command line" "addresses with &%-t%&"
15437 .cindex "Sendmail compatibility" "&%-t%& option"
15438 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15439 are present on the command line when the &%-t%& option is used to build an
15440 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15441 line addresses are removed from the recipients list. This is also how Smail
15442 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15443 command line addresses are added to those obtained from the header lines. When
15444 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15445 argument headers. If it is set false, Exim adds rather than removes argument
15446 addresses.
15447
15448
15449 .option finduser_retries main integer 0
15450 .cindex "NIS, retrying user lookups"
15451 On systems running NIS or other schemes in which user and group information is
15452 distributed from a remote system, there can be times when &[getpwnam()]& and
15453 related functions fail, even when given valid data, because things time out.
15454 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15455 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15456 many extra times to find a user or a group, waiting for one second between
15457 retries.
15458
15459 .cindex "&_/etc/passwd_&" "multiple reading of"
15460 You should not set this option greater than zero if your user information is in
15461 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15462 search the file multiple times for non-existent users, and also cause delay.
15463
15464
15465
15466 .option freeze_tell main "string list, comma separated" unset
15467 .cindex "freezing messages" "sending a message when freezing"
15468 On encountering certain errors, or when configured to do so in a system filter,
15469 ACL, or special router, Exim freezes a message. This means that no further
15470 delivery attempts take place until an administrator thaws the message, or the
15471 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15472 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15473 warning message whenever it freezes something, unless the message it is
15474 freezing is a locally-generated bounce message. (Without this exception there
15475 is the possibility of looping.) The warning message is sent to the addresses
15476 supplied as the comma-separated value of this option. If several of the
15477 message's addresses cause freezing, only a single message is sent. If the
15478 freezing was automatic, the reason(s) for freezing can be found in the message
15479 log. If you configure freezing in a filter or ACL, you must arrange for any
15480 logging that you require.
15481
15482
15483 .option gecos_name main string&!! unset
15484 .cindex "HP-UX"
15485 .cindex "&""gecos""& field, parsing"
15486 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15487 password file to hold other information in addition to users' real names. Exim
15488 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15489 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15490 of the field are used unchanged, except that, if an ampersand is encountered,
15491 it is replaced by the user's login name with the first character forced to
15492 upper case, since this is a convention that is observed on many systems.
15493
15494 When these options are set, &%gecos_pattern%& is treated as a regular
15495 expression that is to be applied to the field (again with && replaced by the
15496 login name), and if it matches, &%gecos_name%& is expanded and used as the
15497 user's name.
15498
15499 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15500 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15501 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15502 name terminates at the first comma, the following can be used:
15503 .code
15504 gecos_pattern = ([^,]*)
15505 gecos_name = $1
15506 .endd
15507
15508 .option gecos_pattern main string unset
15509 See &%gecos_name%& above.
15510
15511
15512 .option gnutls_compat_mode main boolean unset
15513 This option controls whether GnuTLS is used in compatibility mode in an Exim
15514 server. This reduces security slightly, but improves interworking with older
15515 implementations of TLS.
15516
15517
15518 .option gnutls_allow_auto_pkcs11 main boolean unset
15519 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15520 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15521
15522 See
15523 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15524 for documentation.
15525
15526
15527
15528 .option headers_charset main string "see below"
15529 This option sets a default character set for translating from encoded MIME
15530 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15531 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15532 ultimate default is ISO-8859-1. For more details see the description of header
15533 insertions in section &<<SECTexpansionitems>>&.
15534
15535
15536
15537 .option header_maxsize main integer "see below"
15538 .cindex "header section" "maximum size of"
15539 .cindex "limit" "size of message header section"
15540 This option controls the overall maximum size of a message's header
15541 section. The default is the value of HEADER_MAXSIZE in
15542 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15543 sections are rejected.
15544
15545
15546 .option header_line_maxsize main integer 0
15547 .cindex "header lines" "maximum size of"
15548 .cindex "limit" "size of one header line"
15549 This option limits the length of any individual header line in a message, after
15550 all the continuations have been joined together. Messages with individual
15551 header lines that are longer than the limit are rejected. The default value of
15552 zero means &"no limit"&.
15553
15554
15555
15556
15557 .option helo_accept_junk_hosts main "host list&!!" unset
15558 .cindex "HELO" "accepting junk data"
15559 .cindex "EHLO" "accepting junk data"
15560 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15561 mail, and gives an error response for invalid data. Unfortunately, there are
15562 some SMTP clients that send syntactic junk. They can be accommodated by setting
15563 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15564 if you want to do semantic checking.
15565 See also &%helo_allow_chars%& for a way of extending the permitted character
15566 set.
15567
15568
15569 .option helo_allow_chars main string unset
15570 .cindex "HELO" "underscores in"
15571 .cindex "EHLO" "underscores in"
15572 .cindex "underscore in EHLO/HELO"
15573 This option can be set to a string of rogue characters that are permitted in
15574 all EHLO and HELO names in addition to the standard letters, digits,
15575 hyphens, and dots. If you really must allow underscores, you can set
15576 .code
15577 helo_allow_chars = _
15578 .endd
15579 Note that the value is one string, not a list.
15580
15581
15582 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15583 .cindex "HELO" "forcing reverse lookup"
15584 .cindex "EHLO" "forcing reverse lookup"
15585 If the domain given by a client in a HELO or EHLO command matches this
15586 list, a reverse lookup is done in order to establish the host's true name. The
15587 default forces a lookup if the client host gives the server's name or any of
15588 its IP addresses (in brackets), something that broken clients have been seen to
15589 do.
15590
15591
15592 .option helo_try_verify_hosts main "host list&!!" unset
15593 .cindex "HELO verifying" "optional"
15594 .cindex "EHLO" "verifying, optional"
15595 By default, Exim just checks the syntax of HELO and EHLO commands (see
15596 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15597 to do more extensive checking of the data supplied by these commands. The ACL
15598 condition &`verify = helo`& is provided to make this possible.
15599 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15600 to force the check to occur. From release 4.53 onwards, this is no longer
15601 necessary. If the check has not been done before &`verify = helo`& is
15602 encountered, it is done at that time. Consequently, this option is obsolete.
15603 Its specification is retained here for backwards compatibility.
15604
15605 When an EHLO or HELO command is received, if the calling host matches
15606 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15607 EHLO command either:
15608
15609 .ilist
15610 is an IP literal matching the calling address of the host, or
15611 .next
15612 .cindex "DNS" "reverse lookup"
15613 .cindex "reverse DNS lookup"
15614 matches the host name that Exim obtains by doing a reverse lookup of the
15615 calling host address, or
15616 .next
15617 when looked up in DNS yields the calling host address.
15618 .endlist
15619
15620 However, the EHLO or HELO command is not rejected if any of the checks
15621 fail. Processing continues, but the result of the check is remembered, and can
15622 be detected later in an ACL by the &`verify = helo`& condition.
15623
15624 If DNS was used for successful verification, the variable
15625 .cindex "DNS" "DNSSEC"
15626 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15627
15628 .option helo_verify_hosts main "host list&!!" unset
15629 .cindex "HELO verifying" "mandatory"
15630 .cindex "EHLO" "verifying, mandatory"
15631 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15632 backwards compatibility. For hosts that match this option, Exim checks the host
15633 name given in the HELO or EHLO in the same way as for
15634 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15635 rejected with a 550 error, and entries are written to the main and reject logs.
15636 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15637 error.
15638
15639 .option hold_domains main "domain list&!!" unset
15640 .cindex "domain" "delaying delivery"
15641 .cindex "delivery" "delaying certain domains"
15642 This option allows mail for particular domains to be held in the queue
15643 manually. The option is overridden if a message delivery is forced with the
15644 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15645 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15646 item in &%hold_domains%&, no routing or delivery for that address is done, and
15647 it is deferred every time the message is looked at.
15648
15649 This option is intended as a temporary operational measure for delaying the
15650 delivery of mail while some problem is being sorted out, or some new
15651 configuration tested. If you just want to delay the processing of some
15652 domains until a queue run occurs, you should use &%queue_domains%& or
15653 &%queue_smtp_domains%&, not &%hold_domains%&.
15654
15655 A setting of &%hold_domains%& does not override Exim's code for removing
15656 messages from the queue if they have been there longer than the longest retry
15657 time in any retry rule. If you want to hold messages for longer than the normal
15658 retry times, insert a dummy retry rule with a long retry time.
15659
15660
15661 .option host_lookup main "host list&!!" unset
15662 .cindex "host name" "lookup, forcing"
15663 Exim does not look up the name of a calling host from its IP address unless it
15664 is required to compare against some host list, or the host matches
15665 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15666 option (which normally contains IP addresses rather than host names). The
15667 default configuration file contains
15668 .code
15669 host_lookup = *
15670 .endd
15671 which causes a lookup to happen for all hosts. If the expense of these lookups
15672 is felt to be too great, the setting can be changed or removed.
15673
15674 After a successful reverse lookup, Exim does a forward lookup on the name it
15675 has obtained, to verify that it yields the IP address that it started with. If
15676 this check fails, Exim behaves as if the name lookup failed.
15677
15678 .vindex "&$host_lookup_failed$&"
15679 .vindex "&$sender_host_name$&"
15680 After any kind of failure, the host name (in &$sender_host_name$&) remains
15681 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15682 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15683 &`verify = reverse_host_lookup`& in ACLs.
15684
15685
15686 .option host_lookup_order main "string list" &`bydns:byaddr`&
15687 This option specifies the order of different lookup methods when Exim is trying
15688 to find a host name from an IP address. The default is to do a DNS lookup
15689 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15690 if that fails. You can change the order of these lookups, or omit one entirely,
15691 if you want.
15692
15693 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15694 multiple PTR records in the DNS and the IP address is not listed in
15695 &_/etc/hosts_&. Different operating systems give different results in this
15696 case. That is why the default tries a DNS lookup first.
15697
15698
15699
15700 .option host_reject_connection main "host list&!!" unset
15701 .cindex "host" "rejecting connections from"
15702 If this option is set, incoming SMTP calls from the hosts listed are rejected
15703 as soon as the connection is made.
15704 This option is obsolete, and retained only for backward compatibility, because
15705 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15706 connections immediately.
15707
15708 The ability to give an immediate rejection (either by this option or using an
15709 ACL) is provided for use in unusual cases. Many hosts will just try again,
15710 sometimes without much delay. Normally, it is better to use an ACL to reject
15711 incoming messages at a later stage, such as after RCPT commands. See
15712 chapter &<<CHAPACL>>&.
15713
15714
15715 .option hosts_connection_nolog main "host list&!!" unset
15716 .cindex "host" "not logging connections from"
15717 This option defines a list of hosts for which connection logging does not
15718 happen, even though the &%smtp_connection%& log selector is set. For example,
15719 you might want not to log SMTP connections from local processes, or from
15720 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15721 the daemon; you should therefore strive to restrict its value to a short inline
15722 list of IP addresses and networks. To disable logging SMTP connections from
15723 local processes, you must create a host list with an empty item. For example:
15724 .code
15725 hosts_connection_nolog = :
15726 .endd
15727 If the &%smtp_connection%& log selector is not set, this option has no effect.
15728
15729
15730
15731 .option hosts_proxy main "host list&!!" unset
15732 .cindex proxy "proxy protocol"
15733 This option enables use of Proxy Protocol proxies for incoming
15734 connections.  For details see section &<<SECTproxyInbound>>&.
15735
15736
15737 .option hosts_treat_as_local main "domain list&!!" unset
15738 .cindex "local host" "domains treated as"
15739 .cindex "host" "treated as local"
15740 If this option is set, any host names that match the domain list are treated as
15741 if they were the local host when Exim is scanning host lists obtained from MX
15742 records
15743 or other sources. Note that the value of this option is a domain list, not a
15744 host list, because it is always used to check host names, not IP addresses.
15745
15746 This option also applies when Exim is matching the special items
15747 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15748 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15749 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15750 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15751 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15752 interfaces and recognizing the local host.
15753
15754
15755 .option ibase_servers main "string list" unset
15756 .cindex "InterBase" "server list"
15757 This option provides a list of InterBase servers and associated connection data,
15758 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15759 The option is available only if Exim has been built with InterBase support.
15760
15761
15762
15763 .option ignore_bounce_errors_after main time 10w
15764 .cindex "bounce message" "discarding"
15765 .cindex "discarding bounce message"
15766 This option affects the processing of bounce messages that cannot be delivered,
15767 that is, those that suffer a permanent delivery failure. (Bounce messages that
15768 suffer temporary delivery failures are of course retried in the usual way.)
15769
15770 After a permanent delivery failure, bounce messages are frozen,
15771 because there is no sender to whom they can be returned. When a frozen bounce
15772 message has been in the queue for more than the given time, it is unfrozen at
15773 the next queue run, and a further delivery is attempted. If delivery fails
15774 again, the bounce message is discarded. This makes it possible to keep failed
15775 bounce messages around for a shorter time than the normal maximum retry time
15776 for frozen messages. For example,
15777 .code
15778 ignore_bounce_errors_after = 12h
15779 .endd
15780 retries failed bounce message deliveries after 12 hours, discarding any further
15781 failures. If the value of this option is set to a zero time period, bounce
15782 failures are discarded immediately. Setting a very long time (as in the default
15783 value) has the effect of disabling this option. For ways of automatically
15784 dealing with other kinds of frozen message, see &%auto_thaw%& and
15785 &%timeout_frozen_after%&.
15786
15787
15788 .option ignore_fromline_hosts main "host list&!!" unset
15789 .cindex "&""From""& line"
15790 .cindex "UUCP" "&""From""& line"
15791 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15792 the headers of a message. By default this is treated as the start of the
15793 message's body, which means that any following headers are not recognized as
15794 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15795 match those hosts that insist on sending it. If the sender is actually a local
15796 process rather than a remote host, and is using &%-bs%& to inject the messages,
15797 &%ignore_fromline_local%& must be set to achieve this effect.
15798
15799
15800 .option ignore_fromline_local main boolean false
15801 See &%ignore_fromline_hosts%& above.
15802
15803 .option keep_environment main "string list" unset
15804 .cindex "environment" "values from"
15805 This option contains a string list of environment variables to keep.
15806 You have to trust these variables or you have to be sure that
15807 these variables do not impose any security risk. Keep in mind that
15808 during the startup phase Exim is running with an effective UID 0 in most
15809 installations. As the default value is an empty list, the default
15810 environment for using libraries, running embedded Perl code, or running
15811 external binaries is empty, and does not not even contain PATH or HOME.
15812
15813 Actually the list is interpreted as a list of patterns
15814 (&<<SECTlistexpand>>&), except that it is not expanded first.
15815
15816 WARNING: Macro substitution is still done first, so having a macro
15817 FOO and having FOO_HOME in your &%keep_environment%& option may have
15818 unexpected results. You may work around this using a regular expression
15819 that does not match the macro name: ^[F]OO_HOME$.
15820
15821 Current versions of Exim issue a warning during startup if you do not mention
15822 &%keep_environment%& in your runtime configuration file and if your
15823 current environment is not empty. Future versions may not issue that warning
15824 anymore.
15825
15826 See the &%add_environment%& main config option for a way to set
15827 environment variables to a fixed value.  The environment for &(pipe)&
15828 transports is handled separately, see section &<<SECTpipeenv>>& for
15829 details.
15830
15831
15832 .option keep_malformed main time 4d
15833 This option specifies the length of time to keep messages whose spool files
15834 have been corrupted in some way. This should, of course, never happen. At the
15835 next attempt to deliver such a message, it gets removed. The incident is
15836 logged.
15837
15838
15839 .option ldap_ca_cert_dir main string unset
15840 .cindex "LDAP", "TLS CA certificate directory"
15841 .cindex certificate "directory for LDAP"
15842 This option indicates which directory contains CA certificates for verifying
15843 a TLS certificate presented by an LDAP server.
15844 While Exim does not provide a default value, your SSL library may.
15845 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15846 and constrained to be a directory.
15847
15848
15849 .option ldap_ca_cert_file main string unset
15850 .cindex "LDAP", "TLS CA certificate file"
15851 .cindex certificate "file for LDAP"
15852 This option indicates which file contains CA certificates for verifying
15853 a TLS certificate presented by an LDAP server.
15854 While Exim does not provide a default value, your SSL library may.
15855 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15856 and constrained to be a file.
15857
15858
15859 .option ldap_cert_file main string unset
15860 .cindex "LDAP" "TLS client certificate file"
15861 .cindex certificate "file for LDAP"
15862 This option indicates which file contains an TLS client certificate which
15863 Exim should present to the LDAP server during TLS negotiation.
15864 Should be used together with &%ldap_cert_key%&.
15865
15866
15867 .option ldap_cert_key main string unset
15868 .cindex "LDAP" "TLS client key file"
15869 .cindex certificate "key for LDAP"
15870 This option indicates which file contains the secret/private key to use
15871 to prove identity to the LDAP server during TLS negotiation.
15872 Should be used together with &%ldap_cert_file%&, which contains the
15873 identity to be proven.
15874
15875
15876 .option ldap_cipher_suite main string unset
15877 .cindex "LDAP" "TLS cipher suite"
15878 This controls the TLS cipher-suite negotiation during TLS negotiation with
15879 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15880 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15881
15882
15883 .option ldap_default_servers main "string list" unset
15884 .cindex "LDAP" "default servers"
15885 This option provides a list of LDAP servers which are tried in turn when an
15886 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15887 details of LDAP queries. This option is available only when Exim has been built
15888 with LDAP support.
15889
15890
15891 .option ldap_require_cert main string unset.
15892 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15893 This should be one of the values "hard", "demand", "allow", "try" or "never".
15894 A value other than one of these is interpreted as "never".
15895 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15896 Although Exim does not set a default, the LDAP library probably defaults
15897 to hard/demand.
15898
15899
15900 .option ldap_start_tls main boolean false
15901 .cindex "LDAP" "whether or not to negotiate TLS"
15902 If set, Exim will attempt to negotiate TLS with the LDAP server when
15903 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15904 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15905 of SSL-on-connect.
15906 In the event of failure to negotiate TLS, the action taken is controlled
15907 by &%ldap_require_cert%&.
15908 This option is ignored for &`ldapi`& connections.
15909
15910
15911 .option ldap_version main integer unset
15912 .cindex "LDAP" "protocol version, forcing"
15913 This option can be used to force Exim to set a specific protocol version for
15914 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15915 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15916 the LDAP headers; otherwise it is 2. This option is available only when Exim
15917 has been built with LDAP support.
15918
15919
15920
15921 .option local_from_check main boolean true
15922 .cindex "&'Sender:'& header line" "disabling addition of"
15923 .cindex "&'From:'& header line" "disabling checking of"
15924 When a message is submitted locally (that is, not over a TCP/IP connection) by
15925 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15926 checks that the &'From:'& header line matches the login of the calling user and
15927 the domain specified by &%qualify_domain%&.
15928
15929 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15930 locally submitted message is automatically qualified by Exim, unless the
15931 &%-bnq%& command line option is used.
15932
15933 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15934 on the local part. If the &'From:'& header line does not match, Exim adds a
15935 &'Sender:'& header with an address constructed from the calling user's login
15936 and the default qualify domain.
15937
15938 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15939 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15940 &'Sender:'& header lines supplied by untrusted users, you must also set
15941 &%local_sender_retain%& to be true.
15942
15943 .cindex "envelope from"
15944 .cindex "envelope sender"
15945 These options affect only the header lines in the message. The envelope sender
15946 is still forced to be the login id at the qualify domain unless
15947 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15948
15949 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15950 request similar header line checking. See section &<<SECTthesenhea>>&, which
15951 has more details about &'Sender:'& processing.
15952
15953
15954
15955
15956 .option local_from_prefix main string unset
15957 When Exim checks the &'From:'& header line of locally submitted messages for
15958 matching the login id (see &%local_from_check%& above), it can be configured to
15959 ignore certain prefixes and suffixes in the local part of the address. This is
15960 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15961 appropriate lists, in the same form as the &%local_part_prefix%& and
15962 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15963 example, if
15964 .code
15965 local_from_prefix = *-
15966 .endd
15967 is set, a &'From:'& line containing
15968 .code
15969 From: anything-user@your.domain.example
15970 .endd
15971 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15972 matches the actual sender address that is constructed from the login name and
15973 qualify domain.
15974
15975
15976 .option local_from_suffix main string unset
15977 See &%local_from_prefix%& above.
15978
15979
15980 .option local_interfaces main "string list" "see below"
15981 This option controls which network interfaces are used by the daemon for
15982 listening; they are also used to identify the local host when routing. Chapter
15983 &<<CHAPinterfaces>>& contains a full description of this option and the related
15984 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15985 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15986 &%local_interfaces%& is
15987 .code
15988 local_interfaces = 0.0.0.0
15989 .endd
15990 when Exim is built without IPv6 support; otherwise it is
15991 .code
15992 local_interfaces = <; ::0 ; 0.0.0.0
15993 .endd
15994
15995 .option local_scan_timeout main time 5m
15996 .cindex "timeout" "for &[local_scan()]& function"
15997 .cindex "&[local_scan()]& function" "timeout"
15998 This timeout applies to the &[local_scan()]& function (see chapter
15999 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16000 the incoming message is rejected with a temporary error if it is an SMTP
16001 message. For a non-SMTP message, the message is dropped and Exim ends with a
16002 non-zero code. The incident is logged on the main and reject logs.
16003
16004
16005
16006 .option local_sender_retain main boolean false
16007 .cindex "&'Sender:'& header line" "retaining from local submission"
16008 When a message is submitted locally (that is, not over a TCP/IP connection) by
16009 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16010 do not want this to happen, you must set &%local_sender_retain%&, and you must
16011 also set &%local_from_check%& to be false (Exim will complain if you do not).
16012 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16013 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16014
16015
16016
16017
16018 .option localhost_number main string&!! unset
16019 .cindex "host" "locally unique number for"
16020 .cindex "message ids" "with multiple hosts"
16021 .vindex "&$localhost_number$&"
16022 Exim's message ids are normally unique only within the local host. If
16023 uniqueness among a set of hosts is required, each host must set a different
16024 value for the &%localhost_number%& option. The string is expanded immediately
16025 after reading the configuration file (so that a number can be computed from the
16026 host name, for example) and the result of the expansion must be a number in the
16027 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16028 systems). This is available in subsequent string expansions via the variable
16029 &$localhost_number$&. When &%localhost_number is set%&, the final two
16030 characters of the message id, instead of just being a fractional part of the
16031 time, are computed from the time and the local host number as described in
16032 section &<<SECTmessiden>>&.
16033
16034
16035
16036 .option log_file_path main "string list&!!" "set at compile time"
16037 .cindex "log" "file path for"
16038 This option sets the path which is used to determine the names of Exim's log
16039 files, or indicates that logging is to be to syslog, or both. It is expanded
16040 when Exim is entered, so it can, for example, contain a reference to the host
16041 name. If no specific path is set for the log files at compile or runtime,
16042 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16043 they are written in a sub-directory called &_log_& in Exim's spool directory.
16044 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16045 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16046 used. If this string is fixed at your installation (contains no expansion
16047 variables) it is recommended that you do not set this option in the
16048 configuration file, but instead supply the path using LOG_FILE_PATH in
16049 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16050 early on &-- in particular, failure to read the configuration file.
16051
16052
16053 .option log_selector main string unset
16054 .cindex "log" "selectors"
16055 This option can be used to reduce or increase the number of things that Exim
16056 writes to its log files. Its argument is made up of names preceded by plus or
16057 minus characters. For example:
16058 .code
16059 log_selector = +arguments -retry_defer
16060 .endd
16061 A list of possible names and what they control is given in the chapter on
16062 logging, in section &<<SECTlogselector>>&.
16063
16064
16065 .option log_timezone main boolean false
16066 .cindex "log" "timezone for entries"
16067 .vindex "&$tod_log$&"
16068 .vindex "&$tod_zone$&"
16069 By default, the timestamps on log lines are in local time without the
16070 timezone. This means that if your timezone changes twice a year, the timestamps
16071 in log lines are ambiguous for an hour when the clocks go back. One way of
16072 avoiding this problem is to set the timezone to UTC. An alternative is to set
16073 &%log_timezone%& true. This turns on the addition of the timezone offset to
16074 timestamps in log lines. Turning on this option can add quite a lot to the size
16075 of log files because each line is extended by 6 characters. Note that the
16076 &$tod_log$& variable contains the log timestamp without the zone, but there is
16077 another variable called &$tod_zone$& that contains just the timezone offset.
16078
16079
16080 .option lookup_open_max main integer 25
16081 .cindex "too many open files"
16082 .cindex "open files, too many"
16083 .cindex "file" "too many open"
16084 .cindex "lookup" "maximum open files"
16085 .cindex "limit" "open files for lookups"
16086 This option limits the number of simultaneously open files for single-key
16087 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16088 Exim normally keeps these files open during routing, because often the same
16089 file is required several times. If the limit is reached, Exim closes the least
16090 recently used file. Note that if you are using the &'ndbm'& library, it
16091 actually opens two files for each logical DBM database, though it still counts
16092 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16093 open files"& errors with NDBM, you need to reduce the value of
16094 &%lookup_open_max%&.
16095
16096
16097 .option max_username_length main integer 0
16098 .cindex "length of login name"
16099 .cindex "user name" "maximum length"
16100 .cindex "limit" "user name length"
16101 Some operating systems are broken in that they truncate long arguments to
16102 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16103 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16104 an argument that is longer behaves as if &[getpwnam()]& failed.
16105
16106
16107 .option message_body_newlines main bool false
16108 .cindex "message body" "newlines in variables"
16109 .cindex "newline" "in message body variables"
16110 .vindex "&$message_body$&"
16111 .vindex "&$message_body_end$&"
16112 By default, newlines in the message body are replaced by spaces when setting
16113 the &$message_body$& and &$message_body_end$& expansion variables. If this
16114 option is set true, this no longer happens.
16115
16116
16117 .option message_body_visible main integer 500
16118 .cindex "body of message" "visible size"
16119 .cindex "message body" "visible size"
16120 .vindex "&$message_body$&"
16121 .vindex "&$message_body_end$&"
16122 This option specifies how much of a message's body is to be included in the
16123 &$message_body$& and &$message_body_end$& expansion variables.
16124
16125
16126 .option message_id_header_domain main string&!! unset
16127 .cindex "&'Message-ID:'& header line"
16128 If this option is set, the string is expanded and used as the right hand side
16129 (domain) of the &'Message-ID:'& header that Exim creates if a
16130 locally-originated incoming message does not have one. &"Locally-originated"&
16131 means &"not received over TCP/IP."&
16132 Otherwise, the primary host name is used.
16133 Only letters, digits, dot and hyphen are accepted; any other characters are
16134 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16135 empty string, the option is ignored.
16136
16137
16138 .option message_id_header_text main string&!! unset
16139 If this variable is set, the string is expanded and used to augment the text of
16140 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16141 message does not have one. The text of this header is required by RFC 2822 to
16142 take the form of an address. By default, Exim uses its internal message id as
16143 the local part, and the primary host name as the domain. If this option is set,
16144 it is expanded, and provided the expansion is not forced to fail, and does not
16145 yield an empty string, the result is inserted into the header immediately
16146 before the @, separated from the internal message id by a dot. Any characters
16147 that are illegal in an address are automatically converted into hyphens. This
16148 means that variables such as &$tod_log$& can be used, because the spaces and
16149 colons will become hyphens.
16150
16151
16152 .option message_logs main boolean true
16153 .cindex "message logs" "disabling"
16154 .cindex "log" "message log; disabling"
16155 If this option is turned off, per-message log files are not created in the
16156 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16157 Exim, by reducing the number of files involved in handling a message from a
16158 minimum of four (header spool file, body spool file, delivery journal, and
16159 per-message log) to three. The other major I/O activity is Exim's main log,
16160 which is not affected by this option.
16161
16162
16163 .option message_size_limit main string&!! 50M
16164 .cindex "message" "size limit"
16165 .cindex "limit" "message size"
16166 .cindex "size" "of message, limit"
16167 This option limits the maximum size of message that Exim will process. The
16168 value is expanded for each incoming connection so, for example, it can be made
16169 to depend on the IP address of the remote host for messages arriving via
16170 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16171 optionally followed by K or M.
16172
16173 &*Note*&: This limit cannot be made to depend on a message's sender or any
16174 other properties of an individual message, because it has to be advertised in
16175 the server's response to EHLO. String expansion failure causes a temporary
16176 error. A value of zero means no limit, but its use is not recommended. See also
16177 &%bounce_return_size_limit%&.
16178
16179 Incoming SMTP messages are failed with a 552 error if the limit is
16180 exceeded; locally-generated messages either get a stderr message or a delivery
16181 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16182 an oversized message is logged in both the main and the reject logs. See also
16183 the generic transport option &%message_size_limit%&, which limits the size of
16184 message that an individual transport can process.
16185
16186 If you use a virus-scanner and set this option to to a value larger than the
16187 maximum size that your virus-scanner is configured to support, you may get
16188 failures triggered by large mails.  The right size to configure for the
16189 virus-scanner depends upon what data is passed and the options in use but it's
16190 probably safest to just set it to a little larger than this value.  E.g., with a
16191 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16192 some problems may result.
16193
16194 A value of 0 will disable size limit checking; Exim will still advertise the
16195 SIZE extension in an EHLO response, but without a limit, so as to permit
16196 SMTP clients to still indicate the message size along with the MAIL verb.
16197
16198
16199 .option move_frozen_messages main boolean false
16200 .cindex "frozen messages" "moving"
16201 This option, which is available only if Exim has been built with the setting
16202 .code
16203 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16204 .endd
16205 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16206 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16207 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16208 standard utilities for handling such moved messages, and they do not show up in
16209 lists generated by &%-bp%& or by the Exim monitor.
16210
16211
16212 .option mua_wrapper main boolean false
16213 Setting this option true causes Exim to run in a very restrictive mode in which
16214 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16215 contains a full description of this facility.
16216
16217
16218
16219 .option mysql_servers main "string list" unset
16220 .cindex "MySQL" "server list"
16221 This option provides a list of MySQL servers and associated connection data, to
16222 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16223 option is available only if Exim has been built with MySQL support.
16224
16225
16226 .option never_users main "string list&!!" unset
16227 This option is expanded just once, at the start of Exim's processing. Local
16228 message deliveries are normally run in processes that are setuid to the
16229 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16230 It is usually desirable to prevent any deliveries from running as root, as a
16231 safety precaution.
16232
16233 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16234 list of users that must not be used for local deliveries. This list is fixed in
16235 the binary and cannot be overridden by the configuration file. By default, it
16236 contains just the single user name &"root"&. The &%never_users%& runtime option
16237 can be used to add more users to the fixed list.
16238
16239 If a message is to be delivered as one of the users on the fixed list or the
16240 &%never_users%& list, an error occurs, and delivery is deferred. A common
16241 example is
16242 .code
16243 never_users = root:daemon:bin
16244 .endd
16245 Including root is redundant if it is also on the fixed list, but it does no
16246 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16247 transport driver.
16248
16249
16250 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket"
16251 .cindex "OpenSSL "compatibility options"
16252 This option allows an administrator to adjust the SSL options applied
16253 by OpenSSL to connections.  It is given as a space-separated list of items,
16254 each one to be +added or -subtracted from the current value.
16255
16256 This option is only available if Exim is built against OpenSSL.  The values
16257 available for this option vary according to the age of your OpenSSL install.
16258 The &"all"& value controls a subset of flags which are available, typically
16259 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16260 list the values known on your system and Exim should support all the
16261 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16262 names lose the leading &"SSL_OP_"& and are lower-cased.
16263
16264 Note that adjusting the options can have severe impact upon the security of
16265 SSL as used by Exim.  It is possible to disable safety checks and shoot
16266 yourself in the foot in various unpleasant ways.  This option should not be
16267 adjusted lightly.  An unrecognised item will be detected at startup, by
16268 invoking Exim with the &%-bV%& flag.
16269
16270 The option affects Exim operating both as a server and as a client.
16271
16272 Historical note: prior to release 4.80, Exim defaulted this value to
16273 "+dont_insert_empty_fragments", which may still be needed for compatibility
16274 with some clients, but which lowers security by increasing exposure to
16275 some now infamous attacks.
16276
16277 Examples:
16278 .code
16279 # Make both old MS and old Eudora happy:
16280 openssl_options = -all +microsoft_big_sslv3_buffer \
16281                        +dont_insert_empty_fragments
16282
16283 # Disable older protocol versions:
16284 openssl_options = +no_sslv2 +no_sslv3
16285 .endd
16286
16287 Possible options may include:
16288 .ilist
16289 &`all`&
16290 .next
16291 &`allow_unsafe_legacy_renegotiation`&
16292 .next
16293 &`cipher_server_preference`&
16294 .next
16295 &`dont_insert_empty_fragments`&
16296 .next
16297 &`ephemeral_rsa`&
16298 .next
16299 &`legacy_server_connect`&
16300 .next
16301 &`microsoft_big_sslv3_buffer`&
16302 .next
16303 &`microsoft_sess_id_bug`&
16304 .next
16305 &`msie_sslv2_rsa_padding`&
16306 .next
16307 &`netscape_challenge_bug`&
16308 .next
16309 &`netscape_reuse_cipher_change_bug`&
16310 .next
16311 &`no_compression`&
16312 .next
16313 &`no_session_resumption_on_renegotiation`&
16314 .next
16315 &`no_sslv2`&
16316 .next
16317 &`no_sslv3`&
16318 .next
16319 &`no_ticket`&
16320 .next
16321 &`no_tlsv1`&
16322 .next
16323 &`no_tlsv1_1`&
16324 .next
16325 &`no_tlsv1_2`&
16326 .next
16327 &`safari_ecdhe_ecdsa_bug`&
16328 .next
16329 &`single_dh_use`&
16330 .next
16331 &`single_ecdh_use`&
16332 .next
16333 &`ssleay_080_client_dh_bug`&
16334 .next
16335 &`sslref2_reuse_cert_type_bug`&
16336 .next
16337 &`tls_block_padding_bug`&
16338 .next
16339 &`tls_d5_bug`&
16340 .next
16341 &`tls_rollback_bug`&
16342 .endlist
16343
16344 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16345 all clients connecting using the MacOS SecureTransport TLS facility prior
16346 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16347 to negotiate TLS then this option value might help, provided that your OpenSSL
16348 release is new enough to contain this work-around.  This may be a situation
16349 where you have to upgrade OpenSSL to get buggy clients working.
16350
16351
16352 .option oracle_servers main "string list" unset
16353 .cindex "Oracle" "server list"
16354 This option provides a list of Oracle servers and associated connection data,
16355 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16356 The option is available only if Exim has been built with Oracle support.
16357
16358
16359 .option percent_hack_domains main "domain list&!!" unset
16360 .cindex "&""percent hack""&"
16361 .cindex "source routing" "in email address"
16362 .cindex "address" "source-routed"
16363 The &"percent hack"& is the convention whereby a local part containing a
16364 percent sign is re-interpreted as a new email address, with the percent
16365 replaced by @. This is sometimes called &"source routing"&, though that term is
16366 also applied to RFC 2822 addresses that begin with an @ character. If this
16367 option is set, Exim implements the percent facility for those domains listed,
16368 but no others. This happens before an incoming SMTP address is tested against
16369 an ACL.
16370
16371 &*Warning*&: The &"percent hack"& has often been abused by people who are
16372 trying to get round relaying restrictions. For this reason, it is best avoided
16373 if at all possible. Unfortunately, a number of less security-conscious MTAs
16374 implement it unconditionally. If you are running Exim on a gateway host, and
16375 routing mail through to internal MTAs without processing the local parts, it is
16376 a good idea to reject recipient addresses with percent characters in their
16377 local parts. Exim's default configuration does this.
16378
16379
16380 .option perl_at_start main boolean false
16381 .cindex "Perl"
16382 This option is available only when Exim is built with an embedded Perl
16383 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16384
16385
16386 .option perl_startup main string unset
16387 .cindex "Perl"
16388 This option is available only when Exim is built with an embedded Perl
16389 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16390
16391 .option perl_startup main boolean false
16392 .cindex "Perl"
16393 This Option enables the taint mode of the embedded Perl interpreter.
16394
16395
16396 .option pgsql_servers main "string list" unset
16397 .cindex "PostgreSQL lookup type" "server list"
16398 This option provides a list of PostgreSQL servers and associated connection
16399 data, to be used in conjunction with &(pgsql)& lookups (see section
16400 &<<SECID72>>&). The option is available only if Exim has been built with
16401 PostgreSQL support.
16402
16403
16404 .option pid_file_path main string&!! "set at compile time"
16405 .cindex "daemon" "pid file path"
16406 .cindex "pid file, path for"
16407 This option sets the name of the file to which the Exim daemon writes its
16408 process id. The string is expanded, so it can contain, for example, references
16409 to the host name:
16410 .code
16411 pid_file_path = /var/log/$primary_hostname/exim.pid
16412 .endd
16413 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16414 spool directory.
16415 The value set by the option can be overridden by the &%-oP%& command line
16416 option. A pid file is not written if a &"non-standard"& daemon is run by means
16417 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16418
16419
16420 .option pipelining_advertise_hosts main "host list&!!" *
16421 .cindex "PIPELINING" "suppressing advertising"
16422 This option can be used to suppress the advertisement of the SMTP
16423 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16424 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16425 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16426 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16427 that clients will use it; &"out of order"& commands that are &"expected"& do
16428 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16429
16430 .new
16431 .option pipelining_connect_advertise_hosts main "host list&!!" *
16432 .cindex "pipelining" "early connection"
16433 .cindex "pipelining" PIPE_CONNECT
16434 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16435 this option controls which hosts the facility is advertised to
16436 and from which pipeline early-connection (before MAIL) SMTP
16437 commands are acceptable.
16438 When used, the pipelining saves on roundtrip times.
16439
16440 Currently the option name &"X_PIPE_CONNECT"& is used.
16441 .wen
16442
16443
16444 .option prdr_enable main boolean false
16445 .cindex "PRDR" "enabling on server"
16446 This option can be used to enable the Per-Recipient Data Response extension
16447 to SMTP, defined by Eric Hall.
16448 If the option is set, PRDR is advertised by Exim when operating as a server.
16449 If the client requests PRDR, and more than one recipient, for a message
16450 an additional ACL is called for each recipient after the message content
16451 is received.  See section &<<SECTPRDRACL>>&.
16452
16453 .option preserve_message_logs main boolean false
16454 .cindex "message logs" "preserving"
16455 If this option is set, message log files are not deleted when messages are
16456 completed. Instead, they are moved to a sub-directory of the spool directory
16457 called &_msglog.OLD_&, where they remain available for statistical or debugging
16458 purposes. This is a dangerous option to set on systems with any appreciable
16459 volume of mail. Use with care!
16460
16461
16462 .option primary_hostname main string "see below"
16463 .cindex "name" "of local host"
16464 .cindex "host" "name of local"
16465 .cindex "local host" "name of"
16466 .vindex "&$primary_hostname$&"
16467 This specifies the name of the current host. It is used in the default EHLO or
16468 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16469 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16470 The value is also used by default in some SMTP response messages from an Exim
16471 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16472
16473 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16474 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16475 contains only one component, Exim passes it to &[gethostbyname()]& (or
16476 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16477 version. The variable &$primary_hostname$& contains the host name, whether set
16478 explicitly by this option, or defaulted.
16479
16480
16481 .option print_topbitchars main boolean false
16482 .cindex "printing characters"
16483 .cindex "8-bit characters"
16484 By default, Exim considers only those characters whose codes lie in the range
16485 32&--126 to be printing characters. In a number of circumstances (for example,
16486 when writing log entries) non-printing characters are converted into escape
16487 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16488 is set, code values of 128 and above are also considered to be printing
16489 characters.
16490
16491 This option also affects the header syntax checks performed by the
16492 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16493 the user's full name when constructing From: and Sender: addresses (as
16494 described in section &<<SECTconstr>>&). Setting this option can cause
16495 Exim to generate eight bit message headers that do not conform to the
16496 standards.
16497
16498
16499 .option process_log_path main string unset
16500 .cindex "process log path"
16501 .cindex "log" "process log"
16502 .cindex "&'exiwhat'&"
16503 This option sets the name of the file to which an Exim process writes its
16504 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16505 utility script. If this option is unset, the file called &_exim-process.info_&
16506 in Exim's spool directory is used. The ability to specify the name explicitly
16507 can be useful in environments where two different Exims are running, using
16508 different spool directories.
16509
16510
16511 .option prod_requires_admin main boolean true
16512 .cindex "restricting access to features"
16513 .oindex "&%-M%&"
16514 .oindex "&%-R%&"
16515 .oindex "&%-q%&"
16516 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16517 admin user unless &%prod_requires_admin%& is set false. See also
16518 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16519
16520
16521 .option qualify_domain main string "see below"
16522 .cindex "domain" "for qualifying addresses"
16523 .cindex "address" "qualification"
16524 This option specifies the domain name that is added to any envelope sender
16525 addresses that do not have a domain qualification. It also applies to
16526 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16527 are accepted by default only for locally-generated messages. Qualification is
16528 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16529 locally-generated messages, unless the &%-bnq%& command line option is used.
16530
16531 Messages from external sources must always contain fully qualified addresses,
16532 unless the sending host matches &%sender_unqualified_hosts%& or
16533 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16534 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16535 necessary. Internally, Exim always works with fully qualified envelope
16536 addresses. If &%qualify_domain%& is not set, it defaults to the
16537 &%primary_hostname%& value.
16538
16539
16540 .option qualify_recipient main string "see below"
16541 This option allows you to specify a different domain for qualifying recipient
16542 addresses to the one that is used for senders. See &%qualify_domain%& above.
16543
16544
16545
16546 .option queue_domains main "domain list&!!" unset
16547 .cindex "domain" "specifying non-immediate delivery"
16548 .cindex "queueing incoming messages"
16549 .cindex "message" "queueing certain domains"
16550 This option lists domains for which immediate delivery is not required.
16551 A delivery process is started whenever a message is received, but only those
16552 domains that do not match are processed. All other deliveries wait until the
16553 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16554
16555
16556 .option queue_list_requires_admin main boolean true
16557 .cindex "restricting access to features"
16558 .oindex "&%-bp%&"
16559 The &%-bp%& command-line option, which lists the messages that are on the
16560 queue, requires the caller to be an admin user unless
16561 &%queue_list_requires_admin%& is set false.
16562 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16563
16564
16565 .option queue_only main boolean false
16566 .cindex "queueing incoming messages"
16567 .cindex "message" "queueing unconditionally"
16568 If &%queue_only%& is set, a delivery process is not automatically started
16569 whenever a message is received. Instead, the message waits in the queue for the
16570 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16571 delivered immediately when certain conditions (such as heavy load) occur.
16572
16573 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16574 and &%-odi%& command line options override &%queue_only%& unless
16575 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16576 &%queue_only_load%&, and &%smtp_accept_queue%&.
16577
16578
16579 .option queue_only_file main string unset
16580 .cindex "queueing incoming messages"
16581 .cindex "message" "queueing by file existence"
16582 This option can be set to a colon-separated list of absolute path names, each
16583 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16584 it tests for the existence of each listed path using a call to &[stat()]&. For
16585 each path that exists, the corresponding queueing option is set.
16586 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16587 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16588 .code
16589 queue_only_file = smtp/some/file
16590 .endd
16591 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16592 &_/some/file_& exists.
16593
16594
16595 .option queue_only_load main fixed-point unset
16596 .cindex "load average"
16597 .cindex "queueing incoming messages"
16598 .cindex "message" "queueing by load"
16599 If the system load average is higher than this value, incoming messages from
16600 all sources are queued, and no automatic deliveries are started. If this
16601 happens during local or remote SMTP input, all subsequent messages received on
16602 the same SMTP connection are queued by default, whatever happens to the load in
16603 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16604 false.
16605
16606 Deliveries will subsequently be performed by queue runner processes. This
16607 option has no effect on ancient operating systems on which Exim cannot
16608 determine the load average. See also &%deliver_queue_load_max%& and
16609 &%smtp_load_reserve%&.
16610
16611
16612 .option queue_only_load_latch main boolean true
16613 .cindex "load average" "re-evaluating per message"
16614 When this option is true (the default), once one message has been queued
16615 because the load average is higher than the value set by &%queue_only_load%&,
16616 all subsequent messages received on the same SMTP connection are also queued.
16617 This is a deliberate choice; even though the load average may fall below the
16618 threshold, it doesn't seem right to deliver later messages on the same
16619 connection when not delivering earlier ones. However, there are special
16620 circumstances such as very long-lived connections from scanning appliances
16621 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16622 should be set false. This causes the value of the load average to be
16623 re-evaluated for each message.
16624
16625
16626 .option queue_only_override main boolean true
16627 .cindex "queueing incoming messages"
16628 When this option is true, the &%-od%&&'x'& command line options override the
16629 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16630 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16631 to override; they are accepted, but ignored.
16632
16633
16634 .option queue_run_in_order main boolean false
16635 .cindex "queue runner" "processing messages in order"
16636 If this option is set, queue runs happen in order of message arrival instead of
16637 in an arbitrary order. For this to happen, a complete list of the entire queue
16638 must be set up before the deliveries start. When the queue is all held in a
16639 single directory (the default), a single list is created for both the ordered
16640 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16641 single list is not created when &%queue_run_in_order%& is false. In this case,
16642 the sub-directories are processed one at a time (in a random order), and this
16643 avoids setting up one huge list for the whole queue. Thus, setting
16644 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16645 when the queue is large, because of the extra work in setting up the single,
16646 large list. In most situations, &%queue_run_in_order%& should not be set.
16647
16648
16649
16650 .option queue_run_max main integer&!! 5
16651 .cindex "queue runner" "maximum number of"
16652 This controls the maximum number of queue runner processes that an Exim daemon
16653 can run simultaneously. This does not mean that it starts them all at once,
16654 but rather that if the maximum number are still running when the time comes to
16655 start another one, it refrains from starting another one. This can happen with
16656 very large queues and/or very sluggish deliveries. This option does not,
16657 however, interlock with other processes, so additional queue runners can be
16658 started by other means, or by killing and restarting the daemon.
16659
16660 Setting this option to zero does not suppress queue runs; rather, it disables
16661 the limit, allowing any number of simultaneous queue runner processes to be
16662 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16663 the daemon's command line.
16664
16665 .cindex queues named
16666 .cindex "named queues"
16667 To set limits for different named queues use
16668 an expansion depending on the &$queue_name$& variable.
16669
16670 .option queue_smtp_domains main "domain list&!!" unset
16671 .cindex "queueing incoming messages"
16672 .cindex "message" "queueing remote deliveries"
16673 When this option is set, a delivery process is started whenever a message is
16674 received, routing is performed, and local deliveries take place.
16675 However, if any SMTP deliveries are required for domains that match
16676 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16677 message waits in the queue for the next queue run. Since routing of the message
16678 has taken place, Exim knows to which remote hosts it must be delivered, and so
16679 when the queue run happens, multiple messages for the same host are delivered
16680 over a single SMTP connection. The &%-odqs%& command line option causes all
16681 SMTP deliveries to be queued in this way, and is equivalent to setting
16682 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16683 &%queue_domains%&.
16684
16685
16686 .option receive_timeout main time 0s
16687 .cindex "timeout" "for non-SMTP input"
16688 This option sets the timeout for accepting a non-SMTP message, that is, the
16689 maximum time that Exim waits when reading a message on the standard input. If
16690 the value is zero, it will wait forever. This setting is overridden by the
16691 &%-or%& command line option. The timeout for incoming SMTP messages is
16692 controlled by &%smtp_receive_timeout%&.
16693
16694 .option received_header_text main string&!! "see below"
16695 .cindex "customizing" "&'Received:'& header"
16696 .cindex "&'Received:'& header line" "customizing"
16697 This string defines the contents of the &'Received:'& message header that is
16698 added to each message, except for the timestamp, which is automatically added
16699 on at the end (preceded by a semicolon). The string is expanded each time it is
16700 used. If the expansion yields an empty string, no &'Received:'& header line is
16701 added to the message. Otherwise, the string should start with the text
16702 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16703 header lines.
16704 .new
16705 The default setting is:
16706
16707 .code
16708 received_header_text = Received: \
16709   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16710     {${if def:sender_ident \
16711       {from ${quote_local_part:$sender_ident} }}\
16712         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16713   by $primary_hostname \
16714   ${if def:received_protocol {with $received_protocol }}\
16715   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16716   (Exim $version_number)\n\t\
16717   ${if def:sender_address \
16718   {(envelope-from <$sender_address>)\n\t}}\
16719   id $message_exim_id\
16720   ${if def:received_for {\n\tfor $received_for}}
16721 .endd
16722 .wen
16723
16724 The reference to the TLS cipher is omitted when Exim is built without TLS
16725 support. The use of conditional expansions ensures that this works for both
16726 locally generated messages and messages received from remote hosts, giving
16727 header lines such as the following:
16728 .code
16729 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16730 by marley.carol.example with esmtp (Exim 4.00)
16731 (envelope-from <bob@carol.example>)
16732 id 16IOWa-00019l-00
16733 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16734 Received: by scrooge.carol.example with local (Exim 4.00)
16735 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16736 .endd
16737 Until the body of the message has been received, the timestamp is the time when
16738 the message started to be received. Once the body has arrived, and all policy
16739 checks have taken place, the timestamp is updated to the time at which the
16740 message was accepted.
16741
16742
16743 .option received_headers_max main integer 30
16744 .cindex "loop" "prevention"
16745 .cindex "mail loop prevention"
16746 .cindex "&'Received:'& header line" "counting"
16747 When a message is to be delivered, the number of &'Received:'& headers is
16748 counted, and if it is greater than this parameter, a mail loop is assumed to
16749 have occurred, the delivery is abandoned, and an error message is generated.
16750 This applies to both local and remote deliveries.
16751
16752
16753 .option recipient_unqualified_hosts main "host list&!!" unset
16754 .cindex "unqualified addresses"
16755 .cindex "host" "unqualified addresses from"
16756 This option lists those hosts from which Exim is prepared to accept unqualified
16757 recipient addresses in message envelopes. The addresses are made fully
16758 qualified by the addition of the &%qualify_recipient%& value. This option also
16759 affects message header lines. Exim does not reject unqualified recipient
16760 addresses in headers, but it qualifies them only if the message came from a
16761 host that matches &%recipient_unqualified_hosts%&,
16762 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16763 option was not set.
16764
16765
16766 .option recipients_max main integer 0
16767 .cindex "limit" "number of recipients"
16768 .cindex "recipient" "maximum number"
16769 If this option is set greater than zero, it specifies the maximum number of
16770 original recipients for any message. Additional recipients that are generated
16771 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16772 all recipients over the limit; earlier recipients are delivered as normal.
16773 Non-SMTP messages with too many recipients are failed, and no deliveries are
16774 done.
16775
16776 .cindex "RCPT" "maximum number of incoming"
16777 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16778 RCPT commands in a single message.
16779
16780
16781 .option recipients_max_reject main boolean false
16782 If this option is set true, Exim rejects SMTP messages containing too many
16783 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16784 error to the eventual DATA command. Otherwise (the default) it gives a 452
16785 error to the surplus RCPT commands and accepts the message on behalf of the
16786 initial set of recipients. The remote server should then re-send the message
16787 for the remaining recipients at a later time.
16788
16789
16790 .option remote_max_parallel main integer 2
16791 .cindex "delivery" "parallelism for remote"
16792 This option controls parallel delivery of one message to a number of remote
16793 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16794 does all the remote deliveries for a message one by one. Otherwise, if a single
16795 message has to be delivered to more than one remote host, or if several copies
16796 have to be sent to the same remote host, up to &%remote_max_parallel%&
16797 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16798 deliveries are required, the maximum number of processes are started, and as
16799 each one finishes, another is begun. The order of starting processes is the
16800 same as if sequential delivery were being done, and can be controlled by the
16801 &%remote_sort_domains%& option. If parallel delivery takes place while running
16802 with debugging turned on, the debugging output from each delivery process is
16803 tagged with its process id.
16804
16805 This option controls only the maximum number of parallel deliveries for one
16806 message in one Exim delivery process. Because Exim has no central queue
16807 manager, there is no way of controlling the total number of simultaneous
16808 deliveries if the configuration allows a delivery attempt as soon as a message
16809 is received.
16810
16811 .cindex "number of deliveries"
16812 .cindex "delivery" "maximum number of"
16813 If you want to control the total number of deliveries on the system, you
16814 need to set the &%queue_only%& option. This ensures that all incoming messages
16815 are added to the queue without starting a delivery process. Then set up an Exim
16816 daemon to start queue runner processes at appropriate intervals (probably
16817 fairly often, for example, every minute), and limit the total number of queue
16818 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16819 delivers only one message at a time, the maximum number of deliveries that can
16820 then take place at once is &%queue_run_max%& multiplied by
16821 &%remote_max_parallel%&.
16822
16823 If it is purely remote deliveries you want to control, use
16824 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16825 doing the SMTP routing before queueing, so that several messages for the same
16826 host will eventually get delivered down the same connection.
16827
16828
16829 .option remote_sort_domains main "domain list&!!" unset
16830 .cindex "sorting remote deliveries"
16831 .cindex "delivery" "sorting remote"
16832 When there are a number of remote deliveries for a message, they are sorted by
16833 domain into the order given by this list. For example,
16834 .code
16835 remote_sort_domains = *.cam.ac.uk:*.uk
16836 .endd
16837 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16838 then to those in the &%uk%& domain, then to any others.
16839
16840
16841 .option retry_data_expire main time 7d
16842 .cindex "hints database" "data expiry"
16843 This option sets a &"use before"& time on retry information in Exim's hints
16844 database. Any older retry data is ignored. This means that, for example, once a
16845 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16846 past failures.
16847
16848
16849 .option retry_interval_max main time 24h
16850 .cindex "retry" "limit on interval"
16851 .cindex "limit" "on retry interval"
16852 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16853 intervals between delivery attempts for messages that cannot be delivered
16854 straight away. This option sets an overall limit to the length of time between
16855 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16856 the default value.
16857
16858
16859 .option return_path_remove main boolean true
16860 .cindex "&'Return-path:'& header line" "removing"
16861 RFC 2821, section 4.4, states that an SMTP server must insert a
16862 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16863 The &'Return-path:'& header preserves the sender address as received in the
16864 MAIL command. This description implies that this header should not be present
16865 in an incoming message. If &%return_path_remove%& is true, any existing
16866 &'Return-path:'& headers are removed from messages at the time they are
16867 received. Exim's transports have options for adding &'Return-path:'& headers at
16868 the time of delivery. They are normally used only for final local deliveries.
16869
16870
16871 .option return_size_limit main integer 100K
16872 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16873
16874
16875 .option rfc1413_hosts main "host list&!!" @[]
16876 .cindex "RFC 1413"
16877 .cindex "host" "for RFC 1413 calls"
16878 RFC 1413 identification calls are made to any client host which matches
16879 an item in the list.
16880 The default value specifies just this host, being any local interface
16881 for the system.
16882
16883 .option rfc1413_query_timeout main time 0s
16884 .cindex "RFC 1413" "query timeout"
16885 .cindex "timeout" "for RFC 1413 call"
16886 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16887 no RFC 1413 calls are ever made.
16888
16889
16890 .option sender_unqualified_hosts main "host list&!!" unset
16891 .cindex "unqualified addresses"
16892 .cindex "host" "unqualified addresses from"
16893 This option lists those hosts from which Exim is prepared to accept unqualified
16894 sender addresses. The addresses are made fully qualified by the addition of
16895 &%qualify_domain%&. This option also affects message header lines. Exim does
16896 not reject unqualified addresses in headers that contain sender addresses, but
16897 it qualifies them only if the message came from a host that matches
16898 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16899 using TCP/IP), and the &%-bnq%& option was not set.
16900
16901 .option set_environment main "string list" empty
16902 .cindex "environment"
16903 This option allows to set individual environment variables that the
16904 currently linked libraries and programs in child processes use. The
16905 default list is empty,
16906
16907
16908 .option slow_lookup_log main integer 0
16909 .cindex "logging" "slow lookups"
16910 .cindex "dns" "logging slow lookups"
16911 This option controls logging of slow lookups.
16912 If the value is nonzero it is taken as a number of milliseconds
16913 and lookups taking longer than this are logged.
16914 Currently this applies only to DNS lookups.
16915
16916
16917
16918 .option smtp_accept_keepalive main boolean true
16919 .cindex "keepalive" "on incoming connection"
16920 This option controls the setting of the SO_KEEPALIVE option on incoming
16921 TCP/IP socket connections. When set, it causes the kernel to probe idle
16922 connections periodically, by sending packets with &"old"& sequence numbers. The
16923 other end of the connection should send an acknowledgment if the connection is
16924 still okay or a reset if the connection has been aborted. The reason for doing
16925 this is that it has the beneficial effect of freeing up certain types of
16926 connection that can get stuck when the remote host is disconnected without
16927 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16928 hours to detect unreachable hosts.
16929
16930
16931
16932 .option smtp_accept_max main integer 20
16933 .cindex "limit" "incoming SMTP connections"
16934 .cindex "SMTP" "incoming connection count"
16935 .cindex "inetd"
16936 This option specifies the maximum number of simultaneous incoming SMTP calls
16937 that Exim will accept. It applies only to the listening daemon; there is no
16938 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16939 value is set to zero, no limit is applied. However, it is required to be
16940 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16941 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16942
16943 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16944 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16945 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16946 and &%smtp_load_reserve%& are then checked before accepting the connection.
16947
16948
16949 .option smtp_accept_max_nonmail main integer 10
16950 .cindex "limit" "non-mail SMTP commands"
16951 .cindex "SMTP" "limiting non-mail commands"
16952 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16953 the connection if there are too many. This option defines &"too many"&. The
16954 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16955 client looping sending EHLO, for example. The check is applied only if the
16956 client host matches &%smtp_accept_max_nonmail_hosts%&.
16957
16958 When a new message is expected, one occurrence of RSET is not counted. This
16959 allows a client to send one RSET between messages (this is not necessary,
16960 but some clients do it). Exim also allows one uncounted occurrence of HELO
16961 or EHLO, and one occurrence of STARTTLS between messages. After
16962 starting up a TLS session, another EHLO is expected, and so it too is not
16963 counted. The first occurrence of AUTH in a connection, or immediately
16964 following STARTTLS is not counted. Otherwise, all commands other than
16965 MAIL, RCPT, DATA, and QUIT are counted.
16966
16967
16968 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16969 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16970 check by setting this option. The default value makes it apply to all hosts. By
16971 changing the value, you can exclude any badly-behaved hosts that you have to
16972 live with.
16973
16974
16975 . Allow this long option name to split; give it unsplit as a fifth argument
16976 . for the automatic .oindex that is generated by .option.
16977 . We insert " &~&~" which is both pretty nasty visually and results in
16978 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16979 . zero-width-space, which would be nicer visually and results in (at least)
16980 . html that Firefox will split on when it's forced to reflow (rather than
16981 . inserting a horizontal scrollbar).  However, the text is still not
16982 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16983 . the option name to split.
16984
16985 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16986          smtp_accept_max_per_connection
16987 .cindex "SMTP" "limiting incoming message count"
16988 .cindex "limit" "messages per SMTP connection"
16989 The value of this option limits the number of MAIL commands that Exim is
16990 prepared to accept over a single SMTP connection, whether or not each command
16991 results in the transfer of a message. After the limit is reached, a 421
16992 response is given to subsequent MAIL commands. This limit is a safety
16993 precaution against a client that goes mad (incidents of this type have been
16994 seen).
16995
16996
16997 .option smtp_accept_max_per_host main string&!! unset
16998 .cindex "limit" "SMTP connections from one host"
16999 .cindex "host" "limiting SMTP connections from"
17000 This option restricts the number of simultaneous IP connections from a single
17001 host (strictly, from a single IP address) to the Exim daemon. The option is
17002 expanded, to enable different limits to be applied to different hosts by
17003 reference to &$sender_host_address$&. Once the limit is reached, additional
17004 connection attempts from the same host are rejected with error code 421. This
17005 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17006 of zero imposes no limit. If this option is set greater than zero, it is
17007 required that &%smtp_accept_max%& be non-zero.
17008
17009 &*Warning*&: When setting this option you should not use any expansion
17010 constructions that take an appreciable amount of time. The expansion and test
17011 happen in the main daemon loop, in order to reject additional connections
17012 without forking additional processes (otherwise a denial-of-service attack
17013 could cause a vast number or processes to be created). While the daemon is
17014 doing this processing, it cannot accept any other incoming connections.
17015
17016
17017
17018 .option smtp_accept_queue main integer 0
17019 .cindex "SMTP" "incoming connection count"
17020 .cindex "queueing incoming messages"
17021 .cindex "message" "queueing by SMTP connection count"
17022 If the number of simultaneous incoming SMTP connections being handled via the
17023 listening daemon exceeds this value, messages received by SMTP are just placed
17024 in the queue; no delivery processes are started automatically. The count is
17025 fixed at the start of an SMTP connection. It cannot be updated in the
17026 subprocess that receives messages, and so the queueing or not queueing applies
17027 to all messages received in the same connection.
17028
17029 A value of zero implies no limit, and clearly any non-zero value is useful only
17030 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17031 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17032 various &%-od%&&'x'& command line options.
17033
17034
17035 . See the comment on smtp_accept_max_per_connection
17036
17037 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17038          smtp_accept_queue_per_connection
17039 .cindex "queueing incoming messages"
17040 .cindex "message" "queueing by message count"
17041 This option limits the number of delivery processes that Exim starts
17042 automatically when receiving messages via SMTP, whether via the daemon or by
17043 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17044 and the number of messages received in a single SMTP session exceeds this
17045 number, subsequent messages are placed in the queue, but no delivery processes
17046 are started. This helps to limit the number of Exim processes when a server
17047 restarts after downtime and there is a lot of mail waiting for it on other
17048 systems. On large systems, the default should probably be increased, and on
17049 dial-in client systems it should probably be set to zero (that is, disabled).
17050
17051
17052 .option smtp_accept_reserve main integer 0
17053 .cindex "SMTP" "incoming call count"
17054 .cindex "host" "reserved"
17055 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17056 number of SMTP connections that are reserved for connections from the hosts
17057 that are specified in &%smtp_reserve_hosts%&. The value set in
17058 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17059 restricted to this number of connections; the option specifies a minimum number
17060 of connection slots for them, not a maximum. It is a guarantee that this group
17061 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17062 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17063 individual host.
17064
17065 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17066 set to 5, once there are 45 active connections (from any hosts), new
17067 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17068 provided the other criteria for acceptance are met.
17069
17070
17071 .option smtp_active_hostname main string&!! unset
17072 .cindex "host" "name in SMTP responses"
17073 .cindex "SMTP" "host name in responses"
17074 .vindex "&$primary_hostname$&"
17075 This option is provided for multi-homed servers that want to masquerade as
17076 several different hosts. At the start of an incoming SMTP connection, its value
17077 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17078 responses. For example, it is used as domain name in the response to an
17079 incoming HELO or EHLO command.
17080
17081 .vindex "&$smtp_active_hostname$&"
17082 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17083 is saved with any messages that are received. It is therefore available for use
17084 in routers and transports when the message is later delivered.
17085
17086 If this option is unset, or if its expansion is forced to fail, or if the
17087 expansion results in an empty string, the value of &$primary_hostname$& is
17088 used. Other expansion failures cause a message to be written to the main and
17089 panic logs, and the SMTP command receives a temporary error. Typically, the
17090 value of &%smtp_active_hostname%& depends on the incoming interface address.
17091 For example:
17092 .code
17093 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17094   {cox.mydomain}{box.mydomain}}
17095 .endd
17096
17097 Although &$smtp_active_hostname$& is primarily concerned with incoming
17098 messages, it is also used as the default for HELO commands in callout
17099 verification if there is no remote transport from which to obtain a
17100 &%helo_data%& value.
17101
17102 .option smtp_banner main string&!! "see below"
17103 .cindex "SMTP" "welcome banner"
17104 .cindex "banner for SMTP"
17105 .cindex "welcome banner for SMTP"
17106 .cindex "customizing" "SMTP banner"
17107 This string, which is expanded every time it is used, is output as the initial
17108 positive response to an SMTP connection. The default setting is:
17109 .code
17110 smtp_banner = $smtp_active_hostname ESMTP Exim \
17111   $version_number $tod_full
17112 .endd
17113 Failure to expand the string causes a panic error. If you want to create a
17114 multiline response to the initial SMTP connection, use &"\n"& in the string at
17115 appropriate points, but not at the end. Note that the 220 code is not included
17116 in this string. Exim adds it automatically (several times in the case of a
17117 multiline response).
17118
17119
17120 .option smtp_check_spool_space main boolean true
17121 .cindex "checking disk space"
17122 .cindex "disk space, checking"
17123 .cindex "spool directory" "checking space"
17124 When this option is set, if an incoming SMTP session encounters the SIZE
17125 option on a MAIL command, it checks that there is enough space in the
17126 spool directory's partition to accept a message of that size, while still
17127 leaving free the amount specified by &%check_spool_space%& (even if that value
17128 is zero). If there isn't enough space, a temporary error code is returned.
17129
17130
17131 .option smtp_connect_backlog main integer 20
17132 .cindex "connection backlog"
17133 .cindex "SMTP" "connection backlog"
17134 .cindex "backlog of connections"
17135 This option specifies a maximum number of waiting SMTP connections. Exim passes
17136 this value to the TCP/IP system when it sets up its listener. Once this number
17137 of connections are waiting for the daemon's attention, subsequent connection
17138 attempts are refused at the TCP/IP level. At least, that is what the manuals
17139 say; in some circumstances such connection attempts have been observed to time
17140 out instead. For large systems it is probably a good idea to increase the
17141 value (to 50, say). It also gives some protection against denial-of-service
17142 attacks by SYN flooding.
17143
17144
17145 .option smtp_enforce_sync main boolean true
17146 .cindex "SMTP" "synchronization checking"
17147 .cindex "synchronization checking in SMTP"
17148 The SMTP protocol specification requires the client to wait for a response from
17149 the server at certain points in the dialogue. Without PIPELINING these
17150 synchronization points are after every command; with PIPELINING they are
17151 fewer, but they still exist.
17152
17153 Some spamming sites send out a complete set of SMTP commands without waiting
17154 for any response. Exim protects against this by rejecting a message if the
17155 client has sent further input when it should not have. The error response &"554
17156 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17157 for this error cannot be perfect because of transmission delays (unexpected
17158 input may be on its way but not yet received when Exim checks). However, it
17159 does detect many instances.
17160
17161 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17162 If you want to disable the check selectively (for example, only for certain
17163 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17164 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17165
17166
17167
17168 .option smtp_etrn_command main string&!! unset
17169 .cindex "ETRN" "command to be run"
17170 .vindex "&$domain$&"
17171 If this option is set, the given command is run whenever an SMTP ETRN
17172 command is received from a host that is permitted to issue such commands (see
17173 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17174 are independently expanded. The expansion variable &$domain$& is set to the
17175 argument of the ETRN command, and no syntax checking is done on it. For
17176 example:
17177 .code
17178 smtp_etrn_command = /etc/etrn_command $domain \
17179                     $sender_host_address
17180 .endd
17181 A new process is created to run the command, but Exim does not wait for it to
17182 complete. Consequently, its status cannot be checked. If the command cannot be
17183 run, a line is written to the panic log, but the ETRN caller still receives
17184 a 250 success response. Exim is normally running under its own uid when
17185 receiving SMTP, so it is not possible for it to change the uid before running
17186 the command.
17187
17188
17189 .option smtp_etrn_serialize main boolean true
17190 .cindex "ETRN" "serializing"
17191 When this option is set, it prevents the simultaneous execution of more than
17192 one identical command as a result of ETRN in an SMTP connection. See
17193 section &<<SECTETRN>>& for details.
17194
17195
17196 .option smtp_load_reserve main fixed-point unset
17197 .cindex "load average"
17198 If the system load average ever gets higher than this, incoming SMTP calls are
17199 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17200 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17201 the load is over the limit. The option has no effect on ancient operating
17202 systems on which Exim cannot determine the load average. See also
17203 &%deliver_queue_load_max%& and &%queue_only_load%&.
17204
17205
17206
17207 .option smtp_max_synprot_errors main integer 3
17208 .cindex "SMTP" "limiting syntax and protocol errors"
17209 .cindex "limit" "SMTP syntax and protocol errors"
17210 Exim rejects SMTP commands that contain syntax or protocol errors. In
17211 particular, a syntactically invalid email address, as in this command:
17212 .code
17213 RCPT TO:<abc xyz@a.b.c>
17214 .endd
17215 causes immediate rejection of the command, before any other tests are done.
17216 (The ACL cannot be run if there is no valid address to set up for it.) An
17217 example of a protocol error is receiving RCPT before MAIL. If there are
17218 too many syntax or protocol errors in one SMTP session, the connection is
17219 dropped. The limit is set by this option.
17220
17221 .cindex "PIPELINING" "expected errors"
17222 When the PIPELINING extension to SMTP is in use, some protocol errors are
17223 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17224 Exim assumes that PIPELINING will be used if it advertises it (see
17225 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17226 not count towards the limit.
17227
17228
17229
17230 .option smtp_max_unknown_commands main integer 3
17231 .cindex "SMTP" "limiting unknown commands"
17232 .cindex "limit" "unknown SMTP commands"
17233 If there are too many unrecognized commands in an incoming SMTP session, an
17234 Exim server drops the connection. This is a defence against some kinds of abuse
17235 that subvert web
17236 clients
17237 into making connections to SMTP ports; in these circumstances, a number of
17238 non-SMTP command lines are sent first.
17239
17240
17241
17242 .option smtp_ratelimit_hosts main "host list&!!" unset
17243 .cindex "SMTP" "rate limiting"
17244 .cindex "limit" "rate of message arrival"
17245 .cindex "RCPT" "rate limiting"
17246 Some sites find it helpful to be able to limit the rate at which certain hosts
17247 can send them messages, and the rate at which an individual message can specify
17248 recipients.
17249
17250 Exim has two rate-limiting facilities. This section describes the older
17251 facility, which can limit rates within a single connection. The newer
17252 &%ratelimit%& ACL condition can limit rates across all connections. See section
17253 &<<SECTratelimiting>>& for details of the newer facility.
17254
17255 When a host matches &%smtp_ratelimit_hosts%&, the values of
17256 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17257 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17258 respectively. Each option, if set, must contain a set of four comma-separated
17259 values:
17260
17261 .ilist
17262 A threshold, before which there is no rate limiting.
17263 .next
17264 An initial time delay. Unlike other times in Exim, numbers with decimal
17265 fractional parts are allowed here.
17266 .next
17267 A factor by which to increase the delay each time.
17268 .next
17269 A maximum value for the delay. This should normally be less than 5 minutes,
17270 because after that time, the client is liable to timeout the SMTP command.
17271 .endlist
17272
17273 For example, these settings have been used successfully at the site which
17274 first suggested this feature, for controlling mail from their customers:
17275 .code
17276 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17277 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17278 .endd
17279 The first setting specifies delays that are applied to MAIL commands after
17280 two have been received over a single connection. The initial delay is 0.5
17281 seconds, increasing by a factor of 1.05 each time. The second setting applies
17282 delays to RCPT commands when more than four occur in a single message.
17283
17284
17285 .option smtp_ratelimit_mail main string unset
17286 See &%smtp_ratelimit_hosts%& above.
17287
17288
17289 .option smtp_ratelimit_rcpt main string unset
17290 See &%smtp_ratelimit_hosts%& above.
17291
17292
17293 .option smtp_receive_timeout main time&!! 5m
17294 .cindex "timeout" "for SMTP input"
17295 .cindex "SMTP" "input timeout"
17296 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17297 input, including batch SMTP. If a line of input (either an SMTP command or a
17298 data line) is not received within this time, the SMTP connection is dropped and
17299 the message is abandoned.
17300 A line is written to the log containing one of the following messages:
17301 .code
17302 SMTP command timeout on connection from...
17303 SMTP data timeout on connection from...
17304 .endd
17305 The former means that Exim was expecting to read an SMTP command; the latter
17306 means that it was in the DATA phase, reading the contents of a message.
17307
17308 If the first character of the option is a &"$"& the option is
17309 expanded before use and may depend on
17310 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17311
17312
17313 .oindex "&%-os%&"
17314 The value set by this option can be overridden by the
17315 &%-os%& command-line option. A setting of zero time disables the timeout, but
17316 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17317 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17318 timeout is controlled by &%receive_timeout%& and &%-or%&.
17319
17320
17321 .option smtp_reserve_hosts main "host list&!!" unset
17322 This option defines hosts for which SMTP connections are reserved; see
17323 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17324
17325
17326 .option smtp_return_error_details main boolean false
17327 .cindex "SMTP" "details policy failures"
17328 .cindex "policy control" "rejection, returning details"
17329 In the default state, Exim uses bland messages such as
17330 &"Administrative prohibition"& when it rejects SMTP commands for policy
17331 reasons. Many sysadmins like this because it gives away little information
17332 to spammers. However, some other sysadmins who are applying strict checking
17333 policies want to give out much fuller information about failures. Setting
17334 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17335 example, instead of &"Administrative prohibition"&, it might give:
17336 .code
17337 550-Rejected after DATA: '>' missing at end of address:
17338 550 failing address in "From" header is: <user@dom.ain
17339 .endd
17340
17341
17342 .option smtputf8_advertise_hosts main "host list&!!" *
17343 .cindex "SMTPUTF8" "advertising"
17344 When Exim is built with support for internationalised mail names,
17345 the availability thereof is advertised in
17346 response to EHLO only to those client hosts that match this option. See
17347 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17348
17349
17350 .option spamd_address main string "127.0.0.1 783"
17351 This option is available when Exim is compiled with the content-scanning
17352 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17353 See section &<<SECTscanspamass>>& for more details.
17354
17355
17356
17357 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17358 This option is available when Exim is compiled with SPF support.
17359 See section &<<SECSPF>>& for more details.
17360
17361
17362
17363 .option split_spool_directory main boolean false
17364 .cindex "multiple spool directories"
17365 .cindex "spool directory" "split"
17366 .cindex "directories, multiple"
17367 If this option is set, it causes Exim to split its input directory into 62
17368 subdirectories, each with a single alphanumeric character as its name. The
17369 sixth character of the message id is used to allocate messages to
17370 subdirectories; this is the least significant base-62 digit of the time of
17371 arrival of the message.
17372
17373 Splitting up the spool in this way may provide better performance on systems
17374 where there are long mail queues, by reducing the number of files in any one
17375 directory. The msglog directory is also split up in a similar way to the input
17376 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17377 are still placed in the single directory &_msglog.OLD_&.
17378
17379 It is not necessary to take any special action for existing messages when
17380 changing &%split_spool_directory%&. Exim notices messages that are in the
17381 &"wrong"& place, and continues to process them. If the option is turned off
17382 after a period of being on, the subdirectories will eventually empty and be
17383 automatically deleted.
17384
17385 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17386 changes. Instead of creating a list of all messages in the queue, and then
17387 trying to deliver each one, in turn, it constructs a list of those in one
17388 sub-directory and tries to deliver them, before moving on to the next
17389 sub-directory. The sub-directories are processed in a random order. This
17390 spreads out the scanning of the input directories, and uses less memory. It is
17391 particularly beneficial when there are lots of messages in the queue. However,
17392 if &%queue_run_in_order%& is set, none of this new processing happens. The
17393 entire queue has to be scanned and sorted before any deliveries can start.
17394
17395
17396 .option spool_directory main string&!! "set at compile time"
17397 .cindex "spool directory" "path to"
17398 This defines the directory in which Exim keeps its spool, that is, the messages
17399 it is waiting to deliver. The default value is taken from the compile-time
17400 configuration setting, if there is one. If not, this option must be set. The
17401 string is expanded, so it can contain, for example, a reference to
17402 &$primary_hostname$&.
17403
17404 If the spool directory name is fixed on your installation, it is recommended
17405 that you set it at build time rather than from this option, particularly if the
17406 log files are being written to the spool directory (see &%log_file_path%&).
17407 Otherwise log files cannot be used for errors that are detected early on, such
17408 as failures in the configuration file.
17409
17410 By using this option to override the compiled-in path, it is possible to run
17411 tests of Exim without using the standard spool.
17412
17413 .option spool_wireformat main boolean false
17414 .cindex "spool directory" "file formats"
17415 If this option is set, Exim may for some messages use an alternative format
17416 for data-files in the spool which matches the wire format.
17417 Doing this permits more efficient message reception and transmission.
17418 Currently it is only done for messages received using the ESMTP CHUNKING
17419 option.
17420
17421 The following variables will not have useful values:
17422 .code
17423 $max_received_linelength
17424 $body_linecount
17425 $body_zerocount
17426 .endd
17427
17428 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17429 and any external programs which are passed a reference to a message data file
17430 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17431 will need to be aware of the different formats potentially available.
17432
17433 Using any of the ACL conditions noted will negate the reception benefit
17434 (as a Unix-mbox-format file is constructed for them).
17435 The transmission benefit is maintained.
17436
17437 .option sqlite_lock_timeout main time 5s
17438 .cindex "sqlite lookup type" "lock timeout"
17439 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17440 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17441
17442 .option strict_acl_vars main boolean false
17443 .cindex "&ACL;" "variables, handling unset"
17444 This option controls what happens if a syntactically valid but undefined ACL
17445 variable is referenced. If it is false (the default), an empty string
17446 is substituted; if it is true, an error is generated. See section
17447 &<<SECTaclvariables>>& for details of ACL variables.
17448
17449 .option strip_excess_angle_brackets main boolean false
17450 .cindex "angle brackets, excess"
17451 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17452 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17453 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17454 passed on to another MTA, the excess angle brackets are not passed on. If this
17455 option is not set, multiple pairs of angle brackets cause a syntax error.
17456
17457
17458 .option strip_trailing_dot main boolean false
17459 .cindex "trailing dot on domain"
17460 .cindex "dot" "trailing on domain"
17461 If this option is set, a trailing dot at the end of a domain in an address is
17462 ignored. If this is in the envelope and the message is passed on to another
17463 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17464 domain causes a syntax error.
17465 However, addresses in header lines are checked only when an ACL requests header
17466 syntax checking.
17467
17468
17469 .option syslog_duplication main boolean true
17470 .cindex "syslog" "duplicate log lines; suppressing"
17471 When Exim is logging to syslog, it writes the log lines for its three
17472 separate logs at different syslog priorities so that they can in principle
17473 be separated on the logging hosts. Some installations do not require this
17474 separation, and in those cases, the duplication of certain log lines is a
17475 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17476 particular log line is written to syslog. For lines that normally go to
17477 both the main log and the reject log, the reject log version (possibly
17478 containing message header lines) is written, at LOG_NOTICE priority.
17479 Lines that normally go to both the main and the panic log are written at
17480 the LOG_ALERT priority.
17481
17482
17483 .option syslog_facility main string unset
17484 .cindex "syslog" "facility; setting"
17485 This option sets the syslog &"facility"& name, used when Exim is logging to
17486 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17487 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17488 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17489 details of Exim's logging.
17490
17491
17492 .option syslog_pid main boolean true
17493 .cindex "syslog" "pid"
17494 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17495 omitted when these lines are sent to syslog. (Syslog normally prefixes
17496 the log lines with the PID of the logging process automatically.) You need
17497 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17498 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17499
17500
17501
17502 .option syslog_processname main string &`exim`&
17503 .cindex "syslog" "process name; setting"
17504 This option sets the syslog &"ident"& name, used when Exim is logging to
17505 syslog. The value must be no longer than 32 characters. See chapter
17506 &<<CHAPlog>>& for details of Exim's logging.
17507
17508
17509
17510 .option syslog_timestamp main boolean true
17511 .cindex "syslog" "timestamps"
17512 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17513 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17514 details of Exim's logging.
17515
17516
17517 .option system_filter main string&!! unset
17518 .cindex "filter" "system filter"
17519 .cindex "system filter" "specifying"
17520 .cindex "Sieve filter" "not available for system filter"
17521 This option specifies an Exim filter file that is applied to all messages at
17522 the start of each delivery attempt, before any routing is done. System filters
17523 must be Exim filters; they cannot be Sieve filters. If the system filter
17524 generates any deliveries to files or pipes, or any new mail messages, the
17525 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17526 which transports are to be used. Details of this facility are given in chapter
17527 &<<CHAPsystemfilter>>&.
17528 A forced expansion failure results in no filter operation.
17529
17530
17531 .option system_filter_directory_transport main string&!! unset
17532 .vindex "&$address_file$&"
17533 This sets the name of the transport driver that is to be used when the
17534 &%save%& command in a system message filter specifies a path ending in &"/"&,
17535 implying delivery of each message into a separate file in some directory.
17536 During the delivery, the variable &$address_file$& contains the path name.
17537
17538
17539 .option system_filter_file_transport main string&!! unset
17540 .cindex "file" "transport for system filter"
17541 This sets the name of the transport driver that is to be used when the &%save%&
17542 command in a system message filter specifies a path not ending in &"/"&. During
17543 the delivery, the variable &$address_file$& contains the path name.
17544
17545 .option system_filter_group main string unset
17546 .cindex "gid (group id)" "system filter"
17547 This option is used only when &%system_filter_user%& is also set. It sets the
17548 gid under which the system filter is run, overriding any gid that is associated
17549 with the user. The value may be numerical or symbolic.
17550
17551 .option system_filter_pipe_transport main string&!! unset
17552 .cindex "&(pipe)& transport" "for system filter"
17553 .vindex "&$address_pipe$&"
17554 This specifies the transport driver that is to be used when a &%pipe%& command
17555 is used in a system filter. During the delivery, the variable &$address_pipe$&
17556 contains the pipe command.
17557
17558
17559 .option system_filter_reply_transport main string&!! unset
17560 .cindex "&(autoreply)& transport" "for system filter"
17561 This specifies the transport driver that is to be used when a &%mail%& command
17562 is used in a system filter.
17563
17564
17565 .option system_filter_user main string unset
17566 .cindex "uid (user id)" "system filter"
17567 If this option is set to root, the system filter is run in the main Exim
17568 delivery process, as root.  Otherwise, the system filter runs in a separate
17569 process, as the given user, defaulting to the Exim run-time user.
17570 Unless the string consists entirely of digits, it
17571 is looked up in the password data. Failure to find the named user causes a
17572 configuration error. The gid is either taken from the password data, or
17573 specified by &%system_filter_group%&. When the uid is specified numerically,
17574 &%system_filter_group%& is required to be set.
17575
17576 If the system filter generates any pipe, file, or reply deliveries, the uid
17577 under which the filter is run is used when transporting them, unless a
17578 transport option overrides.
17579
17580
17581 .option tcp_nodelay main boolean true
17582 .cindex "daemon" "TCP_NODELAY on sockets"
17583 .cindex "Nagle algorithm"
17584 .cindex "TCP_NODELAY on listening sockets"
17585 If this option is set false, it stops the Exim daemon setting the
17586 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17587 turns off the &"Nagle algorithm"&, which is a way of improving network
17588 performance in interactive (character-by-character) situations. Turning it off
17589 should improve Exim's performance a bit, so that is what happens by default.
17590 However, it appears that some broken clients cannot cope, and time out. Hence
17591 this option. It affects only those sockets that are set up for listening by the
17592 daemon. Sockets created by the smtp transport for delivering mail always set
17593 TCP_NODELAY.
17594
17595
17596 .option timeout_frozen_after main time 0s
17597 .cindex "frozen messages" "timing out"
17598 .cindex "timeout" "frozen messages"
17599 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17600 message of any kind that has been in the queue for longer than the given time
17601 is automatically cancelled at the next queue run. If the frozen message is a
17602 bounce message, it is just discarded; otherwise, a bounce is sent to the
17603 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17604 If you want to timeout frozen bounce messages earlier than other kinds of
17605 frozen message, see &%ignore_bounce_errors_after%&.
17606
17607 &*Note:*& the default value of zero means no timeouts; with this setting,
17608 frozen messages remain in the queue forever (except for any frozen bounce
17609 messages that are released by &%ignore_bounce_errors_after%&).
17610
17611
17612 .option timezone main string unset
17613 .cindex "timezone, setting"
17614 .cindex "environment" "values from"
17615 The value of &%timezone%& is used to set the environment variable TZ while
17616 running Exim (if it is different on entry). This ensures that all timestamps
17617 created by Exim are in the required timezone. If you want all your timestamps
17618 to be in UTC (aka GMT) you should set
17619 .code
17620 timezone = UTC
17621 .endd
17622 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17623 or, if that is not set, from the value of the TZ environment variable when Exim
17624 is built. If &%timezone%& is set to the empty string, either at build or run
17625 time, any existing TZ variable is removed from the environment when Exim
17626 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17627 unfortunately not all, operating systems.
17628
17629
17630 .option tls_advertise_hosts main "host list&!!" *
17631 .cindex "TLS" "advertising"
17632 .cindex "encryption" "on SMTP connection"
17633 .cindex "SMTP" "encrypted connection"
17634 When Exim is built with support for TLS encrypted connections, the availability
17635 of the STARTTLS command to set up an encrypted session is advertised in
17636 response to EHLO only to those client hosts that match this option. See
17637 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17638 Note that the default value requires that a certificate be supplied
17639 using the &%tls_certificate%& option.  If TLS support for incoming connections
17640 is not required the &%tls_advertise_hosts%& option should be set empty.
17641
17642
17643 .option tls_certificate main string list&!! unset
17644 .cindex "TLS" "server certificate; location of"
17645 .cindex "certificate" "server, location of"
17646 The value of this option is expanded, and must then be a list of absolute paths to
17647 files which contain the server's certificates (in PEM format).
17648 Commonly only one file is needed.
17649 The server's private key is also
17650 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17651 &<<CHAPTLS>>& for further details.
17652
17653 &*Note*&: The certificates defined by this option are used only when Exim is
17654 receiving incoming messages as a server. If you want to supply certificates for
17655 use when sending messages as a client, you must set the &%tls_certificate%&
17656 option in the relevant &(smtp)& transport.
17657
17658 &*Note*&: If you use filenames based on IP addresses, change the list
17659 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17660
17661 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17662 when a list of more than one
17663 file is used, the &$tls_in_ourcert$& variable is unreliable.
17664
17665 &*Note*&: OCSP stapling is not usable under OpenSSL
17666 when a list of more than one file is used.
17667
17668 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17669 if the OpenSSL build supports TLS extensions and the TLS client sends the
17670 Server Name Indication extension, then this option and others documented in
17671 &<<SECTtlssni>>& will be re-expanded.
17672
17673 If this option is unset or empty a fresh self-signed certificate will be
17674 generated for every connection.
17675
17676 .option tls_crl main string&!! unset
17677 .cindex "TLS" "server certificate revocation list"
17678 .cindex "certificate" "revocation list for server"
17679 This option specifies a certificate revocation list. The expanded value must
17680 be the name of a file that contains CRLs in PEM format.
17681
17682 Under OpenSSL the option can specify a directory with CRL files.
17683
17684 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17685 for each signing element of the certificate chain (i.e. all but the leaf).
17686 For the file variant this can be multiple PEM blocks in the one file.
17687
17688 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17689
17690
17691 .option tls_dh_max_bits main integer 2236
17692 .cindex "TLS" "D-H bit count"
17693 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17694 the chosen TLS library.  That value might prove to be too high for
17695 interoperability.  This option provides a maximum clamp on the value
17696 suggested, trading off security for interoperability.
17697
17698 The value must be at least 1024.
17699
17700 The value 2236 was chosen because, at time of adding the option, it was the
17701 hard-coded maximum value supported by the NSS cryptographic library, as used
17702 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17703
17704 If you prefer more security and are willing to break some clients, raise this
17705 number.
17706
17707 Note that the value passed to GnuTLS for *generating* a new prime may be a
17708 little less than this figure, because GnuTLS is inexact and may produce a
17709 larger prime than requested.
17710
17711
17712 .option tls_dhparam main string&!! unset
17713 .cindex "TLS" "D-H parameters for server"
17714 The value of this option is expanded and indicates the source of DH parameters
17715 to be used by Exim.
17716
17717 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17718 local DH parameters*&, which has been supported across all versions of Exim.  The
17719 other specific constants available are a fallback so that even when
17720 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17721
17722 If &%tls_dhparam%& is a filename starting with a &`/`&,
17723 then it names a file from which DH
17724 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17725 PKCS#3 representation of the DH prime.  If the file does not exist, for
17726 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17727 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17728 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17729 and treated as though the &%tls_dhparam%& were set to "none".
17730
17731 If this option expands to the string "none", then no DH parameters will be
17732 loaded by Exim.
17733
17734 If this option expands to the string "historic" and Exim is using GnuTLS, then
17735 Exim will attempt to load a file from inside the spool directory.  If the file
17736 does not exist, Exim will attempt to create it.
17737 See section &<<SECTgnutlsparam>>& for further details.
17738
17739 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17740 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17741
17742 In older versions of Exim the default was the 2048 bit prime described in section
17743 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17744 in IKE is assigned number 23.
17745
17746 Otherwise, the option must expand to the name used by Exim for any of a number
17747 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17748 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17749 the number used by IKE, or "default" which corresponds to
17750 &`exim.dev.20160529.3`&.
17751
17752 The available standard primes are:
17753 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17754 &`ike1`&, &`ike2`&, &`ike5`&,
17755 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17756 &`ike22`&, &`ike23`& and &`ike24`&.
17757
17758 The available additional primes are:
17759 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17760
17761 Some of these will be too small to be accepted by clients.
17762 Some may be too large to be accepted by clients.
17763 The open cryptographic community has suspicions about the integrity of some
17764 of the later IKE values, which led into RFC7919 providing new fixed constants
17765 (the "ffdhe" identifiers).
17766
17767 At this point, all of the "ike" values should be considered obsolete;
17768 they're still in Exim to avoid breaking unusual configurations, but are
17769 candidates for removal the next time we have backwards-incompatible changes.
17770
17771 The TLS protocol does not negotiate an acceptable size for this; clients tend
17772 to hard-drop connections if what is offered by the server is unacceptable,
17773 whether too large or too small, and there's no provision for the client to
17774 tell the server what these constraints are.  Thus, as a server operator, you
17775 need to make an educated guess as to what is most likely to work for your
17776 userbase.
17777
17778 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17779 is most likely to maximise interoperability.  The upper bound comes from
17780 applications using the Mozilla Network Security Services (NSS) library, which
17781 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17782 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17783 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17784 acceptable bound from 1024 to 2048.
17785
17786
17787 .option tls_eccurve main string&!! &`auto`&
17788 .cindex TLS "EC cryptography"
17789 This option selects a EC curve for use by Exim when used with OpenSSL.
17790 It has no effect when Exim is used with GnuTLS.
17791
17792 After expansion it must contain a valid EC curve parameter, such as
17793 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17794 for valid selections.
17795
17796 For OpenSSL versions before (and not including) 1.0.2, the string
17797 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17798 &`auto`& tells the library to choose.
17799
17800 If the option expands to an empty string, no EC curves will be enabled.
17801
17802
17803 .option tls_ocsp_file main string&!! unset
17804 .cindex TLS "certificate status"
17805 .cindex TLS "OCSP proof file"
17806 This option
17807 must if set expand to the absolute path to a file which contains a current
17808 status proof for the server's certificate, as obtained from the
17809 Certificate Authority.
17810
17811 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17812
17813 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17814 of files, to match a list given for the &%tls_certificate%& option.
17815 The ordering of the two lists must match.
17816
17817
17818 .option tls_on_connect_ports main "string list" unset
17819 .cindex SSMTP
17820 .cindex SMTPS
17821 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17822 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17823 set up without waiting for the client to issue a STARTTLS command. For
17824 further details, see section &<<SECTsupobssmt>>&.
17825
17826
17827
17828 .option tls_privatekey main string list&!! unset
17829 .cindex "TLS" "server private key; location of"
17830 The value of this option is expanded, and must then be a list of absolute paths to
17831 files which contains the server's private keys.
17832 If this option is unset, or if
17833 the expansion is forced to fail, or the result is an empty string, the private
17834 key is assumed to be in the same file as the server's certificates. See chapter
17835 &<<CHAPTLS>>& for further details.
17836
17837 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17838
17839
17840 .option tls_remember_esmtp main boolean false
17841 .cindex "TLS" "esmtp state; remembering"
17842 .cindex "TLS" "broken clients"
17843 If this option is set true, Exim violates the RFCs by remembering that it is in
17844 &"esmtp"& state after successfully negotiating a TLS session. This provides
17845 support for broken clients that fail to send a new EHLO after starting a
17846 TLS session.
17847
17848
17849 .option tls_require_ciphers main string&!! unset
17850 .cindex "TLS" "requiring specific ciphers"
17851 .cindex "cipher" "requiring specific"
17852 This option controls which ciphers can be used for incoming TLS connections.
17853 The &(smtp)& transport has an option of the same name for controlling outgoing
17854 connections. This option is expanded for each connection, so can be varied for
17855 different clients if required. The value of this option must be a list of
17856 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17857 in somewhat different ways. If GnuTLS is being used, the client controls the
17858 preference order of the available ciphers. Details are given in sections
17859 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17860
17861
17862 .option tls_try_verify_hosts main "host list&!!" unset
17863 .cindex "TLS" "client certificate verification"
17864 .cindex "certificate" "verification of client"
17865 See &%tls_verify_hosts%& below.
17866
17867
17868 .option tls_verify_certificates main string&!! system
17869 .cindex "TLS" "client certificate verification"
17870 .cindex "certificate" "verification of client"
17871 The value of this option is expanded, and must then be either the
17872 word "system"
17873 or the absolute path to
17874 a file or directory containing permitted certificates for clients that
17875 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17876
17877 The "system" value for the option will use a
17878 system default location compiled into the SSL library.
17879 This is not available for GnuTLS versions preceding 3.0.20,
17880 and will be taken as empty; an explicit location
17881 must be specified.
17882
17883 The use of a directory for the option value is not available for GnuTLS versions
17884 preceding 3.3.6 and a single file must be used.
17885
17886 With OpenSSL the certificates specified
17887 explicitly
17888 either by file or directory
17889 are added to those given by the system default location.
17890
17891 These certificates should be for the certificate authorities trusted, rather
17892 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17893 the value is a file then the certificates are sent by Exim as a server to
17894 connecting clients, defining the list of accepted certificate authorities.
17895 Thus the values defined should be considered public data.  To avoid this,
17896 use the explicit directory version.
17897
17898 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17899
17900 A forced expansion failure or setting to an empty string is equivalent to
17901 being unset.
17902
17903
17904 .option tls_verify_hosts main "host list&!!" unset
17905 .cindex "TLS" "client certificate verification"
17906 .cindex "certificate" "verification of client"
17907 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17908 certificates from clients. The expected certificates are defined by
17909 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17910 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17911 &%tls_verify_certificates%& is not set.
17912
17913 Any client that matches &%tls_verify_hosts%& is constrained by
17914 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17915 present one of the listed certificates. If it does not, the connection is
17916 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17917 the host to use TLS. It can still send SMTP commands through unencrypted
17918 connections. Forcing a client to use TLS has to be done separately using an
17919 ACL to reject inappropriate commands when the connection is not encrypted.
17920
17921 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17922 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17923 certificate and checks it against &%tls_verify_certificates%&, but does not
17924 abort the connection if there is no certificate or if it does not match. This
17925 state can be detected in an ACL, which makes it possible to implement policies
17926 such as &"accept for relay only if a verified certificate has been received,
17927 but accept for local delivery if encrypted, even without a verified
17928 certificate"&.
17929
17930 Client hosts that match neither of these lists are not asked to present
17931 certificates.
17932
17933
17934 .option trusted_groups main "string list&!!" unset
17935 .cindex "trusted groups"
17936 .cindex "groups" "trusted"
17937 This option is expanded just once, at the start of Exim's processing. If this
17938 option is set, any process that is running in one of the listed groups, or
17939 which has one of them as a supplementary group, is trusted. The groups can be
17940 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17941 details of what trusted callers are permitted to do. If neither
17942 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17943 are trusted.
17944
17945 .option trusted_users main "string list&!!" unset
17946 .cindex "trusted users"
17947 .cindex "user" "trusted"
17948 This option is expanded just once, at the start of Exim's processing. If this
17949 option is set, any process that is running as one of the listed users is
17950 trusted. The users can be specified numerically or by name. See section
17951 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17952 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17953 Exim user are trusted.
17954
17955 .option unknown_login main string&!! unset
17956 .cindex "uid (user id)" "unknown caller"
17957 .vindex "&$caller_uid$&"
17958 This is a specialized feature for use in unusual configurations. By default, if
17959 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17960 gives up. The &%unknown_login%& option can be used to set a login name to be
17961 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17962 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17963 is used for the user's real name (gecos field), unless this has been set by the
17964 &%-F%& option.
17965
17966 .option unknown_username main string unset
17967 See &%unknown_login%&.
17968
17969 .option untrusted_set_sender main "address list&!!" unset
17970 .cindex "trusted users"
17971 .cindex "sender" "setting by untrusted user"
17972 .cindex "untrusted user setting sender"
17973 .cindex "user" "untrusted setting sender"
17974 .cindex "envelope from"
17975 .cindex "envelope sender"
17976 When an untrusted user submits a message to Exim using the standard input, Exim
17977 normally creates an envelope sender address from the user's login and the
17978 default qualification domain. Data from the &%-f%& option (for setting envelope
17979 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17980 is used) is ignored.
17981
17982 However, untrusted users are permitted to set an empty envelope sender address,
17983 to declare that a message should never generate any bounces. For example:
17984 .code
17985 exim -f '<>' user@domain.example
17986 .endd
17987 .vindex "&$sender_ident$&"
17988 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17989 other envelope sender addresses in a controlled way. When it is set, untrusted
17990 users are allowed to set envelope sender addresses that match any of the
17991 patterns in the list. Like all address lists, the string is expanded. The
17992 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17993 users to setting senders that start with their login ids
17994 followed by a hyphen
17995 by a setting like this:
17996 .code
17997 untrusted_set_sender = ^$sender_ident-
17998 .endd
17999 If you want to allow untrusted users to set envelope sender addresses without
18000 restriction, you can use
18001 .code
18002 untrusted_set_sender = *
18003 .endd
18004 The &%untrusted_set_sender%& option applies to all forms of local input, but
18005 only to the setting of the envelope sender. It does not permit untrusted users
18006 to use the other options which trusted user can use to override message
18007 parameters. Furthermore, it does not stop Exim from removing an existing
18008 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18009 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18010 overriding these actions. The handling of the &'Sender:'& header is also
18011 described in section &<<SECTthesenhea>>&.
18012
18013 The log line for a message's arrival shows the envelope sender following
18014 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18015 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18016 envelope sender address, the user's login is shown in parentheses after the
18017 sender address.
18018
18019
18020 .option uucp_from_pattern main string "see below"
18021 .cindex "&""From""& line"
18022 .cindex "UUCP" "&""From""& line"
18023 Some applications that pass messages to an MTA via a command line interface use
18024 an initial line starting with &"From&~"& to pass the envelope sender. In
18025 particular, this is used by UUCP software. Exim recognizes such a line by means
18026 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18027 matches, the sender address is constructed by expanding the contents of
18028 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18029 default pattern recognizes lines in the following two forms:
18030 .code
18031 From ph10 Fri Jan  5 12:35 GMT 1996
18032 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18033 .endd
18034 The pattern can be seen by running
18035 .code
18036 exim -bP uucp_from_pattern
18037 .endd
18038 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18039 year in the second case. The first word after &"From&~"& is matched in the
18040 regular expression by a parenthesized subpattern. The default value for
18041 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18042 (&"ph10"& in the example above) as the message's sender. See also
18043 &%ignore_fromline_hosts%&.
18044
18045
18046 .option uucp_from_sender main string&!! &`$1`&
18047 See &%uucp_from_pattern%& above.
18048
18049
18050 .option warn_message_file main string unset
18051 .cindex "warning of delay" "customizing the message"
18052 .cindex "customizing" "warning message"
18053 This option defines a template file containing paragraphs of text to be used
18054 for constructing the warning message which is sent by Exim when a message has
18055 been in the queue for a specified amount of time, as specified by
18056 &%delay_warning%&. Details of the file's contents are given in chapter
18057 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18058
18059
18060 .option write_rejectlog main boolean true
18061 .cindex "reject log" "disabling"
18062 If this option is set false, Exim no longer writes anything to the reject log.
18063 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18064 .ecindex IIDconfima
18065 .ecindex IIDmaiconf
18066
18067
18068
18069
18070 . ////////////////////////////////////////////////////////////////////////////
18071 . ////////////////////////////////////////////////////////////////////////////
18072
18073 .chapter "Generic options for routers" "CHAProutergeneric"
18074 .scindex IIDgenoprou1 "options" "generic; for routers"
18075 .scindex IIDgenoprou2 "generic options" "router"
18076 This chapter describes the generic options that apply to all routers.
18077 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18078
18079 For a general description of how a router operates, see sections
18080 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18081 which the preconditions are tested. The order of expansion of the options that
18082 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18083 &%headers_remove%&, &%transport%&.
18084
18085
18086
18087 .option address_data routers string&!! unset
18088 .cindex "router" "data attached to address"
18089 The string is expanded just before the router is run, that is, after all the
18090 precondition tests have succeeded. If the expansion is forced to fail, the
18091 router declines, the value of &%address_data%& remains unchanged, and the
18092 &%more%& option controls what happens next. Other expansion failures cause
18093 delivery of the address to be deferred.
18094
18095 .vindex "&$address_data$&"
18096 When the expansion succeeds, the value is retained with the address, and can be
18097 accessed using the variable &$address_data$& in the current router, subsequent
18098 routers, and the eventual transport.
18099
18100 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18101 that runs a user's filter file, the contents of &$address_data$& are accessible
18102 in the filter. This is not normally a problem, because such data is usually
18103 either not confidential or it &"belongs"& to the current user, but if you do
18104 put confidential data into &$address_data$& you need to remember this point.
18105
18106 Even if the router declines or passes, the value of &$address_data$& remains
18107 with the address, though it can be changed by another &%address_data%& setting
18108 on a subsequent router. If a router generates child addresses, the value of
18109 &$address_data$& propagates to them. This also applies to the special kind of
18110 &"child"& that is generated by a router with the &%unseen%& option.
18111
18112 The idea of &%address_data%& is that you can use it to look up a lot of data
18113 for the address once, and then pick out parts of the data later. For example,
18114 you could use a single LDAP lookup to return a string of the form
18115 .code
18116 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18117 .endd
18118 In the transport you could pick out the mailbox by a setting such as
18119 .code
18120 file = ${extract{mailbox}{$address_data}}
18121 .endd
18122 This makes the configuration file less messy, and also reduces the number of
18123 lookups (though Exim does cache lookups).
18124
18125 .new
18126 See also the &%set%& option below.
18127 .wen
18128
18129 .vindex "&$sender_address_data$&"
18130 .vindex "&$address_data$&"
18131 The &%address_data%& facility is also useful as a means of passing information
18132 from one router to another, and from a router to a transport. In addition, if
18133 &$address_data$& is set by a router when verifying a recipient address from an
18134 ACL, it remains available for use in the rest of the ACL statement. After
18135 verifying a sender, the value is transferred to &$sender_address_data$&.
18136
18137
18138
18139 .option address_test routers&!? boolean true
18140 .oindex "&%-bt%&"
18141 .cindex "router" "skipping when address testing"
18142 If this option is set false, the router is skipped when routing is being tested
18143 by means of the &%-bt%& command line option. This can be a convenience when
18144 your first router sends messages to an external scanner, because it saves you
18145 having to set the &"already scanned"& indicator when testing real address
18146 routing.
18147
18148
18149
18150 .option cannot_route_message routers string&!! unset
18151 .cindex "router" "customizing &""cannot route""& message"
18152 .cindex "customizing" "&""cannot route""& message"
18153 This option specifies a text message that is used when an address cannot be
18154 routed because Exim has run out of routers. The default message is
18155 &"Unrouteable address"&. This option is useful only on routers that have
18156 &%more%& set false, or on the very last router in a configuration, because the
18157 value that is used is taken from the last router that is considered. This
18158 includes a router that is skipped because its preconditions are not met, as
18159 well as a router that declines. For example, using the default configuration,
18160 you could put:
18161 .code
18162 cannot_route_message = Remote domain not found in DNS
18163 .endd
18164 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18165 and
18166 .code
18167 cannot_route_message = Unknown local user
18168 .endd
18169 on the final router that checks for local users. If string expansion fails for
18170 this option, the default message is used. Unless the expansion failure was
18171 explicitly forced, a message about the failure is written to the main and panic
18172 logs, in addition to the normal message about the routing failure.
18173
18174
18175 .option caseful_local_part routers boolean false
18176 .cindex "case of local parts"
18177 .cindex "router" "case of local parts"
18178 By default, routers handle the local parts of addresses in a case-insensitive
18179 manner, though the actual case is preserved for transmission with the message.
18180 If you want the case of letters to be significant in a router, you must set
18181 this option true. For individual router options that contain address or local
18182 part lists (for example, &%local_parts%&), case-sensitive matching can be
18183 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18184 more details.
18185
18186 .vindex "&$local_part$&"
18187 .vindex "&$original_local_part$&"
18188 .vindex "&$parent_local_part$&"
18189 The value of the &$local_part$& variable is forced to lower case while a
18190 router is running unless &%caseful_local_part%& is set. When a router assigns
18191 an address to a transport, the value of &$local_part$& when the transport runs
18192 is the same as it was in the router. Similarly, when a router generates child
18193 addresses by aliasing or forwarding, the values of &$original_local_part$&
18194 and &$parent_local_part$& are those that were used by the redirecting router.
18195
18196 This option applies to the processing of an address by a router. When a
18197 recipient address is being processed in an ACL, there is a separate &%control%&
18198 modifier that can be used to specify case-sensitive processing within the ACL
18199 (see section &<<SECTcontrols>>&).
18200
18201
18202
18203 .option check_local_user routers&!? boolean false
18204 .cindex "local user, checking in router"
18205 .cindex "router" "checking for local user"
18206 .cindex "&_/etc/passwd_&"
18207 .vindex "&$home$&"
18208 When this option is true, Exim checks that the local part of the recipient
18209 address (with affixes removed if relevant) is the name of an account on the
18210 local system. The check is done by calling the &[getpwnam()]& function rather
18211 than trying to read &_/etc/passwd_& directly. This means that other methods of
18212 holding password data (such as NIS) are supported. If the local part is a local
18213 user, &$home$& is set from the password data, and can be tested in other
18214 preconditions that are evaluated after this one (the order of evaluation is
18215 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18216 overridden by &%router_home_directory%&. If the local part is not a local user,
18217 the router is skipped.
18218
18219 If you want to check that the local part is either the name of a local user
18220 or matches something else, you cannot combine &%check_local_user%& with a
18221 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18222 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18223 setting to achieve this. For example:
18224 .code
18225 local_parts = passwd;$local_part : lsearch;/etc/other/users
18226 .endd
18227 Note, however, that the side effects of &%check_local_user%& (such as setting
18228 up a home directory) do not occur when a &(passwd)& lookup is used in a
18229 &%local_parts%& (or any other) precondition.
18230
18231
18232
18233 .option condition routers&!? string&!! unset
18234 .cindex "router" "customized precondition"
18235 This option specifies a general precondition test that has to succeed for the
18236 router to be called. The &%condition%& option is the last precondition to be
18237 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18238 result is a forced failure, or an empty string, or one of the strings &"0"& or
18239 &"no"& or &"false"& (checked without regard to the case of the letters), the
18240 router is skipped, and the address is offered to the next one.
18241
18242 If the result is any other value, the router is run (as this is the last
18243 precondition to be evaluated, all the other preconditions must be true).
18244
18245 This option is unusual in that multiple &%condition%& options may be present.
18246 All &%condition%& options must succeed.
18247
18248 The &%condition%& option provides a means of applying custom conditions to the
18249 running of routers. Note that in the case of a simple conditional expansion,
18250 the default expansion values are exactly what is wanted. For example:
18251 .code
18252 condition = ${if >{$message_age}{600}}
18253 .endd
18254 Because of the default behaviour of the string expansion, this is equivalent to
18255 .code
18256 condition = ${if >{$message_age}{600}{true}{}}
18257 .endd
18258
18259 A multiple condition example, which succeeds:
18260 .code
18261 condition = ${if >{$message_age}{600}}
18262 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18263 condition = foobar
18264 .endd
18265
18266 If the expansion fails (other than forced failure) delivery is deferred. Some
18267 of the other precondition options are common special cases that could in fact
18268 be specified using &%condition%&.
18269
18270 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18271 are far older, and use one set of semantics.  ACLs are newer and when
18272 they were created, the ACL &%condition%& process was given far stricter
18273 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18274 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18275 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18276 Router rules processing behavior.
18277
18278 This is best illustrated in an example:
18279 .code
18280 # If used in an ACL condition will fail with a syntax error, but
18281 # in a router condition any extra characters are treated as a string
18282
18283 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18284 true {yes} {no}}
18285
18286 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18287  {yes} {no}}
18288 .endd
18289 In each example above, the &%if%& statement actually ends after
18290 &"{google.com}}"&.  Since no true or false braces were defined, the
18291 default &%if%& behavior is to return a boolean true or a null answer
18292 (which evaluates to false). The rest of the line is then treated as a
18293 string. So the first example resulted in the boolean answer &"true"&
18294 with the string &" {yes} {no}}"& appended to it. The second example
18295 resulted in the null output (indicating false) with the string
18296 &" {yes} {no}}"& appended to it.
18297
18298 In fact you can put excess forward braces in too.  In the router
18299 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18300 mean something, like after a &"$"& or when required as part of a
18301 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18302 string characters.
18303
18304 Thus, in a Router, the above expansion strings will both always evaluate
18305 true, as the result of expansion is a non-empty string which doesn't
18306 match an explicit false value.  This can be tricky to debug.  By
18307 contrast, in an ACL either of those strings will always result in an
18308 expansion error because the result doesn't look sufficiently boolean.
18309
18310
18311 .option debug_print routers string&!! unset
18312 .cindex "testing" "variables in drivers"
18313 If this option is set and debugging is enabled (see the &%-d%& command line
18314 option) or in address-testing mode (see the &%-bt%& command line option),
18315 the string is expanded and included in the debugging output.
18316 If expansion of the string fails, the error message is written to the debugging
18317 output, and Exim carries on processing.
18318 This option is provided to help with checking out the values of variables and
18319 so on when debugging router configurations. For example, if a &%condition%&
18320 option appears not to be working, &%debug_print%& can be used to output the
18321 variables it references. The output happens after checks for &%domains%&,
18322 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18323 are tested. A newline is added to the text if it does not end with one.
18324 The variable &$router_name$& contains the name of the router.
18325
18326
18327
18328 .option disable_logging routers boolean false
18329 If this option is set true, nothing is logged for any routing errors
18330 or for any deliveries caused by this router. You should not set this option
18331 unless you really, really know what you are doing. See also the generic
18332 transport option of the same name.
18333
18334 .option dnssec_request_domains routers "domain list&!!" unset
18335 .cindex "MX record" "security"
18336 .cindex "DNSSEC" "MX lookup"
18337 .cindex "security" "MX lookup"
18338 .cindex "DNS" "DNSSEC"
18339 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18340 the dnssec request bit set.
18341 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18342
18343 .option dnssec_require_domains routers "domain list&!!" unset
18344 .cindex "MX record" "security"
18345 .cindex "DNSSEC" "MX lookup"
18346 .cindex "security" "MX lookup"
18347 .cindex "DNS" "DNSSEC"
18348 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18349 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18350 (AD bit) set will be ignored and logged as a host-lookup failure.
18351 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18352
18353
18354 .option domains routers&!? "domain list&!!" unset
18355 .cindex "router" "restricting to specific domains"
18356 .vindex "&$domain_data$&"
18357 If this option is set, the router is skipped unless the current domain matches
18358 the list. If the match is achieved by means of a file lookup, the data that the
18359 lookup returned for the domain is placed in &$domain_data$& for use in string
18360 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18361 a list of the order in which preconditions are evaluated.
18362
18363
18364
18365 .option driver routers string unset
18366 This option must always be set. It specifies which of the available routers is
18367 to be used.
18368
18369
18370 .option dsn_lasthop routers boolean false
18371 .cindex "DSN" "success"
18372 .cindex "Delivery Status Notification" "success"
18373 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18374 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18375 instead send a success DSN as if the next hop does not support DSN.
18376 Not effective on redirect routers.
18377
18378
18379
18380 .option errors_to routers string&!! unset
18381 .cindex "envelope from"
18382 .cindex "envelope sender"
18383 .cindex "router" "changing address for errors"
18384 If a router successfully handles an address, it may assign the address to a
18385 transport for delivery or it may generate child addresses. In both cases, if
18386 there is a delivery problem during later processing, the resulting bounce
18387 message is sent to the address that results from expanding this string,
18388 provided that the address verifies successfully. The &%errors_to%& option is
18389 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18390
18391 The &%errors_to%& setting associated with an address can be overridden if it
18392 subsequently passes through other routers that have their own &%errors_to%&
18393 settings, or if the message is delivered by a transport with a &%return_path%&
18394 setting.
18395
18396 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18397 the expansion fails to verify, the errors address associated with the incoming
18398 address is used. At top level, this is the envelope sender. A non-forced
18399 expansion failure causes delivery to be deferred.
18400
18401 If an address for which &%errors_to%& has been set ends up being delivered over
18402 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18403 any bounces that are generated by other MTAs on the delivery route are also
18404 sent there. You can set &%errors_to%& to the empty string by either of these
18405 settings:
18406 .code
18407 errors_to =
18408 errors_to = ""
18409 .endd
18410 An expansion item that yields an empty string has the same effect. If you do
18411 this, a locally detected delivery error for addresses processed by this router
18412 no longer gives rise to a bounce message; the error is discarded. If the
18413 address is delivered to a remote host, the return path is set to &`<>`&, unless
18414 overridden by the &%return_path%& option on the transport.
18415
18416 .vindex "&$address_data$&"
18417 If for some reason you want to discard local errors, but use a non-empty
18418 MAIL command for remote delivery, you can preserve the original return
18419 path in &$address_data$& in the router, and reinstate it in the transport by
18420 setting &%return_path%&.
18421
18422 The most common use of &%errors_to%& is to direct mailing list bounces to the
18423 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18424 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18425
18426
18427
18428 .option expn routers&!? boolean true
18429 .cindex "address" "testing"
18430 .cindex "testing" "addresses"
18431 .cindex "EXPN" "router skipping"
18432 .cindex "router" "skipping for EXPN"
18433 If this option is turned off, the router is skipped when testing an address
18434 as a result of processing an SMTP EXPN command. You might, for example,
18435 want to turn it off on a router for users' &_.forward_& files, while leaving it
18436 on for the system alias file.
18437 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18438 are evaluated.
18439
18440 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18441 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18442 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18443
18444
18445
18446 .option fail_verify routers boolean false
18447 .cindex "router" "forcing verification failure"
18448 Setting this option has the effect of setting both &%fail_verify_sender%& and
18449 &%fail_verify_recipient%& to the same value.
18450
18451
18452
18453 .option fail_verify_recipient routers boolean false
18454 If this option is true and an address is accepted by this router when
18455 verifying a recipient, verification fails.
18456
18457
18458
18459 .option fail_verify_sender routers boolean false
18460 If this option is true and an address is accepted by this router when
18461 verifying a sender, verification fails.
18462
18463
18464
18465 .option fallback_hosts routers "string list" unset
18466 .cindex "router" "fallback hosts"
18467 .cindex "fallback" "hosts specified on router"
18468 String expansion is not applied to this option. The argument must be a
18469 colon-separated list of host names or IP addresses. The list separator can be
18470 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18471 each name or address. In fact, the format of each item is exactly the same as
18472 defined for the list of hosts in a &(manualroute)& router (see section
18473 &<<SECTformatonehostitem>>&).
18474
18475 If a router queues an address for a remote transport, this host list is
18476 associated with the address, and used instead of the transport's fallback host
18477 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18478 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18479 transport for further details.
18480
18481
18482 .option group routers string&!! "see below"
18483 .cindex "gid (group id)" "local delivery"
18484 .cindex "local transports" "uid and gid"
18485 .cindex "transport" "local"
18486 .cindex "router" "setting group"
18487 When a router queues an address for a transport, and the transport does not
18488 specify a group, the group given here is used when running the delivery
18489 process.
18490 The group may be specified numerically or by name. If expansion fails, the
18491 error is logged and delivery is deferred.
18492 The default is unset, unless &%check_local_user%& is set, when the default
18493 is taken from the password information. See also &%initgroups%& and &%user%&
18494 and the discussion in chapter &<<CHAPenvironment>>&.
18495
18496
18497
18498 .option headers_add routers list&!! unset
18499 .cindex "header lines" "adding"
18500 .cindex "router" "adding header lines"
18501 This option specifies a list of text headers,
18502 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18503 that is associated with any addresses that are accepted by the router.
18504 Each item is separately expanded, at routing time.  However, this
18505 option has no effect when an address is just being verified. The way in which
18506 the text is used to add header lines at transport time is described in section
18507 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18508 message is in the process of being transported. This means that references to
18509 header lines in string expansions in the transport's configuration do not
18510 &"see"& the added header lines.
18511
18512 The &%headers_add%& option is expanded after &%errors_to%&, but before
18513 &%headers_remove%& and &%transport%&. If an item is empty, or if
18514 an item expansion is forced to fail, the item has no effect. Other expansion
18515 failures are treated as configuration errors.
18516
18517 Unlike most options, &%headers_add%& can be specified multiple times
18518 for a router; all listed headers are added.
18519
18520 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18521 router that has the &%one_time%& option set.
18522
18523 .cindex "duplicate addresses"
18524 .oindex "&%unseen%&"
18525 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18526 additions are deleted when the address is passed on to subsequent routers.
18527 For a &%redirect%& router, if a generated address is the same as the incoming
18528 address, this can lead to duplicate addresses with different header
18529 modifications. Exim does not do duplicate deliveries (except, in certain
18530 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18531 which of the duplicates is discarded, so this ambiguous situation should be
18532 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18533
18534
18535
18536 .option headers_remove routers list&!! unset
18537 .cindex "header lines" "removing"
18538 .cindex "router" "removing header lines"
18539 This option specifies a list of text headers,
18540 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18541 that is associated with any addresses that are accepted by the router.
18542 Each item is separately expanded, at routing time.  However, this
18543 option has no effect when an address is just being verified. The way in which
18544 the text is used to remove header lines at transport time is described in
18545 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18546 the message is in the process of being transported. This means that references
18547 to header lines in string expansions in the transport's configuration still
18548 &"see"& the original header lines.
18549
18550 The &%headers_remove%& option is expanded after &%errors_to%& and
18551 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18552 the item has no effect. Other expansion failures are treated as configuration
18553 errors.
18554
18555 Unlike most options, &%headers_remove%& can be specified multiple times
18556 for a router; all listed headers are removed.
18557
18558 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18559 router that has the &%one_time%& option set.
18560
18561 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18562 removal requests are deleted when the address is passed on to subsequent
18563 routers, and this can lead to problems with duplicates -- see the similar
18564 warning for &%headers_add%& above.
18565
18566 &*Warning 3*&: Because of the separate expansion of the list items,
18567 items that contain a list separator must have it doubled.
18568 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18569
18570
18571
18572 .option ignore_target_hosts routers "host list&!!" unset
18573 .cindex "IP address" "discarding"
18574 .cindex "router" "discarding IP addresses"
18575 Although this option is a host list, it should normally contain IP address
18576 entries rather than names. If any host that is looked up by the router has an
18577 IP address that matches an item in this list, Exim behaves as if that IP
18578 address did not exist. This option allows you to cope with rogue DNS entries
18579 like
18580 .code
18581 remote.domain.example.  A  127.0.0.1
18582 .endd
18583 by setting
18584 .code
18585 ignore_target_hosts = 127.0.0.1
18586 .endd
18587 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18588 discarded in this way, the router declines. In a conventional configuration, an
18589 attempt to mail to such a domain would normally provoke the &"unrouteable
18590 domain"& error, and an attempt to verify an address in the domain would fail.
18591 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18592 router declines if presented with one of the listed addresses.
18593
18594 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18595 means of the first or the second of the following settings, respectively:
18596 .code
18597 ignore_target_hosts = 0.0.0.0/0
18598 ignore_target_hosts = <; 0::0/0
18599 .endd
18600 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18601 in the second line matches all IPv6 addresses.
18602
18603 This option may also be useful for ignoring link-local and site-local IPv6
18604 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18605 is expanded before use as a list, it is possible to make it dependent on the
18606 domain that is being routed.
18607
18608 .vindex "&$host_address$&"
18609 During its expansion, &$host_address$& is set to the IP address that is being
18610 checked.
18611
18612 .option initgroups routers boolean false
18613 .cindex "additional groups"
18614 .cindex "groups" "additional"
18615 .cindex "local transports" "uid and gid"
18616 .cindex "transport" "local"
18617 If the router queues an address for a transport, and this option is true, and
18618 the uid supplied by the router is not overridden by the transport, the
18619 &[initgroups()]& function is called when running the transport to ensure that
18620 any additional groups associated with the uid are set up. See also &%group%&
18621 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18622
18623
18624
18625 .option local_part_prefix routers&!? "string list" unset
18626 .cindex affix "router precondition"
18627 .cindex "router" "prefix for local part"
18628 .cindex "prefix" "for local part, used in router"
18629 If this option is set, the router is skipped unless the local part starts with
18630 one of the given strings, or &%local_part_prefix_optional%& is true. See
18631 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18632 evaluated.
18633
18634 The list is scanned from left to right, and the first prefix that matches is
18635 used. A limited form of wildcard is available; if the prefix begins with an
18636 asterisk, it matches the longest possible sequence of arbitrary characters at
18637 the start of the local part. An asterisk should therefore always be followed by
18638 some character that does not occur in normal local parts.
18639 .cindex "multiple mailboxes"
18640 .cindex "mailbox" "multiple"
18641 Wildcarding can be used to set up multiple user mailboxes, as described in
18642 section &<<SECTmulbox>>&.
18643
18644 .vindex "&$local_part$&"
18645 .vindex "&$local_part_prefix$&"
18646 During the testing of the &%local_parts%& option, and while the router is
18647 running, the prefix is removed from the local part, and is available in the
18648 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18649 the router accepts the address, this remains true during subsequent delivery by
18650 a transport. In particular, the local part that is transmitted in the RCPT
18651 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18652 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18653 the relevant transport.
18654
18655 When an address is being verified, &%local_part_prefix%& affects only the
18656 behaviour of the router. If the callout feature of verification is in use, this
18657 means that the full address, including the prefix, will be used during the
18658 callout.
18659
18660 The prefix facility is commonly used to handle local parts of the form
18661 &%owner-something%&. Another common use is to support local parts of the form
18662 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18663 to tell a user their forwarding is broken &-- by placing a router like this one
18664 immediately before the router that handles &_.forward_& files:
18665 .code
18666 real_localuser:
18667   driver = accept
18668   local_part_prefix = real-
18669   check_local_user
18670   transport = local_delivery
18671 .endd
18672 For security, it would probably be a good idea to restrict the use of this
18673 router to locally-generated messages, using a condition such as this:
18674 .code
18675   condition = ${if match {$sender_host_address}\
18676                          {\N^(|127\.0\.0\.1)$\N}}
18677 .endd
18678
18679 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18680 both conditions must be met if not optional. Care must be taken if wildcards
18681 are used in both a prefix and a suffix on the same router. Different
18682 separator characters must be used to avoid ambiguity.
18683
18684
18685 .option local_part_prefix_optional routers boolean false
18686 See &%local_part_prefix%& above.
18687
18688
18689
18690 .option local_part_suffix routers&!? "string list" unset
18691 .cindex "router" "suffix for local part"
18692 .cindex "suffix for local part" "used in router"
18693 This option operates in the same way as &%local_part_prefix%&, except that the
18694 local part must end (rather than start) with the given string, the
18695 &%local_part_suffix_optional%& option determines whether the suffix is
18696 mandatory, and the wildcard * character, if present, must be the last
18697 character of the suffix. This option facility is commonly used to handle local
18698 parts of the form &%something-request%& and multiple user mailboxes of the form
18699 &%username-foo%&.
18700
18701
18702 .option local_part_suffix_optional routers boolean false
18703 See &%local_part_suffix%& above.
18704
18705
18706
18707 .option local_parts routers&!? "local part list&!!" unset
18708 .cindex "router" "restricting to specific local parts"
18709 .cindex "local part" "checking in router"
18710 The router is run only if the local part of the address matches the list.
18711 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18712 are evaluated, and
18713 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18714 string is expanded, it is possible to make it depend on the domain, for
18715 example:
18716 .code
18717 local_parts = dbm;/usr/local/specials/$domain
18718 .endd
18719 .vindex "&$local_part_data$&"
18720 If the match is achieved by a lookup, the data that the lookup returned
18721 for the local part is placed in the variable &$local_part_data$& for use in
18722 expansions of the router's private options. You might use this option, for
18723 example, if you have a large number of local virtual domains, and you want to
18724 send all postmaster mail to the same place without having to set up an alias in
18725 each virtual domain:
18726 .code
18727 postmaster:
18728   driver = redirect
18729   local_parts = postmaster
18730   data = postmaster@real.domain.example
18731 .endd
18732
18733
18734 .option log_as_local routers boolean "see below"
18735 .cindex "log" "delivery line"
18736 .cindex "delivery" "log line format"
18737 Exim has two logging styles for delivery, the idea being to make local
18738 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18739 recipient address is given just as the local part, without a domain. The use of
18740 this style is controlled by this option. It defaults to true for the &(accept)&
18741 router, and false for all the others. This option applies only when a
18742 router assigns an address to a transport. It has no effect on routers that
18743 redirect addresses.
18744
18745
18746
18747 .option more routers boolean&!! true
18748 The result of string expansion for this option must be a valid boolean value,
18749 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18750 result causes an error, and delivery is deferred. If the expansion is forced to
18751 fail, the default value for the option (true) is used. Other failures cause
18752 delivery to be deferred.
18753
18754 If this option is set false, and the router declines to handle the address, no
18755 further routers are tried, routing fails, and the address is bounced.
18756 .oindex "&%self%&"
18757 However, if the router explicitly passes an address to the following router by
18758 means of the setting
18759 .code
18760 self = pass
18761 .endd
18762 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18763 does not affect the behaviour if one of the precondition tests fails. In that
18764 case, the address is always passed to the next router.
18765
18766 Note that &%address_data%& is not considered to be a precondition. If its
18767 expansion is forced to fail, the router declines, and the value of &%more%&
18768 controls what happens next.
18769
18770
18771 .option pass_on_timeout routers boolean false
18772 .cindex "timeout" "of router"
18773 .cindex "router" "timeout"
18774 If a router times out during a host lookup, it normally causes deferral of the
18775 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18776 router, overriding &%no_more%&. This may be helpful for systems that are
18777 intermittently connected to the Internet, or those that want to pass to a smart
18778 host any messages that cannot immediately be delivered.
18779
18780 There are occasional other temporary errors that can occur while doing DNS
18781 lookups. They are treated in the same way as a timeout, and this option
18782 applies to all of them.
18783
18784
18785
18786 .option pass_router routers string unset
18787 .cindex "router" "go to after &""pass""&"
18788 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18789 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18790 routing to continue, and overriding a false setting of &%more%&. When one of
18791 these routers returns &"pass"&, the address is normally handed on to the next
18792 router in sequence. This can be changed by setting &%pass_router%& to the name
18793 of another router. However (unlike &%redirect_router%&) the named router must
18794 be below the current router, to avoid loops. Note that this option applies only
18795 to the special case of &"pass"&. It does not apply when a router returns
18796 &"decline"& because it cannot handle an address.
18797
18798
18799
18800 .option redirect_router routers string unset
18801 .cindex "router" "start at after redirection"
18802 Sometimes an administrator knows that it is pointless to reprocess addresses
18803 generated from alias or forward files with the same router again. For
18804 example, if an alias file translates real names into login ids there is no
18805 point searching the alias file a second time, especially if it is a large file.
18806
18807 The &%redirect_router%& option can be set to the name of any router instance.
18808 It causes the routing of any generated addresses to start at the named router
18809 instead of at the first router. This option has no effect if the router in
18810 which it is set does not generate new addresses.
18811
18812
18813
18814 .option require_files routers&!? "string list&!!" unset
18815 .cindex "file" "requiring for router"
18816 .cindex "router" "requiring file existence"
18817 This option provides a general mechanism for predicating the running of a
18818 router on the existence or non-existence of certain files or directories.
18819 Before running a router, as one of its precondition tests, Exim works its way
18820 through the &%require_files%& list, expanding each item separately.
18821
18822 Because the list is split before expansion, any colons in expansion items must
18823 be doubled, or the facility for using a different list separator must be used
18824 (&<<SECTlistsepchange>>&).
18825 If any expansion is forced to fail, the item is ignored. Other expansion
18826 failures cause routing of the address to be deferred.
18827
18828 If any expanded string is empty, it is ignored. Otherwise, except as described
18829 below, each string must be a fully qualified file path, optionally preceded by
18830 &"!"&. The paths are passed to the &[stat()]& function to test for the
18831 existence of the files or directories. The router is skipped if any paths not
18832 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18833
18834 .cindex "NFS"
18835 If &[stat()]& cannot determine whether a file exists or not, delivery of
18836 the message is deferred. This can happen when NFS-mounted filesystems are
18837 unavailable.
18838
18839 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18840 options, so you cannot use it to check for the existence of a file in which to
18841 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18842 full list of the order in which preconditions are evaluated.) However, as
18843 these options are all expanded, you can use the &%exists%& expansion condition
18844 to make such tests. The &%require_files%& option is intended for checking files
18845 that the router may be going to use internally, or which are needed by a
18846 transport (e.g., &_.procmailrc_&).
18847
18848 During delivery, the &[stat()]& function is run as root, but there is a
18849 facility for some checking of the accessibility of a file by another user.
18850 This is not a proper permissions check, but just a &"rough"& check that
18851 operates as follows:
18852
18853 If an item in a &%require_files%& list does not contain any forward slash
18854 characters, it is taken to be the user (and optional group, separated by a
18855 comma) to be checked for subsequent files in the list. If no group is specified
18856 but the user is specified symbolically, the gid associated with the uid is
18857 used. For example:
18858 .code
18859 require_files = mail:/some/file
18860 require_files = $local_part:$home/.procmailrc
18861 .endd
18862 If a user or group name in a &%require_files%& list does not exist, the
18863 &%require_files%& condition fails.
18864
18865 Exim performs the check by scanning along the components of the file path, and
18866 checking the access for the given uid and gid. It checks for &"x"& access on
18867 directories, and &"r"& access on the final file. Note that this means that file
18868 access control lists, if the operating system has them, are ignored.
18869
18870 &*Warning 1*&: When the router is being run to verify addresses for an
18871 incoming SMTP message, Exim is not running as root, but under its own uid. This
18872 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18873 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18874 user is not permitted to read one of the directories on the file's path.
18875
18876 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18877 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18878 without root access. In this case, if a check for access by a particular user
18879 is requested, Exim creates a subprocess that runs as that user, and tries the
18880 check again in that process.
18881
18882 The default action for handling an unresolved EACCES is to consider it to
18883 be caused by a configuration error, and routing is deferred because the
18884 existence or non-existence of the file cannot be determined. However, in some
18885 circumstances it may be desirable to treat this condition as if the file did
18886 not exist. If the filename (or the exclamation mark that precedes the filename
18887 for non-existence) is preceded by a plus sign, the EACCES error is treated
18888 as if the file did not exist. For example:
18889 .code
18890 require_files = +/some/file
18891 .endd
18892 If the router is not an essential part of verification (for example, it
18893 handles users' &_.forward_& files), another solution is to set the &%verify%&
18894 option false so that the router is skipped when verifying.
18895
18896
18897
18898 .option retry_use_local_part routers boolean "see below"
18899 .cindex "hints database" "retry keys"
18900 .cindex "local part" "in retry keys"
18901 When a delivery suffers a temporary routing failure, a retry record is created
18902 in Exim's hints database. For addresses whose routing depends only on the
18903 domain, the key for the retry record should not involve the local part, but for
18904 other addresses, both the domain and the local part should be included.
18905 Usually, remote routing is of the former kind, and local routing is of the
18906 latter kind.
18907
18908 This option controls whether the local part is used to form the key for retry
18909 hints for addresses that suffer temporary errors while being handled by this
18910 .new
18911 router. The default value is true for any router that has any of
18912 &%check_local_user%&, 
18913 &%local_parts%&,
18914 &%condition%&,
18915 &%local_part_prefix%&,
18916 &%local_part_suffix%&,
18917 &%senders%& or
18918 &%require_files%&
18919 .wen
18920 set, and false otherwise. Note that this option does not apply to hints keys
18921 for transport delays; they are controlled by a generic transport option of the
18922 same name.
18923
18924 Failing to set this option when it is needed
18925 (because a remote router handles only some of the local-parts for a domain)
18926 can result in incorrect error messages being generated.
18927
18928 The setting of &%retry_use_local_part%& applies only to the router on which it
18929 appears. If the router generates child addresses, they are routed
18930 independently; this setting does not become attached to them.
18931
18932
18933
18934 .option router_home_directory routers string&!! unset
18935 .cindex "router" "home directory for"
18936 .cindex "home directory" "for router"
18937 .vindex "&$home$&"
18938 This option sets a home directory for use while the router is running. (Compare
18939 &%transport_home_directory%&, which sets a home directory for later
18940 transporting.) In particular, if used on a &(redirect)& router, this option
18941 sets a value for &$home$& while a filter is running. The value is expanded;
18942 forced expansion failure causes the option to be ignored &-- other failures
18943 cause the router to defer.
18944
18945 Expansion of &%router_home_directory%& happens immediately after the
18946 &%check_local_user%& test (if configured), before any further expansions take
18947 place.
18948 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18949 are evaluated.)
18950 While the router is running, &%router_home_directory%& overrides the value of
18951 &$home$& that came from &%check_local_user%&.
18952
18953 When a router accepts an address and assigns it to a local transport (including
18954 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18955 delivery), the home directory setting for the transport is taken from the first
18956 of these values that is set:
18957
18958 .ilist
18959 The &%home_directory%& option on the transport;
18960 .next
18961 The &%transport_home_directory%& option on the router;
18962 .next
18963 The password data if &%check_local_user%& is set on the router;
18964 .next
18965 The &%router_home_directory%& option on the router.
18966 .endlist
18967
18968 In other words, &%router_home_directory%& overrides the password data for the
18969 router, but not for the transport.
18970
18971
18972
18973 .option self routers string freeze
18974 .cindex "MX record" "pointing to local host"
18975 .cindex "local host" "MX pointing to"
18976 This option applies to those routers that use a recipient address to find a
18977 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18978 and &(manualroute)& routers.
18979 Certain configurations of the &(queryprogram)& router can also specify a list
18980 of remote hosts.
18981 Usually such routers are configured to send the message to a remote host via an
18982 &(smtp)& transport. The &%self%& option specifies what happens when the first
18983 host on the list turns out to be the local host.
18984 The way in which Exim checks for the local host is described in section
18985 &<<SECTreclocipadd>>&.
18986
18987 Normally this situation indicates either an error in Exim's configuration (for
18988 example, the router should be configured not to process this domain), or an
18989 error in the DNS (for example, the MX should not point to this host). For this
18990 reason, the default action is to log the incident, defer the address, and
18991 freeze the message. The following alternatives are provided for use in special
18992 cases:
18993
18994 .vlist
18995 .vitem &%defer%&
18996 Delivery of the message is tried again later, but the message is not frozen.
18997
18998 .vitem "&%reroute%&: <&'domain'&>"
18999 The domain is changed to the given domain, and the address is passed back to
19000 be reprocessed by the routers. No rewriting of headers takes place. This
19001 behaviour is essentially a redirection.
19002
19003 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19004 The domain is changed to the given domain, and the address is passed back to be
19005 reprocessed by the routers. Any headers that contain the original domain are
19006 rewritten.
19007
19008 .vitem &%pass%&
19009 .oindex "&%more%&"
19010 .vindex "&$self_hostname$&"
19011 The router passes the address to the next router, or to the router named in the
19012 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19013 subsequent routing and delivery, the variable &$self_hostname$& contains the
19014 name of the local host that the router encountered. This can be used to
19015 distinguish between different cases for hosts with multiple names. The
19016 combination
19017 .code
19018 self = pass
19019 no_more
19020 .endd
19021 ensures that only those addresses that routed to the local host are passed on.
19022 Without &%no_more%&, addresses that were declined for other reasons would also
19023 be passed to the next router.
19024
19025 .vitem &%fail%&
19026 Delivery fails and an error report is generated.
19027
19028 .vitem &%send%&
19029 .cindex "local host" "sending to"
19030 The anomaly is ignored and the address is queued for the transport. This
19031 setting should be used with extreme caution. For an &(smtp)& transport, it
19032 makes sense only in cases where the program that is listening on the SMTP port
19033 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19034 different configuration file that handles the domain in another way.
19035 .endlist
19036
19037
19038
19039 .option senders routers&!? "address list&!!" unset
19040 .cindex "router" "checking senders"
19041 If this option is set, the router is skipped unless the message's sender
19042 address matches something on the list.
19043 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19044 are evaluated.
19045
19046 There are issues concerning verification when the running of routers is
19047 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19048 setting, it sets the sender to the null string. When using the &%-bt%& option
19049 to check a configuration file, it is necessary also to use the &%-f%& option to
19050 set an appropriate sender. For incoming mail, the sender is unset when
19051 verifying the sender, but is available when verifying any recipients. If the
19052 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19053 matters.
19054
19055
19056 .new
19057 .option set routers "string list" unset
19058 .cindex router variables
19059 This option may be used multiple times on a router;
19060 because of this the list aspect is mostly irrelevant.
19061 The list separator is a semicolon but can be changed in the
19062 usual way.
19063
19064 Each list-element given must be of the form $"name = value"$
19065 and the names used must start with the string &"r_"&.
19066 Values containing a list-separator should have them doubled.
19067 When a router runs, the strings are evaluated in order,
19068 to create variables which are added to the set associated with
19069 the address.
19070 The variable is set with the expansion of the value.
19071 The variables can be used by the router options
19072 (not including any preconditions)
19073 and by the transport.
19074 Later definitions of a given named variable will override former ones.
19075 Varible use is via the usual &$r_...$& syntax.
19076
19077 This is similar to the &%address_data%& option, except that
19078 many independent variables can be used, with choice of naming.
19079 .wen
19080
19081
19082 .option translate_ip_address routers string&!! unset
19083 .cindex "IP address" "translating"
19084 .cindex "packet radio"
19085 .cindex "router" "IP address translation"
19086 There exist some rare networking situations (for example, packet radio) where
19087 it is helpful to be able to translate IP addresses generated by normal routing
19088 mechanisms into other IP addresses, thus performing a kind of manual IP
19089 routing. This should be done only if the normal IP routing of the TCP/IP stack
19090 is inadequate or broken. Because this is an extremely uncommon requirement, the
19091 code to support this option is not included in the Exim binary unless
19092 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19093
19094 .vindex "&$host_address$&"
19095 The &%translate_ip_address%& string is expanded for every IP address generated
19096 by the router, with the generated address set in &$host_address$&. If the
19097 expansion is forced to fail, no action is taken.
19098 For any other expansion error, delivery of the message is deferred.
19099 If the result of the expansion is an IP address, that replaces the original
19100 address; otherwise the result is assumed to be a host name &-- this is looked
19101 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19102 produce one or more replacement IP addresses. For example, to subvert all IP
19103 addresses in some specific networks, this could be added to a router:
19104 .code
19105 translate_ip_address = \
19106   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19107     {$value}fail}}
19108 .endd
19109 The file would contain lines like
19110 .code
19111 10.2.3.128/26    some.host
19112 10.8.4.34/26     10.44.8.15
19113 .endd
19114 You should not make use of this facility unless you really understand what you
19115 are doing.
19116
19117
19118
19119 .option transport routers string&!! unset
19120 This option specifies the transport to be used when a router accepts an address
19121 and sets it up for delivery. A transport is never needed if a router is used
19122 only for verification. The value of the option is expanded at routing time,
19123 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19124 and result must be the name of one of the configured transports. If it is not,
19125 delivery is deferred.
19126
19127 The &%transport%& option is not used by the &(redirect)& router, but it does
19128 have some private options that set up transports for pipe and file deliveries
19129 (see chapter &<<CHAPredirect>>&).
19130
19131
19132
19133 .option transport_current_directory routers string&!! unset
19134 .cindex "current directory for local transport"
19135 This option associates a current directory with any address that is routed
19136 to a local transport. This can happen either because a transport is
19137 explicitly configured for the router, or because it generates a delivery to a
19138 file or a pipe. During the delivery process (that is, at transport time), this
19139 option string is expanded and is set as the current directory, unless
19140 overridden by a setting on the transport.
19141 If the expansion fails for any reason, including forced failure, an error is
19142 logged, and delivery is deferred.
19143 See chapter &<<CHAPenvironment>>& for details of the local delivery
19144 environment.
19145
19146
19147
19148
19149 .option transport_home_directory routers string&!! "see below"
19150 .cindex "home directory" "for local transport"
19151 This option associates a home directory with any address that is routed to a
19152 local transport. This can happen either because a transport is explicitly
19153 configured for the router, or because it generates a delivery to a file or a
19154 pipe. During the delivery process (that is, at transport time), the option
19155 string is expanded and is set as the home directory, unless overridden by a
19156 setting of &%home_directory%& on the transport.
19157 If the expansion fails for any reason, including forced failure, an error is
19158 logged, and delivery is deferred.
19159
19160 If the transport does not specify a home directory, and
19161 &%transport_home_directory%& is not set for the router, the home directory for
19162 the transport is taken from the password data if &%check_local_user%& is set for
19163 the router. Otherwise it is taken from &%router_home_directory%& if that option
19164 is set; if not, no home directory is set for the transport.
19165
19166 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19167 environment.
19168
19169
19170
19171
19172 .option unseen routers boolean&!! false
19173 .cindex "router" "carrying on after success"
19174 The result of string expansion for this option must be a valid boolean value,
19175 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19176 result causes an error, and delivery is deferred. If the expansion is forced to
19177 fail, the default value for the option (false) is used. Other failures cause
19178 delivery to be deferred.
19179
19180 When this option is set true, routing does not cease if the router accepts the
19181 address. Instead, a copy of the incoming address is passed to the next router,
19182 overriding a false setting of &%more%&. There is little point in setting
19183 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19184 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19185 sometimes true and sometimes false).
19186
19187 .cindex "copy of message (&%unseen%& option)"
19188 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19189 qualifier in filter files. It can be used to cause copies of messages to be
19190 delivered to some other destination, while also carrying out a normal delivery.
19191 In effect, the current address is made into a &"parent"& that has two children
19192 &-- one that is delivered as specified by this router, and a clone that goes on
19193 to be routed further. For this reason, &%unseen%& may not be combined with the
19194 &%one_time%& option in a &(redirect)& router.
19195
19196 &*Warning*&: Header lines added to the address (or specified for removal) by
19197 this router or by previous routers affect the &"unseen"& copy of the message
19198 only. The clone that continues to be processed by further routers starts with
19199 no added headers and none specified for removal. For a &%redirect%& router, if
19200 a generated address is the same as the incoming address, this can lead to
19201 duplicate addresses with different header modifications. Exim does not do
19202 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19203 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19204 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19205 &%redirect%& router may be of help.
19206
19207 Unlike the handling of header modifications, any data that was set by the
19208 &%address_data%& option in the current or previous routers &'is'& passed on to
19209 subsequent routers.
19210
19211
19212 .option user routers string&!! "see below"
19213 .cindex "uid (user id)" "local delivery"
19214 .cindex "local transports" "uid and gid"
19215 .cindex "transport" "local"
19216 .cindex "router" "user for filter processing"
19217 .cindex "filter" "user for processing"
19218 When a router queues an address for a transport, and the transport does not
19219 specify a user, the user given here is used when running the delivery process.
19220 The user may be specified numerically or by name. If expansion fails, the
19221 error is logged and delivery is deferred.
19222 This user is also used by the &(redirect)& router when running a filter file.
19223 The default is unset, except when &%check_local_user%& is set. In this case,
19224 the default is taken from the password information. If the user is specified as
19225 a name, and &%group%& is not set, the group associated with the user is used.
19226 See also &%initgroups%& and &%group%& and the discussion in chapter
19227 &<<CHAPenvironment>>&.
19228
19229
19230
19231 .option verify routers&!? boolean true
19232 Setting this option has the effect of setting &%verify_sender%& and
19233 &%verify_recipient%& to the same value.
19234
19235
19236 .option verify_only routers&!? boolean false
19237 .cindex "EXPN" "with &%verify_only%&"
19238 .oindex "&%-bv%&"
19239 .cindex "router" "used only when verifying"
19240 If this option is set, the router is used only when verifying an address,
19241 delivering in cutthrough mode or
19242 testing with the &%-bv%& option, not when actually doing a delivery, testing
19243 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19244 restricted to verifying only senders or recipients by means of
19245 &%verify_sender%& and &%verify_recipient%&.
19246
19247 &*Warning*&: When the router is being run to verify addresses for an incoming
19248 SMTP message, Exim is not running as root, but under its own uid. If the router
19249 accesses any files, you need to make sure that they are accessible to the Exim
19250 user or group.
19251
19252
19253 .option verify_recipient routers&!? boolean true
19254 If this option is false, the router is skipped when verifying recipient
19255 addresses,
19256 delivering in cutthrough mode
19257 or testing recipient verification using &%-bv%&.
19258 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19259 are evaluated.
19260 See also the &$verify_mode$& variable.
19261
19262
19263 .option verify_sender routers&!? boolean true
19264 If this option is false, the router is skipped when verifying sender addresses
19265 or testing sender verification using &%-bvs%&.
19266 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19267 are evaluated.
19268 See also the &$verify_mode$& variable.
19269 .ecindex IIDgenoprou1
19270 .ecindex IIDgenoprou2
19271
19272
19273
19274
19275
19276
19277 . ////////////////////////////////////////////////////////////////////////////
19278 . ////////////////////////////////////////////////////////////////////////////
19279
19280 .chapter "The accept router" "CHID4"
19281 .cindex "&(accept)& router"
19282 .cindex "routers" "&(accept)&"
19283 The &(accept)& router has no private options of its own. Unless it is being
19284 used purely for verification (see &%verify_only%&) a transport is required to
19285 be defined by the generic &%transport%& option. If the preconditions that are
19286 specified by generic options are met, the router accepts the address and queues
19287 it for the given transport. The most common use of this router is for setting
19288 up deliveries to local mailboxes. For example:
19289 .code
19290 localusers:
19291   driver = accept
19292   domains = mydomain.example
19293   check_local_user
19294   transport = local_delivery
19295 .endd
19296 The &%domains%& condition in this example checks the domain of the address, and
19297 &%check_local_user%& checks that the local part is the login of a local user.
19298 When both preconditions are met, the &(accept)& router runs, and queues the
19299 address for the &(local_delivery)& transport.
19300
19301
19302
19303
19304
19305
19306 . ////////////////////////////////////////////////////////////////////////////
19307 . ////////////////////////////////////////////////////////////////////////////
19308
19309 .chapter "The dnslookup router" "CHAPdnslookup"
19310 .scindex IIDdnsrou1 "&(dnslookup)& router"
19311 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19312 The &(dnslookup)& router looks up the hosts that handle mail for the
19313 recipient's domain in the DNS. A transport must always be set for this router,
19314 unless &%verify_only%& is set.
19315
19316 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19317 SRV records. If none are found, or if SRV support is not configured,
19318 MX records are looked up. If no MX records exist, address records are sought.
19319 However, &%mx_domains%& can be set to disable the direct use of address
19320 records.
19321
19322 MX records of equal priority are sorted by Exim into a random order. Exim then
19323 looks for address records for the host names obtained from MX or SRV records.
19324 When a host has more than one IP address, they are sorted into a random order,
19325 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19326 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19327 generic option, the router declines.
19328
19329 Unless they have the highest priority (lowest MX value), MX records that point
19330 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19331 are discarded, together with any other MX records of equal or lower priority.
19332
19333 .cindex "MX record" "pointing to local host"
19334 .cindex "local host" "MX pointing to"
19335 .oindex "&%self%&" "in &(dnslookup)& router"
19336 If the host pointed to by the highest priority MX record, or looked up as an
19337 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19338 happens is controlled by the generic &%self%& option.
19339
19340
19341 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19342 There have been problems with DNS servers when SRV records are looked up.
19343 Some misbehaving servers return a DNS error or timeout when a non-existent
19344 SRV record is sought. Similar problems have in the past been reported for
19345 MX records. The global &%dns_again_means_nonexist%& option can help with this
19346 problem, but it is heavy-handed because it is a global option.
19347
19348 For this reason, there are two options, &%srv_fail_domains%& and
19349 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19350 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19351 an attempt to look up an SRV or MX record causes one of these results, and the
19352 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19353 such record"&. In the case of an SRV lookup, this means that the router
19354 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19355 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19356 case routing fails.
19357
19358
19359 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19360 .cindex "&(dnslookup)& router" "declines"
19361 There are a few cases where a &(dnslookup)& router will decline to accept
19362 an address; if such a router is expected to handle "all remaining non-local
19363 domains", then it is important to set &%no_more%&.
19364
19365 The router will defer rather than decline if the domain
19366 is found in the &%fail_defer_domains%& router option.
19367
19368 Reasons for a &(dnslookup)& router to decline currently include:
19369 .ilist
19370 The domain does not exist in DNS
19371 .next
19372 The domain exists but the MX record's host part is just "."; this is a common
19373 convention (borrowed from SRV) used to indicate that there is no such service
19374 for this domain and to not fall back to trying A/AAAA records.
19375 .next
19376 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19377 .next
19378 MX record points to a non-existent host.
19379 .next
19380 MX record points to an IP address and the main section option
19381 &%allow_mx_to_ip%& is not set.
19382 .next
19383 MX records exist and point to valid hosts, but all hosts resolve only to
19384 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19385 .next
19386 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19387 &%dns_check_names_pattern%& for handling one variant of this)
19388 .next
19389 &%check_secondary_mx%& is set on this router but the local host can
19390 not be found in the MX records (see below)
19391 .endlist
19392
19393
19394
19395
19396 .section "Private options for dnslookup" "SECID118"
19397 .cindex "options" "&(dnslookup)& router"
19398 The private options for the &(dnslookup)& router are as follows:
19399
19400 .option check_secondary_mx dnslookup boolean false
19401 .cindex "MX record" "checking for secondary"
19402 If this option is set, the router declines unless the local host is found in
19403 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19404 process domains for which the local host is a secondary mail exchanger
19405 differently to other domains. The way in which Exim decides whether a host is
19406 the local host is described in section &<<SECTreclocipadd>>&.
19407
19408
19409 .option check_srv dnslookup string&!! unset
19410 .cindex "SRV record" "enabling use of"
19411 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19412 addition to MX and address records. The support is disabled by default. To
19413 enable SRV support, set the &%check_srv%& option to the name of the service
19414 required. For example,
19415 .code
19416 check_srv = smtp
19417 .endd
19418 looks for SRV records that refer to the normal smtp service. The option is
19419 expanded, so the service name can vary from message to message or address
19420 to address. This might be helpful if SRV records are being used for a
19421 submission service. If the expansion is forced to fail, the &%check_srv%&
19422 option is ignored, and the router proceeds to look for MX records in the
19423 normal way.
19424
19425 When the expansion succeeds, the router searches first for SRV records for
19426 the given service (it assumes TCP protocol). A single SRV record with a
19427 host name that consists of just a single dot indicates &"no such service for
19428 this domain"&; if this is encountered, the router declines. If other kinds of
19429 SRV record are found, they are used to construct a host list for delivery
19430 according to the rules of RFC 2782. MX records are not sought in this case.
19431
19432 When no SRV records are found, MX records (and address records) are sought in
19433 the traditional way. In other words, SRV records take precedence over MX
19434 records, just as MX records take precedence over address records. Note that
19435 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19436 defined it. It is apparently believed that MX records are sufficient for email
19437 and that SRV records should not be used for this purpose. However, SRV records
19438 have an additional &"weight"& feature which some people might find useful when
19439 trying to split an SMTP load between hosts of different power.
19440
19441 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19442 when there is a DNS lookup error.
19443
19444
19445
19446
19447 .option fail_defer_domains dnslookup "domain list&!!" unset
19448 .cindex "MX record" "not found"
19449 DNS lookups for domains matching &%fail_defer_domains%&
19450 which find no matching record will cause the router to defer
19451 rather than the default behaviour of decline.
19452 This maybe be useful for queueing messages for a newly created
19453 domain while the DNS configuration is not ready.
19454 However, it will result in any message with mistyped domains
19455 also being queued.
19456
19457
19458 .option ipv4_only "string&!!" unset
19459 .cindex IPv6 disabling
19460 .cindex DNS "IPv6 disabling"
19461 The string is expanded, and if the result is anything but a forced failure,
19462 or an empty string, or one of the strings “0” or “no” or “false”
19463 (checked without regard to the case of the letters),
19464 only A records are used.
19465
19466 .option ipv4_prefer "string&!!" unset
19467 .cindex IPv4 preference
19468 .cindex DNS "IPv4 preference"
19469 The string is expanded, and if the result is anything but a forced failure,
19470 or an empty string, or one of the strings “0” or “no” or “false”
19471 (checked without regard to the case of the letters),
19472 A records are sorted before AAAA records (inverting the default).
19473
19474 .option mx_domains dnslookup "domain list&!!" unset
19475 .cindex "MX record" "required to exist"
19476 .cindex "SRV record" "required to exist"
19477 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19478 record in order to be recognized. (The name of this option could be improved.)
19479 For example, if all the mail hosts in &'fict.example'& are known to have MX
19480 records, except for those in &'discworld.fict.example'&, you could use this
19481 setting:
19482 .code
19483 mx_domains = ! *.discworld.fict.example : *.fict.example
19484 .endd
19485 This specifies that messages addressed to a domain that matches the list but
19486 has no MX record should be bounced immediately instead of being routed using
19487 the address record.
19488
19489
19490 .option mx_fail_domains dnslookup "domain list&!!" unset
19491 If the DNS lookup for MX records for one of the domains in this list causes a
19492 DNS lookup error, Exim behaves as if no MX records were found. See section
19493 &<<SECTprowitdnsloo>>& for more discussion.
19494
19495
19496
19497
19498 .option qualify_single dnslookup boolean true
19499 .cindex "DNS" "resolver options"
19500 .cindex "DNS" "qualifying single-component names"
19501 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19502 lookups. Typically, but not standardly, this causes the resolver to qualify
19503 single-component names with the default domain. For example, on a machine
19504 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19505 &'thesaurus.ref.example'& inside the resolver. For details of what your
19506 resolver actually does, consult your man pages for &'resolver'& and
19507 &'resolv.conf'&.
19508
19509
19510
19511 .option rewrite_headers dnslookup boolean true
19512 .cindex "rewriting" "header lines"
19513 .cindex "header lines" "rewriting"
19514 If the domain name in the address that is being processed is not fully
19515 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19516 an address is specified as &'dormouse@teaparty'&, the domain might be
19517 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19518 occur as a result of setting the &%widen_domains%& option. If
19519 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19520 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19521 header lines of the message are rewritten with the full domain name.
19522
19523 This option should be turned off only when it is known that no message is
19524 ever going to be sent outside an environment where the abbreviation makes
19525 sense.
19526
19527 When an MX record is looked up in the DNS and matches a wildcard record, name
19528 servers normally return a record containing the name that has been looked up,
19529 making it impossible to detect whether a wildcard was present or not. However,
19530 some name servers have recently been seen to return the wildcard entry. If the
19531 name returned by a DNS lookup begins with an asterisk, it is not used for
19532 header rewriting.
19533
19534
19535 .option same_domain_copy_routing dnslookup boolean false
19536 .cindex "address" "copying routing"
19537 Addresses with the same domain are normally routed by the &(dnslookup)& router
19538 to the same list of hosts. However, this cannot be presumed, because the router
19539 options and preconditions may refer to the local part of the address. By
19540 default, therefore, Exim routes each address in a message independently. DNS
19541 servers run caches, so repeated DNS lookups are not normally expensive, and in
19542 any case, personal messages rarely have more than a few recipients.
19543
19544 If you are running mailing lists with large numbers of subscribers at the same
19545 domain, and you are using a &(dnslookup)& router which is independent of the
19546 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19547 lookups for identical domains in one message. In this case, when &(dnslookup)&
19548 routes an address to a remote transport, any other unrouted addresses in the
19549 message that have the same domain are automatically given the same routing
19550 without processing them independently,
19551 provided the following conditions are met:
19552
19553 .ilist
19554 No router that processed the address specified &%headers_add%& or
19555 &%headers_remove%&.
19556 .next
19557 The router did not change the address in any way, for example, by &"widening"&
19558 the domain.
19559 .endlist
19560
19561
19562
19563
19564 .option search_parents dnslookup boolean false
19565 .cindex "DNS" "resolver options"
19566 When this option is true, the resolver option RES_DNSRCH is set for DNS
19567 lookups. This is different from the &%qualify_single%& option in that it
19568 applies to domains containing dots. Typically, but not standardly, it causes
19569 the resolver to search for the name in the current domain and in parent
19570 domains. For example, on a machine in the &'fict.example'& domain, if looking
19571 up &'teaparty.wonderland'& failed, the resolver would try
19572 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19573 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19574
19575 Setting this option true can cause problems in domains that have a wildcard MX
19576 record, because any domain that does not have its own MX record matches the
19577 local wildcard.
19578
19579
19580
19581 .option srv_fail_domains dnslookup "domain list&!!" unset
19582 If the DNS lookup for SRV records for one of the domains in this list causes a
19583 DNS lookup error, Exim behaves as if no SRV records were found. See section
19584 &<<SECTprowitdnsloo>>& for more discussion.
19585
19586
19587
19588
19589 .option widen_domains dnslookup "string list" unset
19590 .cindex "domain" "partial; widening"
19591 If a DNS lookup fails and this option is set, each of its strings in turn is
19592 added onto the end of the domain, and the lookup is tried again. For example,
19593 if
19594 .code
19595 widen_domains = fict.example:ref.example
19596 .endd
19597 is set and a lookup of &'klingon.dictionary'& fails,
19598 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19599 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19600 and &%search_parents%& options can cause some widening to be undertaken inside
19601 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19602 when verifying, unless &%rewrite_headers%& is false (not the default).
19603
19604
19605 .section "Effect of qualify_single and search_parents" "SECID119"
19606 When a domain from an envelope recipient is changed by the resolver as a result
19607 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19608 corresponding address in the message's header lines unless &%rewrite_headers%&
19609 is set false. Exim then re-routes the address, using the full domain.
19610
19611 These two options affect only the DNS lookup that takes place inside the router
19612 for the domain of the address that is being routed. They do not affect lookups
19613 such as that implied by
19614 .code
19615 domains = @mx_any
19616 .endd
19617 that may happen while processing a router precondition before the router is
19618 entered. No widening ever takes place for these lookups.
19619 .ecindex IIDdnsrou1
19620 .ecindex IIDdnsrou2
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630 . ////////////////////////////////////////////////////////////////////////////
19631 . ////////////////////////////////////////////////////////////////////////////
19632
19633 .chapter "The ipliteral router" "CHID5"
19634 .cindex "&(ipliteral)& router"
19635 .cindex "domain literal" "routing"
19636 .cindex "routers" "&(ipliteral)&"
19637 This router has no private options. Unless it is being used purely for
19638 verification (see &%verify_only%&) a transport is required to be defined by the
19639 generic &%transport%& option. The router accepts the address if its domain part
19640 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19641 router handles the address
19642 .code
19643 root@[192.168.1.1]
19644 .endd
19645 by setting up delivery to the host with that IP address. IPv4 domain literals
19646 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19647 are similar, but the address is preceded by &`ipv6:`&. For example:
19648 .code
19649 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19650 .endd
19651 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19652 grounds that sooner or later somebody will try it.
19653
19654 .oindex "&%self%&" "in &(ipliteral)& router"
19655 If the IP address matches something in &%ignore_target_hosts%&, the router
19656 declines. If an IP literal turns out to refer to the local host, the generic
19657 &%self%& option determines what happens.
19658
19659 The RFCs require support for domain literals; however, their use is
19660 controversial in today's Internet. If you want to use this router, you must
19661 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19662 Exim will not recognize the domain literal syntax in addresses.
19663
19664
19665
19666 . ////////////////////////////////////////////////////////////////////////////
19667 . ////////////////////////////////////////////////////////////////////////////
19668
19669 .chapter "The iplookup router" "CHID6"
19670 .cindex "&(iplookup)& router"
19671 .cindex "routers" "&(iplookup)&"
19672 The &(iplookup)& router was written to fulfil a specific requirement in
19673 Cambridge University (which in fact no longer exists). For this reason, it is
19674 not included in the binary of Exim by default. If you want to include it, you
19675 must set
19676 .code
19677 ROUTER_IPLOOKUP=yes
19678 .endd
19679 in your &_Local/Makefile_& configuration file.
19680
19681 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19682 connection to one or more specific hosts. The host can then return the same or
19683 a different address &-- in effect rewriting the recipient address in the
19684 message's envelope. The new address is then passed on to subsequent routers. If
19685 this process fails, the address can be passed on to other routers, or delivery
19686 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19687 must not be specified for it.
19688
19689 .cindex "options" "&(iplookup)& router"
19690 .option hosts iplookup string unset
19691 This option must be supplied. Its value is a colon-separated list of host
19692 names. The hosts are looked up using &[gethostbyname()]&
19693 (or &[getipnodebyname()]& when available)
19694 and are tried in order until one responds to the query. If none respond, what
19695 happens is controlled by &%optional%&.
19696
19697
19698 .option optional iplookup boolean false
19699 If &%optional%& is true, if no response is obtained from any host, the address
19700 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19701 delivery to the address is deferred.
19702
19703
19704 .option port iplookup integer 0
19705 .cindex "port" "&(iplookup)& router"
19706 This option must be supplied. It specifies the port number for the TCP or UDP
19707 call.
19708
19709
19710 .option protocol iplookup string udp
19711 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19712 protocols is to be used.
19713
19714
19715 .option query iplookup string&!! "see below"
19716 This defines the content of the query that is sent to the remote hosts. The
19717 default value is:
19718 .code
19719 $local_part@$domain $local_part@$domain
19720 .endd
19721 The repetition serves as a way of checking that a response is to the correct
19722 query in the default case (see &%response_pattern%& below).
19723
19724
19725 .option reroute iplookup string&!! unset
19726 If this option is not set, the rerouted address is precisely the byte string
19727 returned by the remote host, up to the first white space, if any. If set, the
19728 string is expanded to form the rerouted address. It can include parts matched
19729 in the response by &%response_pattern%& by means of numeric variables such as
19730 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19731 whether or not a pattern is in use. In all cases, the rerouted address must end
19732 up in the form &'local_part@domain'&.
19733
19734
19735 .option response_pattern iplookup string unset
19736 This option can be set to a regular expression that is applied to the string
19737 returned from the remote host. If the pattern does not match the response, the
19738 router declines. If &%response_pattern%& is not set, no checking of the
19739 response is done, unless the query was defaulted, in which case there is a
19740 check that the text returned after the first white space is the original
19741 address. This checks that the answer that has been received is in response to
19742 the correct question. For example, if the response is just a new domain, the
19743 following could be used:
19744 .code
19745 response_pattern = ^([^@]+)$
19746 reroute = $local_part@$1
19747 .endd
19748
19749 .option timeout iplookup time 5s
19750 This specifies the amount of time to wait for a response from the remote
19751 machine. The same timeout is used for the &[connect()]& function for a TCP
19752 call. It does not apply to UDP.
19753
19754
19755
19756
19757 . ////////////////////////////////////////////////////////////////////////////
19758 . ////////////////////////////////////////////////////////////////////////////
19759
19760 .chapter "The manualroute router" "CHID7"
19761 .scindex IIDmanrou1 "&(manualroute)& router"
19762 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19763 .cindex "domain" "manually routing"
19764 The &(manualroute)& router is so-called because it provides a way of manually
19765 routing an address according to its domain. It is mainly used when you want to
19766 route addresses to remote hosts according to your own rules, bypassing the
19767 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19768 route to local transports, a facility that may be useful if you want to save
19769 messages for dial-in hosts in local files.
19770
19771 The &(manualroute)& router compares a list of domain patterns with the domain
19772 it is trying to route. If there is no match, the router declines. Each pattern
19773 has associated with it a list of hosts and some other optional data, which may
19774 include a transport. The combination of a pattern and its data is called a
19775 &"routing rule"&. For patterns that do not have an associated transport, the
19776 generic &%transport%& option must specify a transport, unless the router is
19777 being used purely for verification (see &%verify_only%&).
19778
19779 .vindex "&$host$&"
19780 In the case of verification, matching the domain pattern is sufficient for the
19781 router to accept the address. When actually routing an address for delivery,
19782 an address that matches a domain pattern is queued for the associated
19783 transport. If the transport is not a local one, a host list must be associated
19784 with the pattern; IP addresses are looked up for the hosts, and these are
19785 passed to the transport along with the mail address. For local transports, a
19786 host list is optional. If it is present, it is passed in &$host$& as a single
19787 text string.
19788
19789 The list of routing rules can be provided as an inline string in
19790 &%route_list%&, or the data can be obtained by looking up the domain in a file
19791 or database by setting &%route_data%&. Only one of these settings may appear in
19792 any one instance of &(manualroute)&. The format of routing rules is described
19793 below, following the list of private options.
19794
19795
19796 .section "Private options for manualroute" "SECTprioptman"
19797
19798 .cindex "options" "&(manualroute)& router"
19799 The private options for the &(manualroute)& router are as follows:
19800
19801 .option host_all_ignored manualroute string defer
19802 See &%host_find_failed%&.
19803
19804 .option host_find_failed manualroute string freeze
19805 This option controls what happens when &(manualroute)& tries to find an IP
19806 address for a host, and the host does not exist. The option can be set to one
19807 of the following values:
19808 .code
19809 decline
19810 defer
19811 fail
19812 freeze
19813 ignore
19814 pass
19815 .endd
19816 The default (&"freeze"&) assumes that this state is a serious configuration
19817 error. The difference between &"pass"& and &"decline"& is that the former
19818 forces the address to be passed to the next router (or the router defined by
19819 &%pass_router%&),
19820 .oindex "&%more%&"
19821 overriding &%no_more%&, whereas the latter passes the address to the next
19822 router only if &%more%& is true.
19823
19824 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19825 cannot be found. If all the hosts in the list are ignored, the behaviour is
19826 controlled by the &%host_all_ignored%& option. This takes the same values
19827 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19828
19829 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19830 state; if a host lookup gets a temporary error, delivery is deferred unless the
19831 generic &%pass_on_timeout%& option is set.
19832
19833
19834 .option hosts_randomize manualroute boolean false
19835 .cindex "randomized host list"
19836 .cindex "host" "list of; randomized"
19837 If this option is set, the order of the items in a host list in a routing rule
19838 is randomized each time the list is used, unless an option in the routing rule
19839 overrides (see below). Randomizing the order of a host list can be used to do
19840 crude load sharing. However, if more than one mail address is routed by the
19841 same router to the same host list, the host lists are considered to be the same
19842 (even though they may be randomized into different orders) for the purpose of
19843 deciding whether to batch the deliveries into a single SMTP transaction.
19844
19845 When &%hosts_randomize%& is true, a host list may be split
19846 into groups whose order is separately randomized. This makes it possible to
19847 set up MX-like behaviour. The boundaries between groups are indicated by an
19848 item that is just &`+`& in the host list. For example:
19849 .code
19850 route_list = * host1:host2:host3:+:host4:host5
19851 .endd
19852 The order of the first three hosts and the order of the last two hosts is
19853 randomized for each use, but the first three always end up before the last two.
19854 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19855 randomized host list is passed to an &(smtp)& transport that also has
19856 &%hosts_randomize set%&, the list is not re-randomized.
19857
19858
19859 .option route_data manualroute string&!! unset
19860 If this option is set, it must expand to yield the data part of a routing rule.
19861 Typically, the expansion string includes a lookup based on the domain. For
19862 example:
19863 .code
19864 route_data = ${lookup{$domain}dbm{/etc/routes}}
19865 .endd
19866 If the expansion is forced to fail, or the result is an empty string, the
19867 router declines. Other kinds of expansion failure cause delivery to be
19868 deferred.
19869
19870
19871 .option route_list manualroute "string list" unset
19872 This string is a list of routing rules, in the form defined below. Note that,
19873 unlike most string lists, the items are separated by semicolons. This is so
19874 that they may contain colon-separated host lists.
19875
19876
19877 .option same_domain_copy_routing manualroute boolean false
19878 .cindex "address" "copying routing"
19879 Addresses with the same domain are normally routed by the &(manualroute)&
19880 router to the same list of hosts. However, this cannot be presumed, because the
19881 router options and preconditions may refer to the local part of the address. By
19882 default, therefore, Exim routes each address in a message independently. DNS
19883 servers run caches, so repeated DNS lookups are not normally expensive, and in
19884 any case, personal messages rarely have more than a few recipients.
19885
19886 If you are running mailing lists with large numbers of subscribers at the same
19887 domain, and you are using a &(manualroute)& router which is independent of the
19888 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19889 lookups for identical domains in one message. In this case, when
19890 &(manualroute)& routes an address to a remote transport, any other unrouted
19891 addresses in the message that have the same domain are automatically given the
19892 same routing without processing them independently. However, this is only done
19893 if &%headers_add%& and &%headers_remove%& are unset.
19894
19895
19896
19897
19898 .section "Routing rules in route_list" "SECID120"
19899 The value of &%route_list%& is a string consisting of a sequence of routing
19900 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19901 entered as two semicolons. Alternatively, the list separator can be changed as
19902 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19903 Empty rules are ignored. The format of each rule is
19904 .display
19905 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19906 .endd
19907 The following example contains two rules, each with a simple domain pattern and
19908 no options:
19909 .code
19910 route_list = \
19911   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19912   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19913 .endd
19914 The three parts of a rule are separated by white space. The pattern and the
19915 list of hosts can be enclosed in quotes if necessary, and if they are, the
19916 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19917 single domain pattern, which is the only mandatory item in the rule. The
19918 pattern is in the same format as one item in a domain list (see section
19919 &<<SECTdomainlist>>&),
19920 except that it may not be the name of an interpolated file.
19921 That is, it may be wildcarded, or a regular expression, or a file or database
19922 lookup (with semicolons doubled, because of the use of semicolon as a separator
19923 in a &%route_list%&).
19924
19925 The rules in &%route_list%& are searched in order until one of the patterns
19926 matches the domain that is being routed. The list of hosts and then options are
19927 then used as described below. If there is no match, the router declines. When
19928 &%route_list%& is set, &%route_data%& must not be set.
19929
19930
19931
19932 .section "Routing rules in route_data" "SECID121"
19933 The use of &%route_list%& is convenient when there are only a small number of
19934 routing rules. For larger numbers, it is easier to use a file or database to
19935 hold the routing information, and use the &%route_data%& option instead.
19936 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19937 Most commonly, &%route_data%& is set as a string that contains an
19938 expansion lookup. For example, suppose we place two routing rules in a file
19939 like this:
19940 .code
19941 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19942 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19943 .endd
19944 This data can be accessed by setting
19945 .code
19946 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19947 .endd
19948 Failure of the lookup results in an empty string, causing the router to
19949 decline. However, you do not have to use a lookup in &%route_data%&. The only
19950 requirement is that the result of expanding the string is a list of hosts,
19951 possibly followed by options, separated by white space. The list of hosts must
19952 be enclosed in quotes if it contains white space.
19953
19954
19955
19956
19957 .section "Format of the list of hosts" "SECID122"
19958 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19959 always separately expanded before use. If the expansion fails, the router
19960 declines. The result of the expansion must be a colon-separated list of names
19961 and/or IP addresses, optionally also including ports.
19962 If the list is written with spaces, it must be protected with quotes.
19963 The format of each item
19964 in the list is described in the next section. The list separator can be changed
19965 as described in section &<<SECTlistsepchange>>&.
19966
19967 If the list of hosts was obtained from a &%route_list%& item, the following
19968 variables are set during its expansion:
19969
19970 .ilist
19971 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19972 If the domain was matched against a regular expression, the numeric variables
19973 &$1$&, &$2$&, etc. may be set. For example:
19974 .code
19975 route_list = ^domain(\d+)   host-$1.text.example
19976 .endd
19977 .next
19978 &$0$& is always set to the entire domain.
19979 .next
19980 &$1$& is also set when partial matching is done in a file lookup.
19981
19982 .next
19983 .vindex "&$value$&"
19984 If the pattern that matched the domain was a lookup item, the data that was
19985 looked up is available in the expansion variable &$value$&. For example:
19986 .code
19987 route_list = lsearch;;/some/file.routes  $value
19988 .endd
19989 .endlist
19990
19991 Note the doubling of the semicolon in the pattern that is necessary because
19992 semicolon is the default route list separator.
19993
19994
19995
19996 .section "Format of one host item" "SECTformatonehostitem"
19997 Each item in the list of hosts is either a host name or an IP address,
19998 optionally with an attached port number. When no port is given, an IP address
19999 is not enclosed in brackets. When a port is specified, it overrides the port
20000 specification on the transport. The port is separated from the name or address
20001 by a colon. This leads to some complications:
20002
20003 .ilist
20004 Because colon is the default separator for the list of hosts, either
20005 the colon that specifies a port must be doubled, or the list separator must
20006 be changed. The following two examples have the same effect:
20007 .code
20008 route_list = * "host1.tld::1225 : host2.tld::1226"
20009 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20010 .endd
20011 .next
20012 When IPv6 addresses are involved, it gets worse, because they contain
20013 colons of their own. To make this case easier, it is permitted to
20014 enclose an IP address (either v4 or v6) in square brackets if a port
20015 number follows. For example:
20016 .code
20017 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20018 .endd
20019 .endlist
20020
20021 .section "How the list of hosts is used" "SECThostshowused"
20022 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20023 the hosts is tried, in the order specified, when carrying out the SMTP
20024 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20025 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20026 transport.
20027
20028 Hosts may be listed by name or by IP address. An unadorned name in the list of
20029 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20030 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20031 records in the DNS. For example:
20032 .code
20033 route_list = *  x.y.z:p.q.r/MX:e.f.g
20034 .endd
20035 If this feature is used with a port specifier, the port must come last. For
20036 example:
20037 .code
20038 route_list = *  dom1.tld/mx::1225
20039 .endd
20040 If the &%hosts_randomize%& option is set, the order of the items in the list is
20041 randomized before any lookups are done. Exim then scans the list; for any name
20042 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20043 be an interface on the local host and the item is not the first in the list,
20044 Exim discards it and any subsequent items. If it is the first item, what
20045 happens is controlled by the
20046 .oindex "&%self%&" "in &(manualroute)& router"
20047 &%self%& option of the router.
20048
20049 A name on the list that is followed by &`/MX`& is replaced with the list of
20050 hosts obtained by looking up MX records for the name. This is always a DNS
20051 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20052 below) are not relevant here. The order of these hosts is determined by the
20053 preference values in the MX records, according to the usual rules. Because
20054 randomizing happens before the MX lookup, it does not affect the order that is
20055 defined by MX preferences.
20056
20057 If the local host is present in the sublist obtained from MX records, but is
20058 not the most preferred host in that list, it and any equally or less
20059 preferred hosts are removed before the sublist is inserted into the main list.
20060
20061 If the local host is the most preferred host in the MX list, what happens
20062 depends on where in the original list of hosts the &`/MX`& item appears. If it
20063 is not the first item (that is, there are previous hosts in the main list),
20064 Exim discards this name and any subsequent items in the main list.
20065
20066 If the MX item is first in the list of hosts, and the local host is the
20067 most preferred host, what happens is controlled by the &%self%& option of the
20068 router.
20069
20070 DNS failures when lookup up the MX records are treated in the same way as DNS
20071 failures when looking up IP addresses: &%pass_on_timeout%& and
20072 &%host_find_failed%& are used when relevant.
20073
20074 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20075 whether obtained from an MX lookup or not.
20076
20077
20078
20079 .section "How the options are used" "SECThowoptused"
20080 The options are a sequence of words, space-separated.
20081 One of the words can be the name of a transport; this overrides the
20082 &%transport%& option on the router for this particular routing rule only. The
20083 other words (if present) control randomization of the list of hosts on a
20084 per-rule basis, and how the IP addresses of the hosts are to be found when
20085 routing to a remote transport. These options are as follows:
20086
20087 .ilist
20088 &%randomize%&: randomize the order of the hosts in this list, overriding the
20089 setting of &%hosts_randomize%& for this routing rule only.
20090 .next
20091 &%no_randomize%&: do not randomize the order of the hosts in this list,
20092 overriding the setting of &%hosts_randomize%& for this routing rule only.
20093 .next
20094 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20095 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20096 also look in &_/etc/hosts_& or other sources of information.
20097 .next
20098 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20099 no address records are found. If there is a temporary DNS error (such as a
20100 timeout), delivery is deferred.
20101 .next
20102 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20103 .next
20104 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20105 .endlist
20106
20107 For example:
20108 .code
20109 route_list = domain1  host1:host2:host3  randomize bydns;\
20110              domain2  host4:host5
20111 .endd
20112 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20113 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20114 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20115 or &[gethostbyname()]&, and the result of the lookup is the result of that
20116 call.
20117
20118 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20119 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20120 instead of TRY_AGAIN. That is why the default action is to try a DNS
20121 lookup first. Only if that gives a definite &"no such host"& is the local
20122 function called.
20123
20124 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20125 inadvertent constraint that a transport name as an option had to be the last
20126 option specified.
20127
20128
20129
20130 If no IP address for a host can be found, what happens is controlled by the
20131 &%host_find_failed%& option.
20132
20133 .vindex "&$host$&"
20134 When an address is routed to a local transport, IP addresses are not looked up.
20135 The host list is passed to the transport in the &$host$& variable.
20136
20137
20138
20139 .section "Manualroute examples" "SECID123"
20140 In some of the examples that follow, the presence of the &%remote_smtp%&
20141 transport, as defined in the default configuration file, is assumed:
20142
20143 .ilist
20144 .cindex "smart host" "example router"
20145 The &(manualroute)& router can be used to forward all external mail to a
20146 &'smart host'&. If you have set up, in the main part of the configuration, a
20147 named domain list that contains your local domains, for example:
20148 .code
20149 domainlist local_domains = my.domain.example
20150 .endd
20151 You can arrange for all other domains to be routed to a smart host by making
20152 your first router something like this:
20153 .code
20154 smart_route:
20155   driver = manualroute
20156   domains = !+local_domains
20157   transport = remote_smtp
20158   route_list = * smarthost.ref.example
20159 .endd
20160 This causes all non-local addresses to be sent to the single host
20161 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20162 they are tried in order
20163 (but you can use &%hosts_randomize%& to vary the order each time).
20164 Another way of configuring the same thing is this:
20165 .code
20166 smart_route:
20167   driver = manualroute
20168   transport = remote_smtp
20169   route_list = !+local_domains  smarthost.ref.example
20170 .endd
20171 There is no difference in behaviour between these two routers as they stand.
20172 However, they behave differently if &%no_more%& is added to them. In the first
20173 example, the router is skipped if the domain does not match the &%domains%&
20174 precondition; the following router is always tried. If the router runs, it
20175 always matches the domain and so can never decline. Therefore, &%no_more%&
20176 would have no effect. In the second case, the router is never skipped; it
20177 always runs. However, if it doesn't match the domain, it declines. In this case
20178 &%no_more%& would prevent subsequent routers from running.
20179
20180 .next
20181 .cindex "mail hub example"
20182 A &'mail hub'& is a host which receives mail for a number of domains via MX
20183 records in the DNS and delivers it via its own private routing mechanism. Often
20184 the final destinations are behind a firewall, with the mail hub being the one
20185 machine that can connect to machines both inside and outside the firewall. The
20186 &(manualroute)& router is usually used on a mail hub to route incoming messages
20187 to the correct hosts. For a small number of domains, the routing can be inline,
20188 using the &%route_list%& option, but for a larger number a file or database
20189 lookup is easier to manage.
20190
20191 If the domain names are in fact the names of the machines to which the mail is
20192 to be sent by the mail hub, the configuration can be quite simple. For
20193 example:
20194 .code
20195 hub_route:
20196   driver = manualroute
20197   transport = remote_smtp
20198   route_list = *.rhodes.tvs.example  $domain
20199 .endd
20200 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20201 whose names are the same as the mail domains. A similar approach can be taken
20202 if the host name can be obtained from the domain name by a string manipulation
20203 that the expansion facilities can handle. Otherwise, a lookup based on the
20204 domain can be used to find the host:
20205 .code
20206 through_firewall:
20207   driver = manualroute
20208   transport = remote_smtp
20209   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20210 .endd
20211 The result of the lookup must be the name or IP address of the host (or
20212 hosts) to which the address is to be routed. If the lookup fails, the route
20213 data is empty, causing the router to decline. The address then passes to the
20214 next router.
20215
20216 .next
20217 .cindex "batched SMTP output example"
20218 .cindex "SMTP" "batched outgoing; example"
20219 You can use &(manualroute)& to deliver messages to pipes or files in batched
20220 SMTP format for onward transportation by some other means. This is one way of
20221 storing mail for a dial-up host when it is not connected. The route list entry
20222 can be as simple as a single domain name in a configuration like this:
20223 .code
20224 save_in_file:
20225   driver = manualroute
20226   transport = batchsmtp_appendfile
20227   route_list = saved.domain.example
20228 .endd
20229 though often a pattern is used to pick up more than one domain. If there are
20230 several domains or groups of domains with different transport requirements,
20231 different transports can be listed in the routing information:
20232 .code
20233 save_in_file:
20234   driver = manualroute
20235   route_list = \
20236     *.saved.domain1.example  $domain  batch_appendfile; \
20237     *.saved.domain2.example  \
20238       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20239       batch_pipe
20240 .endd
20241 .vindex "&$domain$&"
20242 .vindex "&$host$&"
20243 The first of these just passes the domain in the &$host$& variable, which
20244 doesn't achieve much (since it is also in &$domain$&), but the second does a
20245 file lookup to find a value to pass, causing the router to decline to handle
20246 the address if the lookup fails.
20247
20248 .next
20249 .cindex "UUCP" "example of router for"
20250 Routing mail directly to UUCP software is a specific case of the use of
20251 &(manualroute)& in a gateway to another mail environment. This is an example of
20252 one way it can be done:
20253 .code
20254 # Transport
20255 uucp:
20256   driver = pipe
20257   user = nobody
20258   command = /usr/local/bin/uux -r - \
20259     ${substr_-5:$host}!rmail ${local_part}
20260   return_fail_output = true
20261
20262 # Router
20263 uucphost:
20264   transport = uucp
20265   driver = manualroute
20266   route_data = \
20267     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20268 .endd
20269 The file &_/usr/local/exim/uucphosts_& contains entries like
20270 .code
20271 darksite.ethereal.example:           darksite.UUCP
20272 .endd
20273 It can be set up more simply without adding and removing &".UUCP"& but this way
20274 makes clear the distinction between the domain name
20275 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20276 .endlist
20277 .ecindex IIDmanrou1
20278 .ecindex IIDmanrou2
20279
20280
20281
20282
20283
20284
20285
20286
20287 . ////////////////////////////////////////////////////////////////////////////
20288 . ////////////////////////////////////////////////////////////////////////////
20289
20290 .chapter "The queryprogram router" "CHAPdriverlast"
20291 .scindex IIDquerou1 "&(queryprogram)& router"
20292 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20293 .cindex "routing" "by external program"
20294 The &(queryprogram)& router routes an address by running an external command
20295 and acting on its output. This is an expensive way to route, and is intended
20296 mainly for use in lightly-loaded systems, or for performing experiments.
20297 However, if it is possible to use the precondition options (&%domains%&,
20298 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20299 be used in special cases, even on a busy host. There are the following private
20300 options:
20301 .cindex "options" "&(queryprogram)& router"
20302
20303 .option command queryprogram string&!! unset
20304 This option must be set. It specifies the command that is to be run. The
20305 command is split up into a command name and arguments, and then each is
20306 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20307 &<<CHAPpipetransport>>&).
20308
20309
20310 .option command_group queryprogram string unset
20311 .cindex "gid (group id)" "in &(queryprogram)& router"
20312 This option specifies a gid to be set when running the command while routing an
20313 address for deliver. It must be set if &%command_user%& specifies a numerical
20314 uid. If it begins with a digit, it is interpreted as the numerical value of the
20315 gid. Otherwise it is looked up using &[getgrnam()]&.
20316
20317
20318 .option command_user queryprogram string unset
20319 .cindex "uid (user id)" "for &(queryprogram)&"
20320 This option must be set. It specifies the uid which is set when running the
20321 command while routing an address for delivery. If the value begins with a digit,
20322 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20323 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20324 not set, a value for the gid also.
20325
20326 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20327 root, which it does during a normal delivery in a conventional configuration.
20328 However, when an address is being verified during message reception, Exim is
20329 usually running as the Exim user, not as root. If the &(queryprogram)& router
20330 is called from a non-root process, Exim cannot change uid or gid before running
20331 the command. In this circumstance the command runs under the current uid and
20332 gid.
20333
20334
20335 .option current_directory queryprogram string /
20336 This option specifies an absolute path which is made the current directory
20337 before running the command.
20338
20339
20340 .option timeout queryprogram time 1h
20341 If the command does not complete within the timeout period, its process group
20342 is killed and the message is frozen. A value of zero time specifies no
20343 timeout.
20344
20345
20346 The standard output of the command is connected to a pipe, which is read when
20347 the command terminates. It should consist of a single line of output,
20348 containing up to five fields, separated by white space. The maximum length of
20349 the line is 1023 characters. Longer lines are silently truncated. The first
20350 field is one of the following words (case-insensitive):
20351
20352 .ilist
20353 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20354 below).
20355 .next
20356 &'Decline'&: the router declines; pass the address to the next router, unless
20357 &%no_more%& is set.
20358 .next
20359 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20360 subsequent text on the line is an error message. If the router is run as part
20361 of address verification during an incoming SMTP message, the message is
20362 included in the SMTP response.
20363 .next
20364 &'Defer'&: routing could not be completed at this time; try again later. Any
20365 subsequent text on the line is an error message which is logged. It is not
20366 included in any SMTP response.
20367 .next
20368 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20369 .next
20370 &'Pass'&: pass the address to the next router (or the router specified by
20371 &%pass_router%&), overriding &%no_more%&.
20372 .next
20373 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20374 new addresses, which are routed independently, starting with the first router,
20375 or the router specified by &%redirect_router%&, if set.
20376 .endlist
20377
20378 When the first word is &'accept'&, the remainder of the line consists of a
20379 number of keyed data values, as follows (split into two lines here, to fit on
20380 the page):
20381 .code
20382 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20383 LOOKUP=byname|bydns DATA=<text>
20384 .endd
20385 The data items can be given in any order, and all are optional. If no transport
20386 is included, the transport specified by the generic &%transport%& option is
20387 used. The list of hosts and the lookup type are needed only if the transport is
20388 an &(smtp)& transport that does not itself supply a list of hosts.
20389
20390 The format of the list of hosts is the same as for the &(manualroute)& router.
20391 As well as host names and IP addresses with optional port numbers, as described
20392 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20393 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20394 (see section &<<SECThostshowused>>&).
20395
20396 If the lookup type is not specified, Exim behaves as follows when trying to
20397 find an IP address for each host: First, a DNS lookup is done. If this yields
20398 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20399 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20400 result of the lookup is the result of that call.
20401
20402 .vindex "&$address_data$&"
20403 If the DATA field is set, its value is placed in the &$address_data$&
20404 variable. For example, this return line
20405 .code
20406 accept hosts=x1.y.example:x2.y.example data="rule1"
20407 .endd
20408 routes the address to the default transport, passing a list of two hosts. When
20409 the transport runs, the string &"rule1"& is in &$address_data$&.
20410 .ecindex IIDquerou1
20411 .ecindex IIDquerou2
20412
20413
20414
20415
20416 . ////////////////////////////////////////////////////////////////////////////
20417 . ////////////////////////////////////////////////////////////////////////////
20418
20419 .chapter "The redirect router" "CHAPredirect"
20420 .scindex IIDredrou1 "&(redirect)& router"
20421 .scindex IIDredrou2 "routers" "&(redirect)&"
20422 .cindex "alias file" "in a &(redirect)& router"
20423 .cindex "address redirection" "&(redirect)& router"
20424 The &(redirect)& router handles several kinds of address redirection. Its most
20425 common uses are for resolving local part aliases from a central alias file
20426 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20427 files, but it has many other potential uses. The incoming address can be
20428 redirected in several different ways:
20429
20430 .ilist
20431 It can be replaced by one or more new addresses which are themselves routed
20432 independently.
20433 .next
20434 It can be routed to be delivered to a given file or directory.
20435 .next
20436 It can be routed to be delivered to a specified pipe command.
20437 .next
20438 It can cause an automatic reply to be generated.
20439 .next
20440 It can be forced to fail, optionally with a custom error message.
20441 .next
20442 It can be temporarily deferred, optionally with a custom message.
20443 .next
20444 It can be discarded.
20445 .endlist
20446
20447 The generic &%transport%& option must not be set for &(redirect)& routers.
20448 However, there are some private options which define transports for delivery to
20449 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20450 &%pipe_transport%& and &%reply_transport%& descriptions below.
20451
20452 If success DSNs have been requested
20453 .cindex "DSN" "success"
20454 .cindex "Delivery Status Notification" "success"
20455 redirection triggers one and the DSN options are not passed any further.
20456
20457
20458
20459 .section "Redirection data" "SECID124"
20460 The router operates by interpreting a text string which it obtains either by
20461 expanding the contents of the &%data%& option, or by reading the entire
20462 contents of a file whose name is given in the &%file%& option. These two
20463 options are mutually exclusive. The first is commonly used for handling system
20464 aliases, in a configuration like this:
20465 .code
20466 system_aliases:
20467   driver = redirect
20468   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20469 .endd
20470 If the lookup fails, the expanded string in this example is empty. When the
20471 expansion of &%data%& results in an empty string, the router declines. A forced
20472 expansion failure also causes the router to decline; other expansion failures
20473 cause delivery to be deferred.
20474
20475 A configuration using &%file%& is commonly used for handling users'
20476 &_.forward_& files, like this:
20477 .code
20478 userforward:
20479   driver = redirect
20480   check_local_user
20481   file = $home/.forward
20482   no_verify
20483 .endd
20484 If the file does not exist, or causes no action to be taken (for example, it is
20485 empty or consists only of comments), the router declines. &*Warning*&: This
20486 is not the case when the file contains syntactically valid items that happen to
20487 yield empty addresses, for example, items containing only RFC 2822 address
20488 comments.
20489
20490
20491
20492 .section "Forward files and address verification" "SECID125"
20493 .cindex "address redirection" "while verifying"
20494 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20495 &_.forward_& files, as in the example above. There are two reasons for this:
20496
20497 .ilist
20498 When Exim is receiving an incoming SMTP message from a remote host, it is
20499 running under the Exim uid, not as root. Exim is unable to change uid to read
20500 the file as the user, and it may not be able to read it as the Exim user. So in
20501 practice the router may not be able to operate.
20502 .next
20503 However, even when the router can operate, the existence of a &_.forward_& file
20504 is unimportant when verifying an address. What should be checked is whether the
20505 local part is a valid user name or not. Cutting out the redirection processing
20506 saves some resources.
20507 .endlist
20508
20509
20510
20511
20512
20513
20514 .section "Interpreting redirection data" "SECID126"
20515 .cindex "Sieve filter" "specifying in redirection data"
20516 .cindex "filter" "specifying in redirection data"
20517 The contents of the data string, whether obtained from &%data%& or &%file%&,
20518 can be interpreted in two different ways:
20519
20520 .ilist
20521 If the &%allow_filter%& option is set true, and the data begins with the text
20522 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20523 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20524 respectively. Details of the syntax and semantics of filter files are described
20525 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20526 document is intended for use by end users.
20527 .next
20528 Otherwise, the data must be a comma-separated list of redirection items, as
20529 described in the next section.
20530 .endlist
20531
20532 When a message is redirected to a file (a &"mail folder"&), the filename given
20533 in a non-filter redirection list must always be an absolute path. A filter may
20534 generate a relative path &-- how this is handled depends on the transport's
20535 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20536 for the &(appendfile)& transport.
20537
20538
20539
20540 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20541 .cindex "address redirection" "non-filter list items"
20542 When the redirection data is not an Exim or Sieve filter, for example, if it
20543 comes from a conventional alias or forward file, it consists of a list of
20544 addresses, filenames, pipe commands, or certain special items (see section
20545 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20546 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20547 depending on their default values. The items in the list are separated by
20548 commas or newlines.
20549 If a comma is required in an item, the entire item must be enclosed in double
20550 quotes.
20551
20552 Lines starting with a # character are comments, and are ignored, and # may
20553 also appear following a comma, in which case everything between the # and the
20554 next newline character is ignored.
20555
20556 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20557 double quotes are retained because some forms of mail address require their use
20558 (but never to enclose the entire address). In the following description,
20559 &"item"& refers to what remains after any surrounding double quotes have been
20560 removed.
20561
20562 .vindex "&$local_part$&"
20563 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20564 and the expansion contains a reference to &$local_part$&, you should make use
20565 of the &%quote_local_part%& expansion operator, in case the local part contains
20566 special characters. For example, to redirect all mail for the domain
20567 &'obsolete.example'&, retaining the existing local part, you could use this
20568 setting:
20569 .code
20570 data = ${quote_local_part:$local_part}@newdomain.example
20571 .endd
20572
20573
20574 .section "Redirecting to a local mailbox" "SECTredlocmai"
20575 .cindex "routing" "loops in"
20576 .cindex "loop" "while routing, avoidance of"
20577 .cindex "address redirection" "to local mailbox"
20578 A redirection item may safely be the same as the address currently under
20579 consideration. This does not cause a routing loop, because a router is
20580 automatically skipped if any ancestor of the address that is being processed
20581 is the same as the current address and was processed by the current router.
20582 Such an address is therefore passed to the following routers, so it is handled
20583 as if there were no redirection. When making this loop-avoidance test, the
20584 complete local part, including any prefix or suffix, is used.
20585
20586 .cindex "address redirection" "local part without domain"
20587 Specifying the same local part without a domain is a common usage in personal
20588 filter files when the user wants to have messages delivered to the local
20589 mailbox and also forwarded elsewhere. For example, the user whose login is
20590 &'cleo'& might have a &_.forward_& file containing this:
20591 .code
20592 cleo, cleopatra@egypt.example
20593 .endd
20594 .cindex "backslash in alias file"
20595 .cindex "alias file" "backslash in"
20596 For compatibility with other MTAs, such unqualified local parts may be
20597 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20598 it does make a difference if more than one domain is being handled
20599 synonymously.
20600
20601 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20602 2822 address that does not include a domain, the item is qualified using the
20603 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20604 addresses are qualified using the value in &%qualify_recipient%&, but you can
20605 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20606
20607 Care must be taken if there are alias names for local users.
20608 Consider an MTA handling a single local domain where the system alias file
20609 contains:
20610 .code
20611 Sam.Reman: spqr
20612 .endd
20613 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20614 messages in the local mailbox, and also forward copies elsewhere. He creates
20615 this forward file:
20616 .code
20617 Sam.Reman, spqr@reme.elsewhere.example
20618 .endd
20619 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20620 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20621 second time round, because it has previously routed it,
20622 and the following routers presumably cannot handle the alias. The forward file
20623 should really contain
20624 .code
20625 spqr, spqr@reme.elsewhere.example
20626 .endd
20627 but because this is such a common error, the &%check_ancestor%& option (see
20628 below) exists to provide a way to get round it. This is normally set on a
20629 &(redirect)& router that is handling users' &_.forward_& files.
20630
20631
20632
20633 .section "Special items in redirection lists" "SECTspecitredli"
20634 In addition to addresses, the following types of item may appear in redirection
20635 lists (that is, in non-filter redirection data):
20636
20637 .ilist
20638 .cindex "pipe" "in redirection list"
20639 .cindex "address redirection" "to pipe"
20640 An item is treated as a pipe command if it begins with &"|"& and does not parse
20641 as a valid RFC 2822 address that includes a domain. A transport for running the
20642 command must be specified by the &%pipe_transport%& option.
20643 Normally, either the router or the transport specifies a user and a group under
20644 which to run the delivery. The default is to use the Exim user and group.
20645
20646 Single or double quotes can be used for enclosing the individual arguments of
20647 the pipe command; no interpretation of escapes is done for single quotes. If
20648 the command contains a comma character, it is necessary to put the whole item
20649 in double quotes, for example:
20650 .code
20651 "|/some/command ready,steady,go"
20652 .endd
20653 since items in redirection lists are terminated by commas. Do not, however,
20654 quote just the command. An item such as
20655 .code
20656 |"/some/command ready,steady,go"
20657 .endd
20658 is interpreted as a pipe with a rather strange command name, and no arguments.
20659
20660 Note that the above example assumes that the text comes from a lookup source
20661 of some sort, so that the quotes are part of the data.  If composing a
20662 redirect router with a &%data%& option directly specifying this command, the
20663 quotes will be used by the configuration parser to define the extent of one
20664 string, but will not be passed down into the redirect router itself.  There
20665 are two main approaches to get around this: escape quotes to be part of the
20666 data itself, or avoid using this mechanism and instead create a custom
20667 transport with the &%command%& option set and reference that transport from
20668 an &%accept%& router.
20669
20670 .next
20671 .cindex "file" "in redirection list"
20672 .cindex "address redirection" "to file"
20673 An item is interpreted as a path name if it begins with &"/"& and does not
20674 parse as a valid RFC 2822 address that includes a domain. For example,
20675 .code
20676 /home/world/minbari
20677 .endd
20678 is treated as a filename, but
20679 .code
20680 /s=molari/o=babylon/@x400gate.way
20681 .endd
20682 is treated as an address. For a filename, a transport must be specified using
20683 the &%file_transport%& option. However, if the generated path name ends with a
20684 forward slash character, it is interpreted as a directory name rather than a
20685 filename, and &%directory_transport%& is used instead.
20686
20687 Normally, either the router or the transport specifies a user and a group under
20688 which to run the delivery. The default is to use the Exim user and group.
20689
20690 .cindex "&_/dev/null_&"
20691 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20692 bypassed at a high level, and the log entry shows &"**bypassed**"&
20693 instead of a transport name. In this case the user and group are not used.
20694
20695 .next
20696 .cindex "included address list"
20697 .cindex "address redirection" "included external list"
20698 If an item is of the form
20699 .code
20700 :include:<path name>
20701 .endd
20702 a list of further items is taken from the given file and included at that
20703 point. &*Note*&: Such a file can not be a filter file; it is just an
20704 out-of-line addition to the list. The items in the included list are separated
20705 by commas or newlines and are not subject to expansion. If this is the first
20706 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20707 the alias name. This example is incorrect:
20708 .code
20709 list1    :include:/opt/lists/list1
20710 .endd
20711 It must be given as
20712 .code
20713 list1:   :include:/opt/lists/list1
20714 .endd
20715 .next
20716 .cindex "address redirection" "to black hole"
20717 .cindex "delivery" "discard"
20718 .cindex "delivery" "blackhole"
20719 .cindex "black hole"
20720 .cindex "abandoning mail"
20721 Sometimes you want to throw away mail to a particular local part.  Making the
20722 &%data%& option expand to an empty string does not work, because that causes
20723 the router to decline. Instead, the alias item
20724 .code
20725 :blackhole:
20726 .endd
20727 can be used. It does what its name implies. No delivery is
20728 done, and no error message is generated. This has the same effect as specifying
20729 &_/dev/null_& as a destination, but it can be independently disabled.
20730
20731 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20732 delivery is done for the original local part, even if other redirection items
20733 are present. If you are generating a multi-item list (for example, by reading a
20734 database) and need the ability to provide a no-op item, you must use
20735 &_/dev/null_&.
20736
20737 .next
20738 .cindex "delivery" "forcing failure"
20739 .cindex "delivery" "forcing deferral"
20740 .cindex "failing delivery" "forcing"
20741 .cindex "deferred delivery, forcing"
20742 .cindex "customizing" "failure message"
20743 An attempt to deliver a particular address can be deferred or forced to fail by
20744 redirection items of the form
20745 .code
20746 :defer:
20747 :fail:
20748 .endd
20749 respectively. When a redirection list contains such an item, it applies
20750 to the entire redirection; any other items in the list are ignored. Any
20751 text following &':fail:'& or &':defer:'& is placed in the error text
20752 associated with the failure. For example, an alias file might contain:
20753 .code
20754 X.Employee:  :fail: Gone away, no forwarding address
20755 .endd
20756 In the case of an address that is being verified from an ACL or as the subject
20757 of a
20758 .cindex "VRFY" "error text, display of"
20759 VRFY command, the text is included in the SMTP error response by
20760 default.
20761 .cindex "EXPN" "error text, display of"
20762 The text is not included in the response to an EXPN command. In non-SMTP cases
20763 the text is included in the error message that Exim generates.
20764
20765 .cindex "SMTP" "error codes"
20766 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20767 &':fail:'&. However, if the message starts with three digits followed by a
20768 space, optionally followed by an extended code of the form &'n.n.n'&, also
20769 followed by a space, and the very first digit is the same as the default error
20770 code, the code from the message is used instead. If the very first digit is
20771 incorrect, a panic error is logged, and the default code is used. You can
20772 suppress the use of the supplied code in a redirect router by setting the
20773 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20774 ignored.
20775
20776 .vindex "&$acl_verify_message$&"
20777 In an ACL, an explicitly provided message overrides the default, but the
20778 default message is available in the variable &$acl_verify_message$& and can
20779 therefore be included in a custom message if this is desired.
20780
20781 Normally the error text is the rest of the redirection list &-- a comma does
20782 not terminate it &-- but a newline does act as a terminator. Newlines are not
20783 normally present in alias expansions. In &(lsearch)& lookups they are removed
20784 as part of the continuation process, but they may exist in other kinds of
20785 lookup and in &':include:'& files.
20786
20787 During routing for message delivery (as opposed to verification), a redirection
20788 containing &':fail:'& causes an immediate failure of the incoming address,
20789 whereas &':defer:'& causes the message to remain in the queue so that a
20790 subsequent delivery attempt can happen at a later time. If an address is
20791 deferred for too long, it will ultimately fail, because the normal retry
20792 rules still apply.
20793
20794 .next
20795 .cindex "alias file" "exception to default"
20796 Sometimes it is useful to use a single-key search type with a default (see
20797 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20798 for exceptions to the default. These can be handled by aliasing them to
20799 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20800 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20801 results in an empty redirection list has the same effect.
20802 .endlist
20803
20804
20805 .section "Duplicate addresses" "SECTdupaddr"
20806 .cindex "duplicate addresses"
20807 .cindex "address duplicate, discarding"
20808 .cindex "pipe" "duplicated"
20809 Exim removes duplicate addresses from the list to which it is delivering, so as
20810 to deliver just one copy to each address. This does not apply to deliveries
20811 routed to pipes by different immediate parent addresses, but an indirect
20812 aliasing scheme of the type
20813 .code
20814 pipe:       |/some/command $local_part
20815 localpart1: pipe
20816 localpart2: pipe
20817 .endd
20818 does not work with a message that is addressed to both local parts, because
20819 when the second is aliased to the intermediate local part &"pipe"& it gets
20820 discarded as being the same as a previously handled address. However, a scheme
20821 such as
20822 .code
20823 localpart1: |/some/command $local_part
20824 localpart2: |/some/command $local_part
20825 .endd
20826 does result in two different pipe deliveries, because the immediate parents of
20827 the pipes are distinct.
20828
20829
20830
20831 .section "Repeated redirection expansion" "SECID128"
20832 .cindex "repeated redirection expansion"
20833 .cindex "address redirection" "repeated for each delivery attempt"
20834 When a message cannot be delivered to all of its recipients immediately,
20835 leading to two or more delivery attempts, redirection expansion is carried out
20836 afresh each time for those addresses whose children were not all previously
20837 delivered. If redirection is being used as a mailing list, this can lead to new
20838 members of the list receiving copies of old messages. The &%one_time%& option
20839 can be used to avoid this.
20840
20841
20842 .section "Errors in redirection lists" "SECID129"
20843 .cindex "address redirection" "errors"
20844 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20845 error is skipped, and an entry is written to the main log. This may be useful
20846 for mailing lists that are automatically managed. Otherwise, if an error is
20847 detected while generating the list of new addresses, the original address is
20848 deferred. See also &%syntax_errors_to%&.
20849
20850
20851
20852 .section "Private options for the redirect router" "SECID130"
20853
20854 .cindex "options" "&(redirect)& router"
20855 The private options for the &(redirect)& router are as follows:
20856
20857
20858 .option allow_defer redirect boolean false
20859 Setting this option allows the use of &':defer:'& in non-filter redirection
20860 data, or the &%defer%& command in an Exim filter file.
20861
20862
20863 .option allow_fail redirect boolean false
20864 .cindex "failing delivery" "from filter"
20865 If this option is true, the &':fail:'& item can be used in a redirection list,
20866 and the &%fail%& command may be used in an Exim filter file.
20867
20868
20869 .option allow_filter redirect boolean false
20870 .cindex "filter" "enabling use of"
20871 .cindex "Sieve filter" "enabling use of"
20872 Setting this option allows Exim to interpret redirection data that starts with
20873 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20874 are some features of Exim filter files that some administrators may wish to
20875 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20876
20877 It is also possible to lock out Exim filters or Sieve filters while allowing
20878 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20879
20880
20881 The filter is run using the uid and gid set by the generic &%user%& and
20882 &%group%& options. These take their defaults from the password data if
20883 &%check_local_user%& is set, so in the normal case of users' personal filter
20884 files, the filter is run as the relevant user. When &%allow_filter%& is set
20885 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20886
20887
20888
20889 .option allow_freeze redirect boolean false
20890 .cindex "freezing messages" "allowing in filter"
20891 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20892 This command is more normally encountered in system filters, and is disabled by
20893 default for redirection filters because it isn't something you usually want to
20894 let ordinary users do.
20895
20896
20897
20898 .option check_ancestor redirect boolean false
20899 This option is concerned with handling generated addresses that are the same
20900 as some address in the list of redirection ancestors of the current address.
20901 Although it is turned off by default in the code, it is set in the default
20902 configuration file for handling users' &_.forward_& files. It is recommended
20903 for this use of the &(redirect)& router.
20904
20905 When &%check_ancestor%& is set, if a generated address (including the domain)
20906 is the same as any ancestor of the current address, it is replaced by a copy of
20907 the current address. This helps in the case where local part A is aliased to B,
20908 and B has a &_.forward_& file pointing back to A. For example, within a single
20909 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20910 &_&~jb/.forward_& contains:
20911 .code
20912 \Joe.Bloggs, <other item(s)>
20913 .endd
20914 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20915 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20916 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20917 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20918 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20919 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20920 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20921 original address. See also the &%repeat_use%& option below.
20922
20923
20924 .option check_group redirect boolean "see below"
20925 When the &%file%& option is used, the group owner of the file is checked only
20926 when this option is set. The permitted groups are those listed in the
20927 &%owngroups%& option, together with the user's default group if
20928 &%check_local_user%& is set. If the file has the wrong group, routing is
20929 deferred. The default setting for this option is true if &%check_local_user%&
20930 is set and the &%modemask%& option permits the group write bit, or if the
20931 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20932
20933
20934
20935 .option check_owner redirect boolean "see below"
20936 When the &%file%& option is used, the owner of the file is checked only when
20937 this option is set. If &%check_local_user%& is set, the local user is
20938 permitted; otherwise the owner must be one of those listed in the &%owners%&
20939 option. The default value for this option is true if &%check_local_user%& or
20940 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20941
20942
20943 .option data redirect string&!! unset
20944 This option is mutually exclusive with &%file%&. One or other of them must be
20945 set, but not both. The contents of &%data%& are expanded, and then used as the
20946 list of forwarding items, or as a set of filtering instructions. If the
20947 expansion is forced to fail, or the result is an empty string or a string that
20948 has no effect (consists entirely of comments), the router declines.
20949
20950 When filtering instructions are used, the string must begin with &"#Exim
20951 filter"&, and all comments in the string, including this initial one, must be
20952 terminated with newline characters. For example:
20953 .code
20954 data = #Exim filter\n\
20955        if $h_to: contains Exim then save $home/mail/exim endif
20956 .endd
20957 If you are reading the data from a database where newlines cannot be included,
20958 you can use the &${sg}$& expansion item to turn the escape string of your
20959 choice into a newline.
20960
20961
20962 .option directory_transport redirect string&!! unset
20963 A &(redirect)& router sets up a direct delivery to a directory when a path name
20964 ending with a slash is specified as a new &"address"&. The transport used is
20965 specified by this option, which, after expansion, must be the name of a
20966 configured transport. This should normally be an &(appendfile)& transport.
20967
20968
20969 .option file redirect string&!! unset
20970 This option specifies the name of a file that contains the redirection data. It
20971 is mutually exclusive with the &%data%& option. The string is expanded before
20972 use; if the expansion is forced to fail, the router declines. Other expansion
20973 failures cause delivery to be deferred. The result of a successful expansion
20974 must be an absolute path. The entire file is read and used as the redirection
20975 data. If the data is an empty string or a string that has no effect (consists
20976 entirely of comments), the router declines.
20977
20978 .cindex "NFS" "checking for file existence"
20979 If the attempt to open the file fails with a &"does not exist"& error, Exim
20980 runs a check on the containing directory,
20981 unless &%ignore_enotdir%& is true (see below).
20982 If the directory does not appear to exist, delivery is deferred. This can
20983 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20984 is a mount problem. If the containing directory does exist, but the file does
20985 not, the router declines.
20986
20987
20988 .option file_transport redirect string&!! unset
20989 .vindex "&$address_file$&"
20990 A &(redirect)& router sets up a direct delivery to a file when a path name not
20991 ending in a slash is specified as a new &"address"&. The transport used is
20992 specified by this option, which, after expansion, must be the name of a
20993 configured transport. This should normally be an &(appendfile)& transport. When
20994 it is running, the filename is in &$address_file$&.
20995
20996
20997 .option filter_prepend_home redirect boolean true
20998 When this option is true, if a &(save)& command in an Exim filter specifies a
20999 relative path, and &$home$& is defined, it is automatically prepended to the
21000 relative path. If this option is set false, this action does not happen. The
21001 relative path is then passed to the transport unmodified.
21002
21003
21004 .option forbid_blackhole redirect boolean false
21005 .cindex "restricting access to features"
21006 .cindex "filter" "locking out certain features"
21007 If this option is true, the &':blackhole:'& item may not appear in a
21008 redirection list.
21009
21010
21011 .option forbid_exim_filter redirect boolean false
21012 .cindex "restricting access to features"
21013 .cindex "filter" "locking out certain features"
21014 If this option is set true, only Sieve filters are permitted when
21015 &%allow_filter%& is true.
21016
21017
21018
21019
21020 .option forbid_file redirect boolean false
21021 .cindex "restricting access to features"
21022 .cindex "delivery" "to file; forbidding"
21023 .cindex "filter" "locking out certain features"
21024 .cindex "Sieve filter" "forbidding delivery to a file"
21025 .cindex "Sieve filter" "&""keep""& facility; disabling"
21026 If this option is true, this router may not generate a new address that
21027 specifies delivery to a local file or directory, either from a filter or from a
21028 conventional forward file. This option is forced to be true if &%one_time%& is
21029 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21030 locks out the Sieve's &"keep"& facility.
21031
21032
21033 .option forbid_filter_dlfunc redirect boolean false
21034 .cindex "restricting access to features"
21035 .cindex "filter" "locking out certain features"
21036 If this option is true, string expansions in Exim filters are not allowed to
21037 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21038 functions.
21039
21040 .option forbid_filter_existstest redirect boolean false
21041 .cindex "restricting access to features"
21042 .cindex "filter" "locking out certain features"
21043 .cindex "expansion" "statting a file"
21044 If this option is true, string expansions in Exim filters are not allowed to
21045 make use of the &%exists%& condition or the &%stat%& expansion item.
21046
21047 .option forbid_filter_logwrite redirect boolean false
21048 .cindex "restricting access to features"
21049 .cindex "filter" "locking out certain features"
21050 If this option is true, use of the logging facility in Exim filters is not
21051 permitted. Logging is in any case available only if the filter is being run
21052 under some unprivileged uid (which is normally the case for ordinary users'
21053 &_.forward_& files).
21054
21055
21056 .option forbid_filter_lookup redirect boolean false
21057 .cindex "restricting access to features"
21058 .cindex "filter" "locking out certain features"
21059 If this option is true, string expansions in Exim filter files are not allowed
21060 to make use of &%lookup%& items.
21061
21062
21063 .option forbid_filter_perl redirect boolean false
21064 .cindex "restricting access to features"
21065 .cindex "filter" "locking out certain features"
21066 This option has an effect only if Exim is built with embedded Perl support. If
21067 it is true, string expansions in Exim filter files are not allowed to make use
21068 of the embedded Perl support.
21069
21070
21071 .option forbid_filter_readfile redirect boolean false
21072 .cindex "restricting access to features"
21073 .cindex "filter" "locking out certain features"
21074 If this option is true, string expansions in Exim filter files are not allowed
21075 to make use of &%readfile%& items.
21076
21077
21078 .option forbid_filter_readsocket redirect boolean false
21079 .cindex "restricting access to features"
21080 .cindex "filter" "locking out certain features"
21081 If this option is true, string expansions in Exim filter files are not allowed
21082 to make use of &%readsocket%& items.
21083
21084
21085 .option forbid_filter_reply redirect boolean false
21086 .cindex "restricting access to features"
21087 .cindex "filter" "locking out certain features"
21088 If this option is true, this router may not generate an automatic reply
21089 message. Automatic replies can be generated only from Exim or Sieve filter
21090 files, not from traditional forward files. This option is forced to be true if
21091 &%one_time%& is set.
21092
21093
21094 .option forbid_filter_run redirect boolean false
21095 .cindex "restricting access to features"
21096 .cindex "filter" "locking out certain features"
21097 If this option is true, string expansions in Exim filter files are not allowed
21098 to make use of &%run%& items.
21099
21100
21101 .option forbid_include redirect boolean false
21102 .cindex "restricting access to features"
21103 .cindex "filter" "locking out certain features"
21104 If this option is true, items of the form
21105 .code
21106 :include:<path name>
21107 .endd
21108 are not permitted in non-filter redirection lists.
21109
21110
21111 .option forbid_pipe redirect boolean false
21112 .cindex "restricting access to features"
21113 .cindex "filter" "locking out certain features"
21114 .cindex "delivery" "to pipe; forbidding"
21115 If this option is true, this router may not generate a new address which
21116 specifies delivery to a pipe, either from an Exim filter or from a conventional
21117 forward file. This option is forced to be true if &%one_time%& is set.
21118
21119
21120 .option forbid_sieve_filter redirect boolean false
21121 .cindex "restricting access to features"
21122 .cindex "filter" "locking out certain features"
21123 If this option is set true, only Exim filters are permitted when
21124 &%allow_filter%& is true.
21125
21126
21127 .cindex "SMTP" "error codes"
21128 .option forbid_smtp_code redirect boolean false
21129 If this option is set true, any SMTP error codes that are present at the start
21130 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21131 the default codes (451 and 550, respectively) are always used.
21132
21133
21134
21135
21136 .option hide_child_in_errmsg redirect boolean false
21137 .cindex "bounce message" "redirection details; suppressing"
21138 If this option is true, it prevents Exim from quoting a child address if it
21139 generates a bounce or delay message for it. Instead it says &"an address
21140 generated from <&'the top level address'&>"&. Of course, this applies only to
21141 bounces generated locally. If a message is forwarded to another host, &'its'&
21142 bounce may well quote the generated address.
21143
21144
21145 .option ignore_eacces redirect boolean false
21146 .cindex "EACCES"
21147 If this option is set and an attempt to open a redirection file yields the
21148 EACCES error (permission denied), the &(redirect)& router behaves as if the
21149 file did not exist.
21150
21151
21152 .option ignore_enotdir redirect boolean false
21153 .cindex "ENOTDIR"
21154 If this option is set and an attempt to open a redirection file yields the
21155 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21156 router behaves as if the file did not exist.
21157
21158 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21159 router that has the &%file%& option set discovers that the file does not exist
21160 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21161 against unmounted NFS directories. If the parent can not be statted, delivery
21162 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21163 is set, because that option tells Exim to ignore &"something on the path is not
21164 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21165 that some operating systems give ENOENT where others give ENOTDIR.
21166
21167
21168
21169 .option include_directory redirect string unset
21170 If this option is set, the path names of any &':include:'& items in a
21171 redirection list must start with this directory.
21172
21173
21174 .option modemask redirect "octal integer" 022
21175 This specifies mode bits which must not be set for a file specified by the
21176 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21177
21178
21179 .option one_time redirect boolean false
21180 .cindex "one-time aliasing/forwarding expansion"
21181 .cindex "alias file" "one-time expansion"
21182 .cindex "forward file" "one-time expansion"
21183 .cindex "mailing lists" "one-time expansion"
21184 .cindex "address redirection" "one-time expansion"
21185 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21186 files each time it tries to deliver a message causes a problem when one or more
21187 of the generated addresses fails be delivered at the first attempt. The problem
21188 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21189 but of what happens when the redirection list changes during the time that the
21190 message is on Exim's queue. This is particularly true in the case of mailing
21191 lists, where new subscribers might receive copies of messages that were posted
21192 before they subscribed.
21193
21194 If &%one_time%& is set and any addresses generated by the router fail to
21195 deliver at the first attempt, the failing addresses are added to the message as
21196 &"top level"& addresses, and the parent address that generated them is marked
21197 &"delivered"&. Thus, redirection does not happen again at the next delivery
21198 attempt.
21199
21200 &*Warning 1*&: Any header line addition or removal that is specified by this
21201 router would be lost if delivery did not succeed at the first attempt. For this
21202 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21203 permitted when &%one_time%& is set.
21204
21205 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21206 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21207 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21208
21209 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21210 &%one_time%&.
21211
21212 The original top-level address is remembered with each of the generated
21213 addresses, and is output in any log messages. However, any intermediate parent
21214 addresses are not recorded. This makes a difference to the log only if
21215 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21216 typically be used for mailing lists, where there is normally just one level of
21217 expansion.
21218
21219
21220 .option owners redirect "string list" unset
21221 .cindex "ownership" "alias file"
21222 .cindex "ownership" "forward file"
21223 .cindex "alias file" "ownership"
21224 .cindex "forward file" "ownership"
21225 This specifies a list of permitted owners for the file specified by &%file%&.
21226 This list is in addition to the local user when &%check_local_user%& is set.
21227 See &%check_owner%& above.
21228
21229
21230 .option owngroups redirect "string list" unset
21231 This specifies a list of permitted groups for the file specified by &%file%&.
21232 The list is in addition to the local user's primary group when
21233 &%check_local_user%& is set. See &%check_group%& above.
21234
21235
21236 .option pipe_transport redirect string&!! unset
21237 .vindex "&$address_pipe$&"
21238 A &(redirect)& router sets up a direct delivery to a pipe when a string
21239 starting with a vertical bar character is specified as a new &"address"&. The
21240 transport used is specified by this option, which, after expansion, must be the
21241 name of a configured transport. This should normally be a &(pipe)& transport.
21242 When the transport is run, the pipe command is in &$address_pipe$&.
21243
21244
21245 .option qualify_domain redirect string&!! unset
21246 .vindex "&$qualify_recipient$&"
21247 If this option is set, and an unqualified address (one without a domain) is
21248 generated, and that address would normally be qualified by the global setting
21249 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21250 expanding this string. If the expansion fails, the router declines. If you want
21251 to revert to the default, you can have the expansion generate
21252 &$qualify_recipient$&.
21253
21254 This option applies to all unqualified addresses generated by Exim filters,
21255 but for traditional &_.forward_& files, it applies only to addresses that are
21256 not preceded by a backslash. Sieve filters cannot generate unqualified
21257 addresses.
21258
21259 .option qualify_preserve_domain redirect boolean false
21260 .cindex "domain" "in redirection; preserving"
21261 .cindex "preserving domain in redirection"
21262 .cindex "address redirection" "domain; preserving"
21263 If this option is set, the router's local &%qualify_domain%& option must not be
21264 set (a configuration error occurs if it is). If an unqualified address (one
21265 without a domain) is generated, it is qualified with the domain of the parent
21266 address (the immediately preceding ancestor) instead of the global
21267 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21268 this applies whether or not the address is preceded by a backslash.
21269
21270
21271 .option repeat_use redirect boolean true
21272 If this option is set false, the router is skipped for a child address that has
21273 any ancestor that was routed by this router. This test happens before any of
21274 the other preconditions are tested. Exim's default anti-looping rules skip
21275 only when the ancestor is the same as the current address. See also
21276 &%check_ancestor%& above and the generic &%redirect_router%& option.
21277
21278
21279 .option reply_transport redirect string&!! unset
21280 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21281 &%vacation%& command is used in a filter file. The transport used is specified
21282 by this option, which, after expansion, must be the name of a configured
21283 transport. This should normally be an &(autoreply)& transport. Other transports
21284 are unlikely to do anything sensible or useful.
21285
21286
21287 .option rewrite redirect boolean true
21288 .cindex "address redirection" "disabling rewriting"
21289 If this option is set false, addresses generated by the router are not
21290 subject to address rewriting. Otherwise, they are treated like new addresses
21291 and are rewritten according to the global rewriting rules.
21292
21293
21294 .option sieve_subaddress redirect string&!! unset
21295 The value of this option is passed to a Sieve filter to specify the
21296 :subaddress part of an address.
21297
21298 .option sieve_useraddress redirect string&!! unset
21299 The value of this option is passed to a Sieve filter to specify the :user part
21300 of an address. However, if it is unset, the entire original local part
21301 (including any prefix or suffix) is used for :user.
21302
21303
21304 .option sieve_vacation_directory redirect string&!! unset
21305 .cindex "Sieve filter" "vacation directory"
21306 To enable the &"vacation"& extension for Sieve filters, you must set
21307 &%sieve_vacation_directory%& to the directory where vacation databases are held
21308 (do not put anything else in that directory), and ensure that the
21309 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21310 needs their own directory; Exim will create it if necessary.
21311
21312
21313
21314 .option skip_syntax_errors redirect boolean false
21315 .cindex "forward file" "broken"
21316 .cindex "address redirection" "broken files"
21317 .cindex "alias file" "broken"
21318 .cindex "broken alias or forward files"
21319 .cindex "ignoring faulty addresses"
21320 .cindex "skipping faulty addresses"
21321 .cindex "error" "skipping bad syntax"
21322 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21323 non-filter redirection data are skipped, and each failing address is logged. If
21324 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21325 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21326 are expanded and placed at the head of the error message generated by
21327 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21328 be the same address as the generic &%errors_to%& option. The
21329 &%skip_syntax_errors%& option is often used when handling mailing lists.
21330
21331 If all the addresses in a redirection list are skipped because of syntax
21332 errors, the router declines to handle the original address, and it is passed to
21333 the following routers.
21334
21335 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21336 error in the filter causes filtering to be abandoned without any action being
21337 taken. The incident is logged, and the router declines to handle the address,
21338 so it is passed to the following routers.
21339
21340 .cindex "Sieve filter" "syntax errors in"
21341 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21342 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21343 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21344
21345 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21346 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21347 option, used with an address that does not get redirected, can be used to
21348 notify users of these errors, by means of a router like this:
21349 .code
21350 userforward:
21351   driver = redirect
21352   allow_filter
21353   check_local_user
21354   file = $home/.forward
21355   file_transport = address_file
21356   pipe_transport = address_pipe
21357   reply_transport = address_reply
21358   no_verify
21359   skip_syntax_errors
21360   syntax_errors_to = real-$local_part@$domain
21361   syntax_errors_text = \
21362    This is an automatically generated message. An error has\n\
21363    been found in your .forward file. Details of the error are\n\
21364    reported below. While this error persists, you will receive\n\
21365    a copy of this message for every message that is addressed\n\
21366    to you. If your .forward file is a filter file, or if it is\n\
21367    a non-filter file containing no valid forwarding addresses,\n\
21368    a copy of each incoming message will be put in your normal\n\
21369    mailbox. If a non-filter file contains at least one valid\n\
21370    forwarding address, forwarding to the valid addresses will\n\
21371    happen, and those will be the only deliveries that occur.
21372 .endd
21373 You also need a router to ensure that local addresses that are prefixed by
21374 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21375 put this immediately before the &(userforward)& router:
21376 .code
21377 real_localuser:
21378   driver = accept
21379   check_local_user
21380   local_part_prefix = real-
21381   transport = local_delivery
21382 .endd
21383 For security, it would probably be a good idea to restrict the use of this
21384 router to locally-generated messages, using a condition such as this:
21385 .code
21386   condition = ${if match {$sender_host_address}\
21387                          {\N^(|127\.0\.0\.1)$\N}}
21388 .endd
21389
21390
21391 .option syntax_errors_text redirect string&!! unset
21392 See &%skip_syntax_errors%& above.
21393
21394
21395 .option syntax_errors_to redirect string unset
21396 See &%skip_syntax_errors%& above.
21397 .ecindex IIDredrou1
21398 .ecindex IIDredrou2
21399
21400
21401
21402
21403
21404
21405 . ////////////////////////////////////////////////////////////////////////////
21406 . ////////////////////////////////////////////////////////////////////////////
21407
21408 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21409          "Environment for local transports"
21410 .scindex IIDenvlotra1 "local transports" "environment for"
21411 .scindex IIDenvlotra2 "environment" "local transports"
21412 .scindex IIDenvlotra3 "transport" "local; environment for"
21413 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21414 transport can be thought of as similar to a pipe.) Exim always runs transports
21415 in subprocesses, under specified uids and gids. Typical deliveries to local
21416 mailboxes run under the uid and gid of the local user.
21417
21418 Exim also sets a specific current directory while running the transport; for
21419 some transports a home directory setting is also relevant. The &(pipe)&
21420 transport is the only one that sets up environment variables; see section
21421 &<<SECTpipeenv>>& for details.
21422
21423 The values used for the uid, gid, and the directories may come from several
21424 different places. In many cases, the router that handles the address associates
21425 settings with that address as a result of its &%check_local_user%&, &%group%&,
21426 or &%user%& options. However, values may also be given in the transport's own
21427 configuration, and these override anything that comes from the router.
21428
21429
21430
21431 .section "Concurrent deliveries" "SECID131"
21432 .cindex "concurrent deliveries"
21433 .cindex "simultaneous deliveries"
21434 If two different messages for the same local recipient arrive more or less
21435 simultaneously, the two delivery processes are likely to run concurrently. When
21436 the &(appendfile)& transport is used to write to a file, Exim applies locking
21437 rules to stop concurrent processes from writing to the same file at the same
21438 time.
21439
21440 However, when you use a &(pipe)& transport, it is up to you to arrange any
21441 locking that is needed. Here is a silly example:
21442 .code
21443 my_transport:
21444   driver = pipe
21445   command = /bin/sh -c 'cat >>/some/file'
21446 .endd
21447 This is supposed to write the message at the end of the file. However, if two
21448 messages arrive at the same time, the file will be scrambled. You can use the
21449 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21450 file using the same algorithm that Exim itself uses.
21451
21452
21453
21454
21455 .section "Uids and gids" "SECTenvuidgid"
21456 .cindex "local transports" "uid and gid"
21457 .cindex "transport" "local; uid and gid"
21458 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21459 overrides any group that the router set in the address, even if &%user%& is not
21460 set for the transport. This makes it possible, for example, to run local mail
21461 delivery under the uid of the recipient (set by the router), but in a special
21462 group (set by the transport). For example:
21463 .code
21464 # Routers ...
21465 # User/group are set by check_local_user in this router
21466 local_users:
21467   driver = accept
21468   check_local_user
21469   transport = group_delivery
21470
21471 # Transports ...
21472 # This transport overrides the group
21473 group_delivery:
21474   driver = appendfile
21475   file = /var/spool/mail/$local_part
21476   group = mail
21477 .endd
21478 If &%user%& is set for a transport, its value overrides what is set in the
21479 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21480 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21481 set.
21482
21483 .oindex "&%initgroups%&"
21484 When the uid is taken from the transport's configuration, the &[initgroups()]&
21485 function is called for the groups associated with that uid if the
21486 &%initgroups%& option is set for the transport. When the uid is not specified
21487 by the transport, but is associated with the address by a router, the option
21488 for calling &[initgroups()]& is taken from the router configuration.
21489
21490 .cindex "&(pipe)& transport" "uid for"
21491 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21492 is set and &%user%& is not set, the uid of the process that called Exim to
21493 receive the message is used, and if &%group%& is not set, the corresponding
21494 original gid is also used.
21495
21496 This is the detailed preference order for obtaining a gid; the first of the
21497 following that is set is used:
21498
21499 .ilist
21500 A &%group%& setting of the transport;
21501 .next
21502 A &%group%& setting of the router;
21503 .next
21504 A gid associated with a user setting of the router, either as a result of
21505 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21506 .next
21507 The group associated with a non-numeric &%user%& setting of the transport;
21508 .next
21509 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21510 the uid is the creator's uid;
21511 .next
21512 The Exim gid if the Exim uid is being used as a default.
21513 .endlist
21514
21515 If, for example, the user is specified numerically on the router and there are
21516 no group settings, no gid is available. In this situation, an error occurs.
21517 This is different for the uid, for which there always is an ultimate default.
21518 The first of the following that is set is used:
21519
21520 .ilist
21521 A &%user%& setting of the transport;
21522 .next
21523 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21524 .next
21525 A &%user%& setting of the router;
21526 .next
21527 A &%check_local_user%& setting of the router;
21528 .next
21529 The Exim uid.
21530 .endlist
21531
21532 Of course, an error will still occur if the uid that is chosen is on the
21533 &%never_users%& list.
21534
21535
21536
21537
21538
21539 .section "Current and home directories" "SECID132"
21540 .cindex "current directory for local transport"
21541 .cindex "home directory" "for local transport"
21542 .cindex "transport" "local; home directory for"
21543 .cindex "transport" "local; current directory for"
21544 Routers may set current and home directories for local transports by means of
21545 the &%transport_current_directory%& and &%transport_home_directory%& options.
21546 However, if the transport's &%current_directory%& or &%home_directory%& options
21547 are set, they override the router's values. In detail, the home directory
21548 for a local transport is taken from the first of these values that is set:
21549
21550 .ilist
21551 The &%home_directory%& option on the transport;
21552 .next
21553 The &%transport_home_directory%& option on the router;
21554 .next
21555 The password data if &%check_local_user%& is set on the router;
21556 .next
21557 The &%router_home_directory%& option on the router.
21558 .endlist
21559
21560 The current directory is taken from the first of these values that is set:
21561
21562 .ilist
21563 The &%current_directory%& option on the transport;
21564 .next
21565 The &%transport_current_directory%& option on the router.
21566 .endlist
21567
21568
21569 If neither the router nor the transport sets a current directory, Exim uses the
21570 value of the home directory, if it is set. Otherwise it sets the current
21571 directory to &_/_& before running a local transport.
21572
21573
21574
21575 .section "Expansion variables derived from the address" "SECID133"
21576 .vindex "&$domain$&"
21577 .vindex "&$local_part$&"
21578 .vindex "&$original_domain$&"
21579 Normally a local delivery is handling a single address, and in that case the
21580 variables such as &$domain$& and &$local_part$& are set during local
21581 deliveries. However, in some circumstances more than one address may be handled
21582 at once (for example, while writing batch SMTP for onward transmission by some
21583 other means). In this case, the variables associated with the local part are
21584 never set, &$domain$& is set only if all the addresses have the same domain,
21585 and &$original_domain$& is never set.
21586 .ecindex IIDenvlotra1
21587 .ecindex IIDenvlotra2
21588 .ecindex IIDenvlotra3
21589
21590
21591
21592
21593
21594
21595
21596 . ////////////////////////////////////////////////////////////////////////////
21597 . ////////////////////////////////////////////////////////////////////////////
21598
21599 .chapter "Generic options for transports" "CHAPtransportgeneric"
21600 .scindex IIDgenoptra1 "generic options" "transport"
21601 .scindex IIDgenoptra2 "options" "generic; for transports"
21602 .scindex IIDgenoptra3 "transport" "generic options for"
21603 The following generic options apply to all transports:
21604
21605
21606 .option body_only transports boolean false
21607 .cindex "transport" "body only"
21608 .cindex "message" "transporting body only"
21609 .cindex "body of message" "transporting"
21610 If this option is set, the message's headers are not transported. It is
21611 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21612 or &(pipe)& transports, the settings of &%message_prefix%& and
21613 &%message_suffix%& should be checked, because this option does not
21614 automatically suppress them.
21615
21616
21617 .option current_directory transports string&!! unset
21618 .cindex "transport" "current directory for"
21619 This specifies the current directory that is to be set while running the
21620 transport, overriding any value that may have been set by the router.
21621 If the expansion fails for any reason, including forced failure, an error is
21622 logged, and delivery is deferred.
21623
21624
21625 .option disable_logging transports boolean false
21626 If this option is set true, nothing is logged for any
21627 deliveries by the transport or for any
21628 transport errors. You should not set this option unless you really, really know
21629 what you are doing.
21630
21631
21632 .option debug_print transports string&!! unset
21633 .cindex "testing" "variables in drivers"
21634 If this option is set and debugging is enabled (see the &%-d%& command line
21635 option), the string is expanded and included in the debugging output when the
21636 transport is run.
21637 If expansion of the string fails, the error message is written to the debugging
21638 output, and Exim carries on processing.
21639 This facility is provided to help with checking out the values of variables and
21640 so on when debugging driver configurations. For example, if a &%headers_add%&
21641 option is not working properly, &%debug_print%& could be used to output the
21642 variables it references. A newline is added to the text if it does not end with
21643 one.
21644 The variables &$transport_name$& and &$router_name$& contain the name of the
21645 transport and the router that called it.
21646
21647 .option delivery_date_add transports boolean false
21648 .cindex "&'Delivery-date:'& header line"
21649 If this option is true, a &'Delivery-date:'& header is added to the message.
21650 This gives the actual time the delivery was made. As this is not a standard
21651 header, Exim has a configuration option (&%delivery_date_remove%&) which
21652 requests its removal from incoming messages, so that delivered messages can
21653 safely be resent to other recipients.
21654
21655
21656 .option driver transports string unset
21657 This specifies which of the available transport drivers is to be used.
21658 There is no default, and this option must be set for every transport.
21659
21660
21661 .option envelope_to_add transports boolean false
21662 .cindex "&'Envelope-to:'& header line"
21663 If this option is true, an &'Envelope-to:'& header is added to the message.
21664 This gives the original address(es) in the incoming envelope that caused this
21665 delivery to happen. More than one address may be present if the transport is
21666 configured to handle several addresses at once, or if more than one original
21667 address was redirected to the same final address. As this is not a standard
21668 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21669 its removal from incoming messages, so that delivered messages can safely be
21670 resent to other recipients.
21671
21672
21673 .option event_action transports string&!! unset
21674 .cindex events
21675 This option declares a string to be expanded for Exim's events mechanism.
21676 For details see chapter &<<CHAPevents>>&.
21677
21678
21679 .option group transports string&!! "Exim group"
21680 .cindex "transport" "group; specifying"
21681 This option specifies a gid for running the transport process, overriding any
21682 value that the router supplies, and also overriding any value associated with
21683 &%user%& (see below).
21684
21685
21686 .option headers_add transports list&!! unset
21687 .cindex "header lines" "adding in transport"
21688 .cindex "transport" "header lines; adding"
21689 This option specifies a list of text headers,
21690 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21691 which are (separately) expanded and added to the header
21692 portion of a message as it is transported, as described in section
21693 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21694 routers. If the result of the expansion is an empty string, or if the expansion
21695 is forced to fail, no action is taken. Other expansion failures are treated as
21696 errors and cause the delivery to be deferred.
21697
21698 Unlike most options, &%headers_add%& can be specified multiple times
21699 for a transport; all listed headers are added.
21700
21701
21702 .option headers_only transports boolean false
21703 .cindex "transport" "header lines only"
21704 .cindex "message" "transporting headers only"
21705 .cindex "header lines" "transporting"
21706 If this option is set, the message's body is not transported. It is mutually
21707 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21708 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21709 checked, since this option does not automatically suppress them.
21710
21711
21712 .option headers_remove transports list&!! unset
21713 .cindex "header lines" "removing"
21714 .cindex "transport" "header lines; removing"
21715 This option specifies a list of header names,
21716 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21717 these headers are omitted from the message as it is transported, as described
21718 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21719 routers.
21720 Each list item is separately expanded.
21721 If the result of the expansion is an empty string, or if the expansion
21722 is forced to fail, no action is taken. Other expansion failures are treated as
21723 errors and cause the delivery to be deferred.
21724
21725 Unlike most options, &%headers_remove%& can be specified multiple times
21726 for a transport; all listed headers are removed.
21727
21728 &*Warning*&: Because of the separate expansion of the list items,
21729 items that contain a list separator must have it doubled.
21730 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21731
21732
21733
21734 .option headers_rewrite transports string unset
21735 .cindex "transport" "header lines; rewriting"
21736 .cindex "rewriting" "at transport time"
21737 This option allows addresses in header lines to be rewritten at transport time,
21738 that is, as the message is being copied to its destination. The contents of the
21739 option are a colon-separated list of rewriting rules. Each rule is in exactly
21740 the same form as one of the general rewriting rules that are applied when a
21741 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21742 example,
21743 .code
21744 headers_rewrite = a@b c@d f : \
21745                   x@y w@z
21746 .endd
21747 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21748 &'w@z'& in all address-bearing header lines. The rules are applied to the
21749 header lines just before they are written out at transport time, so they affect
21750 only those copies of the message that pass through the transport. However, only
21751 the message's original header lines, and any that were added by a system
21752 filter, are rewritten. If a router or transport adds header lines, they are not
21753 affected by this option. These rewriting rules are &'not'& applied to the
21754 envelope. You can change the return path using &%return_path%&, but you cannot
21755 change envelope recipients at this time.
21756
21757
21758 .option home_directory transports string&!! unset
21759 .cindex "transport" "home directory for"
21760 .vindex "&$home$&"
21761 This option specifies a home directory setting for a local transport,
21762 overriding any value that may be set by the router. The home directory is
21763 placed in &$home$& while expanding the transport's private options. It is also
21764 used as the current directory if no current directory is set by the
21765 &%current_directory%& option on the transport or the
21766 &%transport_current_directory%& option on the router. If the expansion fails
21767 for any reason, including forced failure, an error is logged, and delivery is
21768 deferred.
21769
21770
21771 .option initgroups transports boolean false
21772 .cindex "additional groups"
21773 .cindex "groups" "additional"
21774 .cindex "transport" "group; additional"
21775 If this option is true and the uid for the delivery process is provided by the
21776 transport, the &[initgroups()]& function is called when running the transport
21777 to ensure that any additional groups associated with the uid are set up.
21778
21779
21780 .option max_parallel transports integer&!! unset
21781 .cindex limit "transport parallelism"
21782 .cindex transport "parallel processes"
21783 .cindex transport "concurrency limit"
21784 .cindex "delivery" "parallelism for transport"
21785 If this option is set and expands to an integer greater than zero
21786 it limits the number of concurrent runs of the transport.
21787 The control does not apply to shadow transports.
21788
21789 .cindex "hints database" "transport concurrency control"
21790 Exim implements this control by means of a hints database in which a record is
21791 incremented whenever a transport process is being created. The record
21792 is decremented and possibly removed when the process terminates.
21793 Obviously there is scope for
21794 records to get left lying around if there is a system or program crash. To
21795 guard against this, Exim ignores any records that are more than six hours old.
21796
21797 If you use this option, you should also arrange to delete the
21798 relevant hints database whenever your system reboots. The names of the files
21799 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21800 may be one or two files, depending on the type of DBM in use. The same files
21801 are used for ETRN and smtp transport serialization.
21802
21803
21804 .option message_size_limit transports string&!! 0
21805 .cindex "limit" "message size per transport"
21806 .cindex "size" "of message, limit"
21807 .cindex "transport" "message size; limiting"
21808 This option controls the size of messages passed through the transport. It is
21809 expanded before use; the result of the expansion must be a sequence of decimal
21810 digits, optionally followed by K or M. If the expansion fails for any reason,
21811 including forced failure, or if the result is not of the required form,
21812 delivery is deferred. If the value is greater than zero and the size of a
21813 message exceeds this limit, the address is failed. If there is any chance that
21814 the resulting bounce message could be routed to the same transport, you should
21815 ensure that &%return_size_limit%& is less than the transport's
21816 &%message_size_limit%&, as otherwise the bounce message will fail to get
21817 delivered.
21818
21819
21820
21821 .option rcpt_include_affixes transports boolean false
21822 .cindex "prefix" "for local part, including in envelope"
21823 .cindex "suffix for local part" "including in envelope"
21824 .cindex "local part" "prefix"
21825 .cindex "local part" "suffix"
21826 When this option is false (the default), and an address that has had any
21827 affixes (prefixes or suffixes) removed from the local part is delivered by any
21828 form of SMTP or LMTP, the affixes are not included. For example, if a router
21829 that contains
21830 .code
21831 local_part_prefix = *-
21832 .endd
21833 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21834 is delivered with
21835 .code
21836 RCPT TO:<xyz@some.domain>
21837 .endd
21838 This is also the case when an ACL-time callout is being used to verify a
21839 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21840 whole local part is included in the RCPT command. This option applies to BSMTP
21841 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21842 &(lmtp)& and &(smtp)& transports.
21843
21844
21845 .option retry_use_local_part transports boolean "see below"
21846 .cindex "hints database" "retry keys"
21847 When a delivery suffers a temporary failure, a retry record is created
21848 in Exim's hints database. For remote deliveries, the key for the retry record
21849 is based on the name and/or IP address of the failing remote host. For local
21850 deliveries, the key is normally the entire address, including both the local
21851 part and the domain. This is suitable for most common cases of local delivery
21852 temporary failure &-- for example, exceeding a mailbox quota should delay only
21853 deliveries to that mailbox, not to the whole domain.
21854
21855 However, in some special cases you may want to treat a temporary local delivery
21856 as a failure associated with the domain, and not with a particular local part.
21857 (For example, if you are storing all mail for some domain in files.) You can do
21858 this by setting &%retry_use_local_part%& false.
21859
21860 For all the local transports, its default value is true. For remote transports,
21861 the default value is false for tidiness, but changing the value has no effect
21862 on a remote transport in the current implementation.
21863
21864
21865 .option return_path transports string&!! unset
21866 .cindex "envelope sender"
21867 .cindex "envelope from"
21868 .cindex "transport" "return path; changing"
21869 .cindex "return path" "changing in transport"
21870 If this option is set, the string is expanded at transport time and replaces
21871 the existing return path (envelope sender) value in the copy of the message
21872 that is being delivered. An empty return path is permitted. This feature is
21873 designed for remote deliveries, where the value of this option is used in the
21874 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21875 only effect is to change the address that is placed in the &'Return-path:'&
21876 header line, if one is added to the message (see the next option).
21877
21878 &*Note:*& A changed return path is not logged unless you add
21879 &%return_path_on_delivery%& to the log selector.
21880
21881 .vindex "&$return_path$&"
21882 The expansion can refer to the existing value via &$return_path$&. This is
21883 either the message's envelope sender, or an address set by the
21884 &%errors_to%& option on a router. If the expansion is forced to fail, no
21885 replacement occurs; if it fails for another reason, delivery is deferred. This
21886 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21887 section &<<SECTverp>>&.
21888
21889 &*Note*&: If a delivery error is detected locally, including the case when a
21890 remote server rejects a message at SMTP time, the bounce message is not sent to
21891 the value of this option. It is sent to the previously set errors address.
21892 This defaults to the incoming sender address, but can be changed by setting
21893 &%errors_to%& in a router.
21894
21895
21896
21897 .option return_path_add transports boolean false
21898 .cindex "&'Return-path:'& header line"
21899 If this option is true, a &'Return-path:'& header is added to the message.
21900 Although the return path is normally available in the prefix line of BSD
21901 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21902 have easy access to it.
21903
21904 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21905 the delivery SMTP server makes the final delivery"&. This implies that this
21906 header should not be present in incoming messages. Exim has a configuration
21907 option, &%return_path_remove%&, which requests removal of this header from
21908 incoming messages, so that delivered messages can safely be resent to other
21909 recipients.
21910
21911
21912 .option shadow_condition transports string&!! unset
21913 See &%shadow_transport%& below.
21914
21915
21916 .option shadow_transport transports string unset
21917 .cindex "shadow transport"
21918 .cindex "transport" "shadow"
21919 A local transport may set the &%shadow_transport%& option to the name of
21920 another local transport. Shadow remote transports are not supported.
21921
21922 Whenever a delivery to the main transport succeeds, and either
21923 &%shadow_condition%& is unset, or its expansion does not result in the empty
21924 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21925 passed to the shadow transport, with the same delivery address or addresses. If
21926 expansion fails, no action is taken except that non-forced expansion failures
21927 cause a log line to be written.
21928
21929 The result of the shadow transport is discarded and does not affect the
21930 subsequent processing of the message. Only a single level of shadowing is
21931 provided; the &%shadow_transport%& option is ignored on any transport when it
21932 is running as a shadow. Options concerned with output from pipes are also
21933 ignored. The log line for the successful delivery has an item added on the end,
21934 of the form
21935 .code
21936 ST=<shadow transport name>
21937 .endd
21938 If the shadow transport did not succeed, the error message is put in
21939 parentheses afterwards. Shadow transports can be used for a number of different
21940 purposes, including keeping more detailed log information than Exim normally
21941 provides, and implementing automatic acknowledgment policies based on message
21942 headers that some sites insist on.
21943
21944
21945 .option transport_filter transports string&!! unset
21946 .cindex "transport" "filter"
21947 .cindex "filter" "transport filter"
21948 This option sets up a filtering (in the Unix shell sense) process for messages
21949 at transport time. It should not be confused with mail filtering as set up by
21950 individual users or via a system filter.
21951 If unset, or expanding to an empty string, no filtering is done.
21952
21953 When the message is about to be written out, the command specified by
21954 &%transport_filter%& is started up in a separate, parallel process, and
21955 the entire message, including the header lines, is passed to it on its standard
21956 input (this in fact is done from a third process, to avoid deadlock). The
21957 command must be specified as an absolute path.
21958
21959 The lines of the message that are written to the transport filter are
21960 terminated by newline (&"\n"&). The message is passed to the filter before any
21961 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21962 lines beginning with a dot, and also before any processing implied by the
21963 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21964 &(pipe)& transports.
21965
21966 The standard error for the filter process is set to the same destination as its
21967 standard output; this is read and written to the message's ultimate
21968 destination. The process that writes the message to the filter, the
21969 filter itself, and the original process that reads the result and delivers it
21970 are all run in parallel, like a shell pipeline.
21971
21972 The filter can perform any transformations it likes, but of course should take
21973 care not to break RFC 2822 syntax. Exim does not check the result, except to
21974 test for a final newline when SMTP is in use. All messages transmitted over
21975 SMTP must end with a newline, so Exim supplies one if it is missing.
21976
21977 .cindex "content scanning" "per user"
21978 A transport filter can be used to provide content-scanning on a per-user basis
21979 at delivery time if the only required effect of the scan is to modify the
21980 message. For example, a content scan could insert a new header line containing
21981 a spam score. This could be interpreted by a filter in the user's MUA. It is
21982 not possible to discard a message at this stage.
21983
21984 .cindex "SMTP" "SIZE"
21985 A problem might arise if the filter increases the size of a message that is
21986 being sent down an SMTP connection. If the receiving SMTP server has indicated
21987 support for the SIZE parameter, Exim will have sent the size of the message
21988 at the start of the SMTP session. If what is actually sent is substantially
21989 more, the server might reject the message. This can be worked round by setting
21990 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21991 additions to the message, or to disable the use of SIZE altogether.
21992
21993 .vindex "&$pipe_addresses$&"
21994 The value of the &%transport_filter%& option is the command string for starting
21995 the filter, which is run directly from Exim, not under a shell. The string is
21996 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21997 Exim breaks it up into arguments and then expands each argument separately (see
21998 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21999 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22000 of arguments, one for each address that applies to this delivery. (This isn't
22001 an ideal name for this feature here, but as it was already implemented for the
22002 &(pipe)& transport, it seemed sensible not to change it.)
22003
22004 .vindex "&$host$&"
22005 .vindex "&$host_address$&"
22006 The expansion variables &$host$& and &$host_address$& are available when the
22007 transport is a remote one. They contain the name and IP address of the host to
22008 which the message is being sent. For example:
22009 .code
22010 transport_filter = /some/directory/transport-filter.pl \
22011   $host $host_address $sender_address $pipe_addresses
22012 .endd
22013
22014 Two problems arise if you want to use more complicated expansion items to
22015 generate transport filter commands, both of which due to the fact that the
22016 command is split up &'before'& expansion.
22017 .ilist
22018 If an expansion item contains white space, you must quote it, so that it is all
22019 part of the same command item. If the entire option setting is one such
22020 expansion item, you have to take care what kind of quoting you use. For
22021 example:
22022 .code
22023 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22024 .endd
22025 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22026 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22027 stripped by Exim when it read the option's value. When the value is used, if
22028 the single quotes were missing, the line would be split into two items,
22029 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22030 Exim tried to expand the first one.
22031 .next
22032 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22033 expansion cannot generate multiple arguments, or a command name followed by
22034 arguments. Consider this example:
22035 .code
22036 transport_filter = ${lookup{$host}lsearch{/a/file}\
22037                     {$value}{/bin/cat}}
22038 .endd
22039 The result of the lookup is interpreted as the name of the command, even
22040 if it contains white space. The simplest way round this is to use a shell:
22041 .code
22042 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22043                                {$value}{/bin/cat}}
22044 .endd
22045 .endlist
22046
22047 The filter process is run under the same uid and gid as the normal delivery.
22048 For remote deliveries this is the Exim uid/gid by default. The command should
22049 normally yield a zero return code. Transport filters are not supposed to fail.
22050 A non-zero code is taken to mean that the transport filter encountered some
22051 serious problem. Delivery of the message is deferred; the message remains on
22052 the queue and is tried again later. It is not possible to cause a message to be
22053 bounced from a transport filter.
22054
22055 If a transport filter is set on an autoreply transport, the original message is
22056 passed through the filter as it is being copied into the newly generated
22057 message, which happens if the &%return_message%& option is set.
22058
22059
22060 .option transport_filter_timeout transports time 5m
22061 .cindex "transport" "filter, timeout"
22062 When Exim is reading the output of a transport filter, it applies a timeout
22063 that can be set by this option. Exceeding the timeout is normally treated as a
22064 temporary delivery failure. However, if a transport filter is used with a
22065 &(pipe)& transport, a timeout in the transport filter is treated in the same
22066 way as a timeout in the pipe command itself. By default, a timeout is a hard
22067 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22068 becomes a temporary error.
22069
22070
22071 .option user transports string&!! "Exim user"
22072 .cindex "uid (user id)" "local delivery"
22073 .cindex "transport" "user, specifying"
22074 This option specifies the user under whose uid the delivery process is to be
22075 run, overriding any uid that may have been set by the router. If the user is
22076 given as a name, the uid is looked up from the password data, and the
22077 associated group is taken as the value of the gid to be used if the &%group%&
22078 option is not set.
22079
22080 For deliveries that use local transports, a user and group are normally
22081 specified explicitly or implicitly (for example, as a result of
22082 &%check_local_user%&) by the router or transport.
22083
22084 .cindex "hints database" "access by remote transport"
22085 For remote transports, you should leave this option unset unless you really are
22086 sure you know what you are doing. When a remote transport is running, it needs
22087 to be able to access Exim's hints databases, because each host may have its own
22088 retry data.
22089 .ecindex IIDgenoptra1
22090 .ecindex IIDgenoptra2
22091 .ecindex IIDgenoptra3
22092
22093
22094
22095
22096
22097
22098 . ////////////////////////////////////////////////////////////////////////////
22099 . ////////////////////////////////////////////////////////////////////////////
22100
22101 .chapter "Address batching in local transports" "CHAPbatching" &&&
22102          "Address batching"
22103 .cindex "transport" "local; address batching in"
22104 The only remote transport (&(smtp)&) is normally configured to handle more than
22105 one address at a time, so that when several addresses are routed to the same
22106 remote host, just one copy of the message is sent. Local transports, however,
22107 normally handle one address at a time. That is, a separate instance of the
22108 transport is run for each address that is routed to the transport. A separate
22109 copy of the message is delivered each time.
22110
22111 .cindex "batched local delivery"
22112 .oindex "&%batch_max%&"
22113 .oindex "&%batch_id%&"
22114 In special cases, it may be desirable to handle several addresses at once in a
22115 local transport, for example:
22116
22117 .ilist
22118 In an &(appendfile)& transport, when storing messages in files for later
22119 delivery by some other means, a single copy of the message with multiple
22120 recipients saves space.
22121 .next
22122 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22123 a single copy saves time, and is the normal way LMTP is expected to work.
22124 .next
22125 In a &(pipe)& transport, when passing the message
22126 to a scanner program or
22127 to some other delivery mechanism such as UUCP, multiple recipients may be
22128 acceptable.
22129 .endlist
22130
22131 These three local transports all have the same options for controlling multiple
22132 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22133 repeating the information for each transport, these options are described here.
22134
22135 The &%batch_max%& option specifies the maximum number of addresses that can be
22136 delivered together in a single run of the transport. Its default value is one
22137 (no batching). When more than one address is routed to a transport that has a
22138 &%batch_max%& value greater than one, the addresses are delivered in a batch
22139 (that is, in a single run of the transport with multiple recipients), subject
22140 to certain conditions:
22141
22142 .ilist
22143 .vindex "&$local_part$&"
22144 If any of the transport's options contain a reference to &$local_part$&, no
22145 batching is possible.
22146 .next
22147 .vindex "&$domain$&"
22148 If any of the transport's options contain a reference to &$domain$&, only
22149 addresses with the same domain are batched.
22150 .next
22151 .cindex "customizing" "batching condition"
22152 If &%batch_id%& is set, it is expanded for each address, and only those
22153 addresses with the same expanded value are batched. This allows you to specify
22154 customized batching conditions. Failure of the expansion for any reason,
22155 including forced failure, disables batching, but it does not stop the delivery
22156 from taking place.
22157 .next
22158 Batched addresses must also have the same errors address (where to send
22159 delivery errors), the same header additions and removals, the same user and
22160 group for the transport, and if a host list is present, the first host must
22161 be the same.
22162 .endlist
22163
22164 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22165 both when the file or pipe command is specified in the transport, and when it
22166 is specified by a &(redirect)& router, but all the batched addresses must of
22167 course be routed to the same file or pipe command. These two transports have an
22168 option called &%use_bsmtp%&, which causes them to deliver the message in
22169 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22170 &%check_string%& and &%escape_string%& options are forced to the values
22171 .code
22172 check_string = "."
22173 escape_string = ".."
22174 .endd
22175 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22176 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22177 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22178
22179 .cindex "&'Envelope-to:'& header line"
22180 If the generic &%envelope_to_add%& option is set for a batching transport, the
22181 &'Envelope-to:'& header that is added to the message contains all the addresses
22182 that are being processed together. If you are using a batching &(appendfile)&
22183 transport without &%use_bsmtp%&, the only way to preserve the recipient
22184 addresses is to set the &%envelope_to_add%& option.
22185
22186 .cindex "&(pipe)& transport" "with multiple addresses"
22187 .vindex "&$pipe_addresses$&"
22188 If you are using a &(pipe)& transport without BSMTP, and setting the
22189 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22190 the command. This is not a true variable; it is a bit of magic that causes each
22191 of the recipient addresses to be inserted into the command as a separate
22192 argument. This provides a way of accessing all the addresses that are being
22193 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22194 are specified by a &(redirect)& router.
22195
22196
22197
22198
22199 . ////////////////////////////////////////////////////////////////////////////
22200 . ////////////////////////////////////////////////////////////////////////////
22201
22202 .chapter "The appendfile transport" "CHAPappendfile"
22203 .scindex IIDapptra1 "&(appendfile)& transport"
22204 .scindex IIDapptra2 "transports" "&(appendfile)&"
22205 .cindex "directory creation"
22206 .cindex "creating directories"
22207 The &(appendfile)& transport delivers a message by appending it to an existing
22208 file, or by creating an entirely new file in a specified directory. Single
22209 files to which messages are appended can be in the traditional Unix mailbox
22210 format, or optionally in the MBX format supported by the Pine MUA and
22211 University of Washington IMAP daemon, &'inter alia'&. When each message is
22212 being delivered as a separate file, &"maildir"& format can optionally be used
22213 to give added protection against failures that happen part-way through the
22214 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22215 supported. For all file formats, Exim attempts to create as many levels of
22216 directory as necessary, provided that &%create_directory%& is set.
22217
22218 The code for the optional formats is not included in the Exim binary by
22219 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22220 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22221 included.
22222
22223 .cindex "quota" "system"
22224 Exim recognizes system quota errors, and generates an appropriate message. Exim
22225 also supports its own quota control within the transport, for use when the
22226 system facility is unavailable or cannot be used for some reason.
22227
22228 If there is an error while appending to a file (for example, quota exceeded or
22229 partition filled), Exim attempts to reset the file's length and last
22230 modification time back to what they were before. If there is an error while
22231 creating an entirely new file, the new file is removed.
22232
22233 Before appending to a file, a number of security checks are made, and the
22234 file is locked. A detailed description is given below, after the list of
22235 private options.
22236
22237 The &(appendfile)& transport is most commonly used for local deliveries to
22238 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22239 putting messages into files for remote delivery by some means other than Exim.
22240 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22241 option).
22242
22243
22244
22245 .section "The file and directory options" "SECTfildiropt"
22246 The &%file%& option specifies a single file, to which the message is appended;
22247 the &%directory%& option specifies a directory, in which a new file containing
22248 the message is created. Only one of these two options can be set, and for
22249 normal deliveries to mailboxes, one of them &'must'& be set.
22250
22251 .vindex "&$address_file$&"
22252 .vindex "&$local_part$&"
22253 However, &(appendfile)& is also used for delivering messages to files or
22254 directories whose names (or parts of names) are obtained from alias,
22255 forwarding, or filtering operations (for example, a &%save%& command in a
22256 user's Exim filter). When such a transport is running, &$local_part$& contains
22257 the local part that was aliased or forwarded, and &$address_file$& contains the
22258 name (or partial name) of the file or directory generated by the redirection
22259 operation. There are two cases:
22260
22261 .ilist
22262 If neither &%file%& nor &%directory%& is set, the redirection operation
22263 must specify an absolute path (one that begins with &`/`&). This is the most
22264 common case when users with local accounts use filtering to sort mail into
22265 different folders. See for example, the &(address_file)& transport in the
22266 default configuration. If the path ends with a slash, it is assumed to be the
22267 name of a directory. A delivery to a directory can also be forced by setting
22268 &%maildir_format%& or &%mailstore_format%&.
22269 .next
22270 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22271 used to determine the file or directory name for the delivery. Normally, the
22272 contents of &$address_file$& are used in some way in the string expansion.
22273 .endlist
22274
22275
22276 .cindex "Sieve filter" "configuring &(appendfile)&"
22277 .cindex "Sieve filter" "relative mailbox path handling"
22278 As an example of the second case, consider an environment where users do not
22279 have home directories. They may be permitted to use Exim filter commands of the
22280 form:
22281 .code
22282 save folder23
22283 .endd
22284 or Sieve filter commands of the form:
22285 .code
22286 require "fileinto";
22287 fileinto "folder23";
22288 .endd
22289 In this situation, the expansion of &%file%& or &%directory%& in the transport
22290 must transform the relative path into an appropriate absolute filename. In the
22291 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22292 is used as a result of a &"keep"& action in the filter. This example shows one
22293 way of handling this requirement:
22294 .code
22295 file = ${if eq{$address_file}{inbox} \
22296             {/var/mail/$local_part} \
22297             {${if eq{${substr_0_1:$address_file}}{/} \
22298                   {$address_file} \
22299                   {$home/mail/$address_file} \
22300             }} \
22301        }
22302 .endd
22303 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22304 location, absolute paths are used without change, and other folders are in the
22305 &_mail_& directory within the home directory.
22306
22307 &*Note 1*&: While processing an Exim filter, a relative path such as
22308 &_folder23_& is turned into an absolute path if a home directory is known to
22309 the router. In particular, this is the case if &%check_local_user%& is set. If
22310 you want to prevent this happening at routing time, you can set
22311 &%router_home_directory%& empty. This forces the router to pass the relative
22312 path to the transport.
22313
22314 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22315 the &%file%& or &%directory%& option is still used if it is set.
22316
22317
22318
22319
22320 .section "Private options for appendfile" "SECID134"
22321 .cindex "options" "&(appendfile)& transport"
22322
22323
22324
22325 .option allow_fifo appendfile boolean false
22326 .cindex "fifo (named pipe)"
22327 .cindex "named pipe (fifo)"
22328 .cindex "pipe" "named (fifo)"
22329 Setting this option permits delivery to named pipes (FIFOs) as well as to
22330 regular files. If no process is reading the named pipe at delivery time, the
22331 delivery is deferred.
22332
22333
22334 .option allow_symlink appendfile boolean false
22335 .cindex "symbolic link" "to mailbox"
22336 .cindex "mailbox" "symbolic link"
22337 By default, &(appendfile)& will not deliver if the path name for the file is
22338 that of a symbolic link. Setting this option relaxes that constraint, but there
22339 are security issues involved in the use of symbolic links. Be sure you know
22340 what you are doing if you set this. Details of exactly what this option affects
22341 are included in the discussion which follows this list of options.
22342
22343
22344 .option batch_id appendfile string&!! unset
22345 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22346 However, batching is automatically disabled for &(appendfile)& deliveries that
22347 happen as a result of forwarding or aliasing or other redirection directly to a
22348 file.
22349
22350
22351 .option batch_max appendfile integer 1
22352 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22353
22354
22355 .option check_group appendfile boolean false
22356 When this option is set, the group owner of the file defined by the &%file%&
22357 option is checked to see that it is the same as the group under which the
22358 delivery process is running. The default setting is false because the default
22359 file mode is 0600, which means that the group is irrelevant.
22360
22361
22362 .option check_owner appendfile boolean true
22363 When this option is set, the owner of the file defined by the &%file%& option
22364 is checked to ensure that it is the same as the user under which the delivery
22365 process is running.
22366
22367
22368 .option check_string appendfile string "see below"
22369 .cindex "&""From""& line"
22370 As &(appendfile)& writes the message, the start of each line is tested for
22371 matching &%check_string%&, and if it does, the initial matching characters are
22372 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22373 a literal string, not a regular expression, and the case of any letters it
22374 contains is significant.
22375
22376 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22377 are forced to &"."& and &".."& respectively, and any settings in the
22378 configuration are ignored. Otherwise, they default to &"From&~"& and
22379 &">From&~"& when the &%file%& option is set, and unset when any of the
22380 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22381
22382 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22383 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22384 &"From&~"& indicates the start of a new message. All four options need changing
22385 if another format is used. For example, to deliver to mailboxes in MMDF format:
22386 .cindex "MMDF format mailbox"
22387 .cindex "mailbox" "MMDF format"
22388 .code
22389 check_string = "\1\1\1\1\n"
22390 escape_string = "\1\1\1\1 \n"
22391 message_prefix = "\1\1\1\1\n"
22392 message_suffix = "\1\1\1\1\n"
22393 .endd
22394 .option create_directory appendfile boolean true
22395 .cindex "directory creation"
22396 When this option is true, Exim attempts to create any missing superior
22397 directories for the file that it is about to write. A created directory's mode
22398 is given by the &%directory_mode%& option.
22399
22400 The group ownership of a newly created directory is highly dependent on the
22401 operating system (and possibly the file system) that is being used. For
22402 example, in Solaris, if the parent directory has the setgid bit set, its group
22403 is propagated to the child; if not, the currently set group is used. However,
22404 in FreeBSD, the parent's group is always used.
22405
22406
22407
22408 .option create_file appendfile string anywhere
22409 This option constrains the location of files and directories that are created
22410 by this transport. It applies to files defined by the &%file%& option and
22411 directories defined by the &%directory%& option. In the case of maildir
22412 delivery, it applies to the top level directory, not the maildir directories
22413 beneath.
22414
22415 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22416 &"belowhome"&. In the second and third cases, a home directory must have been
22417 set for the transport. This option is not useful when an explicit filename is
22418 given for normal mailbox deliveries. It is intended for the case when filenames
22419 are generated from users' &_.forward_& files. These are usually handled
22420 by an &(appendfile)& transport called &%address_file%&. See also
22421 &%file_must_exist%&.
22422
22423
22424 .option directory appendfile string&!! unset
22425 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22426 or &%directory%& must be set, unless the delivery is the direct result of a
22427 redirection (see section &<<SECTfildiropt>>&).
22428
22429 When &%directory%& is set, the string is expanded, and the message is delivered
22430 into a new file or files in or below the given directory, instead of being
22431 appended to a single mailbox file. A number of different formats are provided
22432 (see &%maildir_format%& and &%mailstore_format%&), and see section
22433 &<<SECTopdir>>& for further details of this form of delivery.
22434
22435
22436 .option directory_file appendfile string&!! "see below"
22437 .cindex "base62"
22438 .vindex "&$inode$&"
22439 When &%directory%& is set, but neither &%maildir_format%& nor
22440 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22441 whose name is obtained by expanding this string. The default value is:
22442 .code
22443 q${base62:$tod_epoch}-$inode
22444 .endd
22445 This generates a unique name from the current time, in base 62 form, and the
22446 inode of the file. The variable &$inode$& is available only when expanding this
22447 option.
22448
22449
22450 .option directory_mode appendfile "octal integer" 0700
22451 If &(appendfile)& creates any directories as a result of the
22452 &%create_directory%& option, their mode is specified by this option.
22453
22454
22455 .option escape_string appendfile string "see description"
22456 See &%check_string%& above.
22457
22458
22459 .option file appendfile string&!! unset
22460 This option is mutually exclusive with the &%directory%& option, but one of
22461 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22462 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22463 specifies a single file, to which the message is appended. One or more of
22464 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22465 &%file%&.
22466
22467 .cindex "NFS" "lock file"
22468 .cindex "locking files"
22469 .cindex "lock files"
22470 If you are using more than one host to deliver over NFS into the same
22471 mailboxes, you should always use lock files.
22472
22473 The string value is expanded for each delivery, and must yield an absolute
22474 path. The most common settings of this option are variations on one of these
22475 examples:
22476 .code
22477 file = /var/spool/mail/$local_part
22478 file = /home/$local_part/inbox
22479 file = $home/inbox
22480 .endd
22481 .cindex "&""sticky""& bit"
22482 In the first example, all deliveries are done into the same directory. If Exim
22483 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22484 create a file in the directory, so the &"sticky"& bit must be turned on for
22485 deliveries to be possible, or alternatively the &%group%& option can be used to
22486 run the delivery under a group id which has write access to the directory.
22487
22488
22489
22490 .option file_format appendfile string unset
22491 .cindex "file" "mailbox; checking existing format"
22492 This option requests the transport to check the format of an existing file
22493 before adding to it. The check consists of matching a specific string at the
22494 start of the file. The value of the option consists of an even number of
22495 colon-separated strings. The first of each pair is the test string, and the
22496 second is the name of a transport. If the transport associated with a matched
22497 string is not the current transport, control is passed over to the other
22498 transport. For example, suppose the standard &(local_delivery)& transport has
22499 this added to it:
22500 .code
22501 file_format = "From       : local_delivery :\
22502                \1\1\1\1\n : local_mmdf_delivery"
22503 .endd
22504 Mailboxes that begin with &"From"& are still handled by this transport, but if
22505 a mailbox begins with four binary ones followed by a newline, control is passed
22506 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22507 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22508 is assumed to match the current transport. If the start of a mailbox doesn't
22509 match any string, or if the transport named for a given string is not defined,
22510 delivery is deferred.
22511
22512
22513 .option file_must_exist appendfile boolean false
22514 If this option is true, the file specified by the &%file%& option must exist.
22515 A temporary error occurs if it does not, causing delivery to be deferred.
22516 If this option is false, the file is created if it does not exist.
22517
22518
22519 .option lock_fcntl_timeout appendfile time 0s
22520 .cindex "timeout" "mailbox locking"
22521 .cindex "mailbox" "locking, blocking and non-blocking"
22522 .cindex "locking files"
22523 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22524 when locking an open mailbox file. If the call fails, the delivery process
22525 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22526 Non-blocking calls are used so that the file is not kept open during the wait
22527 for the lock; the reason for this is to make it as safe as possible for
22528 deliveries over NFS in the case when processes might be accessing an NFS
22529 mailbox without using a lock file. This should not be done, but
22530 misunderstandings and hence misconfigurations are not unknown.
22531
22532 On a busy system, however, the performance of a non-blocking lock approach is
22533 not as good as using a blocking lock with a timeout. In this case, the waiting
22534 is done inside the system call, and Exim's delivery process acquires the lock
22535 and can proceed as soon as the previous lock holder releases it.
22536
22537 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22538 timeout, are used. There may still be some retrying: the maximum number of
22539 retries is
22540 .code
22541 (lock_retries * lock_interval) / lock_fcntl_timeout
22542 .endd
22543 rounded up to the next whole number. In other words, the total time during
22544 which &(appendfile)& is trying to get a lock is roughly the same, unless
22545 &%lock_fcntl_timeout%& is set very large.
22546
22547 You should consider setting this option if you are getting a lot of delayed
22548 local deliveries because of errors of the form
22549 .code
22550 failed to lock mailbox /some/file (fcntl)
22551 .endd
22552
22553 .option lock_flock_timeout appendfile time 0s
22554 This timeout applies to file locking when using &[flock()]& (see
22555 &%use_flock%&); the timeout operates in a similar manner to
22556 &%lock_fcntl_timeout%&.
22557
22558
22559 .option lock_interval appendfile time 3s
22560 This specifies the time to wait between attempts to lock the file. See below
22561 for details of locking.
22562
22563
22564 .option lock_retries appendfile integer 10
22565 This specifies the maximum number of attempts to lock the file. A value of zero
22566 is treated as 1. See below for details of locking.
22567
22568
22569 .option lockfile_mode appendfile "octal integer" 0600
22570 This specifies the mode of the created lock file, when a lock file is being
22571 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22572
22573
22574 .option lockfile_timeout appendfile time 30m
22575 .cindex "timeout" "mailbox locking"
22576 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22577 exists and is older than this value, it is assumed to have been left behind by
22578 accident, and Exim attempts to remove it.
22579
22580
22581 .option mailbox_filecount appendfile string&!! unset
22582 .cindex "mailbox" "specifying size of"
22583 .cindex "size" "of mailbox"
22584 If this option is set, it is expanded, and the result is taken as the current
22585 number of files in the mailbox. It must be a decimal number, optionally
22586 followed by K or M. This provides a way of obtaining this information from an
22587 external source that maintains the data.
22588
22589
22590 .option mailbox_size appendfile string&!! unset
22591 .cindex "mailbox" "specifying size of"
22592 .cindex "size" "of mailbox"
22593 If this option is set, it is expanded, and the result is taken as the current
22594 size the mailbox. It must be a decimal number, optionally followed by K or M.
22595 This provides a way of obtaining this information from an external source that
22596 maintains the data. This is likely to be helpful for maildir deliveries where
22597 it is computationally expensive to compute the size of a mailbox.
22598
22599
22600
22601 .option maildir_format appendfile boolean false
22602 .cindex "maildir format" "specifying"
22603 If this option is set with the &%directory%& option, the delivery is into a new
22604 file, in the &"maildir"& format that is used by other mail software. When the
22605 transport is activated directly from a &(redirect)& router (for example, the
22606 &(address_file)& transport in the default configuration), setting
22607 &%maildir_format%& causes the path received from the router to be treated as a
22608 directory, whether or not it ends with &`/`&. This option is available only if
22609 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22610 &<<SECTmaildirdelivery>>& below for further details.
22611
22612
22613 .option maildir_quota_directory_regex appendfile string "See below"
22614 .cindex "maildir format" "quota; directories included in"
22615 .cindex "quota" "maildir; directories included in"
22616 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22617 a regular expression for specifying directories, relative to the quota
22618 directory (see &%quota_directory%&), that should be included in the quota
22619 calculation. The default value is:
22620 .code
22621 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22622 .endd
22623 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22624 (directories whose names begin with a dot). If you want to exclude the
22625 &_Trash_&
22626 folder from the count (as some sites do), you need to change this setting to
22627 .code
22628 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22629 .endd
22630 This uses a negative lookahead in the regular expression to exclude the
22631 directory whose name is &_.Trash_&. When a directory is excluded from quota
22632 calculations, quota processing is bypassed for any messages that are delivered
22633 directly into that directory.
22634
22635
22636 .option maildir_retries appendfile integer 10
22637 This option specifies the number of times to retry when writing a file in
22638 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22639
22640
22641 .option maildir_tag appendfile string&!! unset
22642 This option applies only to deliveries in maildir format, and is described in
22643 section &<<SECTmaildirdelivery>>& below.
22644
22645
22646 .option maildir_use_size_file appendfile&!! boolean false
22647 .cindex "maildir format" "&_maildirsize_& file"
22648 The result of string expansion for this option must be a valid boolean value.
22649 If it is true, it enables support for &_maildirsize_& files. Exim
22650 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22651 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22652 value is zero. See &%maildir_quota_directory_regex%& above and section
22653 &<<SECTmaildirdelivery>>& below for further details.
22654
22655 .option maildirfolder_create_regex appendfile string unset
22656 .cindex "maildir format" "&_maildirfolder_& file"
22657 .cindex "&_maildirfolder_&, creating"
22658 The value of this option is a regular expression. If it is unset, it has no
22659 effect. Otherwise, before a maildir delivery takes place, the pattern is
22660 matched against the name of the maildir directory, that is, the directory
22661 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22662 delivery. If there is a match, Exim checks for the existence of a file called
22663 &_maildirfolder_& in the directory, and creates it if it does not exist.
22664 See section &<<SECTmaildirdelivery>>& for more details.
22665
22666
22667 .option mailstore_format appendfile boolean false
22668 .cindex "mailstore format" "specifying"
22669 If this option is set with the &%directory%& option, the delivery is into two
22670 new files in  &"mailstore"& format. The option is available only if
22671 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22672 below for further details.
22673
22674
22675 .option mailstore_prefix appendfile string&!! unset
22676 This option applies only to deliveries in mailstore format, and is described in
22677 section &<<SECTopdir>>& below.
22678
22679
22680 .option mailstore_suffix appendfile string&!! unset
22681 This option applies only to deliveries in mailstore format, and is described in
22682 section &<<SECTopdir>>& below.
22683
22684
22685 .option mbx_format appendfile boolean false
22686 .cindex "locking files"
22687 .cindex "file" "locking"
22688 .cindex "file" "MBX format"
22689 .cindex "MBX format, specifying"
22690 This option is available only if Exim has been compiled with SUPPORT_MBX
22691 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22692 the message is appended to the mailbox file in MBX format instead of
22693 traditional Unix format. This format is supported by Pine4 and its associated
22694 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22695
22696 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22697 automatically changed by the use of &%mbx_format%&. They should normally be set
22698 empty when using MBX format, so this option almost always appears in this
22699 combination:
22700 .code
22701 mbx_format = true
22702 message_prefix =
22703 message_suffix =
22704 .endd
22705 If none of the locking options are mentioned in the configuration,
22706 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22707 is possible to specify the other kinds of locking with &%mbx_format%&, but
22708 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22709 interworks with &'c-client'&, providing for shared access to the mailbox. It
22710 should not be used if any program that does not use this form of locking is
22711 going to access the mailbox, nor should it be used if the mailbox file is NFS
22712 mounted, because it works only when the mailbox is accessed from a single host.
22713
22714 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22715 the standard version of &'c-client'&, because as long as it has a mailbox open
22716 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22717 append messages to it.
22718
22719
22720 .option message_prefix appendfile string&!! "see below"
22721 .cindex "&""From""& line"
22722 The string specified here is expanded and output at the start of every message.
22723 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22724 in which case it is:
22725 .code
22726 message_prefix = "From ${if def:return_path{$return_path}\
22727   {MAILER-DAEMON}} $tod_bsdinbox\n"
22728 .endd
22729 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22730 &`\n`& to &`\r\n`& in &%message_prefix%&.
22731
22732 .option message_suffix appendfile string&!! "see below"
22733 The string specified here is expanded and output at the end of every message.
22734 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22735 in which case it is a single newline character. The suffix can be suppressed by
22736 setting
22737 .code
22738 message_suffix =
22739 .endd
22740 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22741 &`\n`& to &`\r\n`& in &%message_suffix%&.
22742
22743 .option mode appendfile "octal integer" 0600
22744 If the output file is created, it is given this mode. If it already exists and
22745 has wider permissions, they are reduced to this mode. If it has narrower
22746 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22747 if the delivery is the result of a &%save%& command in a filter file specifying
22748 a particular mode, the mode of the output file is always forced to take that
22749 value, and this option is ignored.
22750
22751
22752 .option mode_fail_narrower appendfile boolean true
22753 This option applies in the case when an existing mailbox file has a narrower
22754 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22755 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22756 continues with the delivery attempt, using the existing mode of the file.
22757
22758
22759 .option notify_comsat appendfile boolean false
22760 If this option is true, the &'comsat'& daemon is notified after every
22761 successful delivery to a user mailbox. This is the daemon that notifies logged
22762 on users about incoming mail.
22763
22764
22765 .option quota appendfile string&!! unset
22766 .cindex "quota" "imposed by Exim"
22767 This option imposes a limit on the size of the file to which Exim is appending,
22768 or to the total space used in the directory tree when the &%directory%& option
22769 is set. In the latter case, computation of the space used is expensive, because
22770 all the files in the directory (and any sub-directories) have to be
22771 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22772 &%maildir_use_size_file%& for ways to avoid this in environments where users
22773 have no shell access to their mailboxes).
22774
22775 As there is no interlock against two simultaneous deliveries into a
22776 multi-file mailbox, it is possible for the quota to be overrun in this case.
22777 For single-file mailboxes, of course, an interlock is a necessity.
22778
22779 A file's size is taken as its &'used'& value. Because of blocking effects, this
22780 may be a lot less than the actual amount of disk space allocated to the file.
22781 If the sizes of a number of files are being added up, the rounding effect can
22782 become quite noticeable, especially on systems that have large block sizes.
22783 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22784 the obvious value which users understand most easily.
22785
22786 The value of the option is expanded, and must then be a numerical value
22787 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22788 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22789 and further option modifiers. If Exim is running on a system with
22790 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22791 be handled.
22792
22793 The option modifier &%no_check%& can be used to force delivery even if the over
22794 quota condition is met. The quota gets updated as usual.
22795
22796 &*Note*&: A value of zero is interpreted as &"no quota"&.
22797
22798 The expansion happens while Exim is running as root, before it changes uid for
22799 the delivery. This means that files that are inaccessible to the end user can
22800 be used to hold quota values that are looked up in the expansion. When delivery
22801 fails because this quota is exceeded, the handling of the error is as for
22802 system quota failures.
22803
22804 By default, Exim's quota checking mimics system quotas, and restricts the
22805 mailbox to the specified maximum size, though the value is not accurate to the
22806 last byte, owing to separator lines and additional headers that may get added
22807 during message delivery. When a mailbox is nearly full, large messages may get
22808 refused even though small ones are accepted, because the size of the current
22809 message is added to the quota when the check is made. This behaviour can be
22810 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22811 for exceeding the quota does not include the current message. Thus, deliveries
22812 continue until the quota has been exceeded; thereafter, no further messages are
22813 delivered. See also &%quota_warn_threshold%&.
22814
22815
22816 .option quota_directory appendfile string&!! unset
22817 This option defines the directory to check for quota purposes when delivering
22818 into individual files. The default is the delivery directory, or, if a file
22819 called &_maildirfolder_& exists in a maildir directory, the parent of the
22820 delivery directory.
22821
22822
22823 .option quota_filecount appendfile string&!! 0
22824 This option applies when the &%directory%& option is set. It limits the total
22825 number of files in the directory (compare the inode limit in system quotas). It
22826 can only be used if &%quota%& is also set. The value is expanded; an expansion
22827 failure causes delivery to be deferred. A value of zero is interpreted as
22828 &"no quota"&.
22829
22830 The option modifier &%no_check%& can be used to force delivery even if the over
22831 quota condition is met. The quota gets updated as usual.
22832
22833 .option quota_is_inclusive appendfile boolean true
22834 See &%quota%& above.
22835
22836
22837 .option quota_size_regex appendfile string unset
22838 This option applies when one of the delivery modes that writes a separate file
22839 for each message is being used. When Exim wants to find the size of one of
22840 these files in order to test the quota, it first checks &%quota_size_regex%&.
22841 If this is set to a regular expression that matches the filename, and it
22842 captures one string, that string is interpreted as a representation of the
22843 file's size. The value of &%quota_size_regex%& is not expanded.
22844
22845 This feature is useful only when users have no shell access to their mailboxes
22846 &-- otherwise they could defeat the quota simply by renaming the files. This
22847 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22848 the file length to the filename. For example:
22849 .code
22850 maildir_tag = ,S=$message_size
22851 quota_size_regex = ,S=(\d+)
22852 .endd
22853 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22854 number of lines in the message.
22855
22856 The regular expression should not assume that the length is at the end of the
22857 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22858 sometimes add other information onto the ends of message filenames.
22859
22860 Section &<<SECID136>>& contains further information.
22861
22862 .new
22863 This option should not be used when other message-handling software
22864 may duplicate messages by making hardlinks to the files.  When that is done Exim
22865 will count the message size once for each filename, in contrast with the actual
22866 disk usage.  When the option is not set, calculating total usage requires
22867 a system-call per file to get the size; the number of links is then available also
22868 as is used to adjust the effective size.
22869 .wen
22870
22871
22872 .option quota_warn_message appendfile string&!! "see below"
22873 See below for the use of this option. If it is not set when
22874 &%quota_warn_threshold%& is set, it defaults to
22875 .code
22876 quota_warn_message = "\
22877   To: $local_part@$domain\n\
22878   Subject: Your mailbox\n\n\
22879   This message is automatically created \
22880   by mail delivery software.\n\n\
22881   The size of your mailbox has exceeded \
22882   a warning threshold that is\n\
22883   set by the system administrator.\n"
22884 .endd
22885
22886
22887 .option quota_warn_threshold appendfile string&!! 0
22888 .cindex "quota" "warning threshold"
22889 .cindex "mailbox" "size warning"
22890 .cindex "size" "of mailbox"
22891 This option is expanded in the same way as &%quota%& (see above). If the
22892 resulting value is greater than zero, and delivery of the message causes the
22893 size of the file or total space in the directory tree to cross the given
22894 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22895 may be specified as a percentage of it by following the value with a percent
22896 sign. For example:
22897 .code
22898 quota = 10M
22899 quota_warn_threshold = 75%
22900 .endd
22901 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22902 percent sign is ignored.
22903
22904 The warning message itself is specified by the &%quota_warn_message%& option,
22905 and it must start with a &'To:'& header line containing the recipient(s) of the
22906 warning message. These do not necessarily have to include the recipient(s) of
22907 the original message. A &'Subject:'& line should also normally be supplied. You
22908 can include any other header lines that you want. If you do not include a
22909 &'From:'& line, the default is:
22910 .code
22911 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22912 .endd
22913 .oindex &%errors_reply_to%&
22914 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22915 option.
22916
22917 The &%quota%& option does not have to be set in order to use this option; they
22918 are independent of one another except when the threshold is specified as a
22919 percentage.
22920
22921
22922 .option use_bsmtp appendfile boolean false
22923 .cindex "envelope from"
22924 .cindex "envelope sender"
22925 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22926 format, with the envelope sender and recipient(s) included as SMTP commands. If
22927 you want to include a leading HELO command with such messages, you can do
22928 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22929 for details of batch SMTP.
22930
22931
22932 .option use_crlf appendfile boolean false
22933 .cindex "carriage return"
22934 .cindex "linefeed"
22935 This option causes lines to be terminated with the two-character CRLF sequence
22936 (carriage return, linefeed) instead of just a linefeed character. In the case
22937 of batched SMTP, the byte sequence written to the file is then an exact image
22938 of what would be sent down a real SMTP connection.
22939
22940 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22941 (which are used to supply the traditional &"From&~"& and blank line separators
22942 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22943 carriage return characters if these are needed. In cases where these options
22944 have non-empty defaults, the values end with a single linefeed, so they must be
22945 changed to end with &`\r\n`& if &%use_crlf%& is set.
22946
22947
22948 .option use_fcntl_lock appendfile boolean "see below"
22949 This option controls the use of the &[fcntl()]& function to lock a file for
22950 exclusive use when a message is being appended. It is set by default unless
22951 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22952 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22953 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22954
22955
22956 .option use_flock_lock appendfile boolean false
22957 This option is provided to support the use of &[flock()]& for file locking, for
22958 the few situations where it is needed. Most modern operating systems support
22959 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22960 each other. Exim uses &[fcntl()]& locking by default.
22961
22962 This option is required only if you are using an operating system where
22963 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22964 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22965 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22966
22967 .cindex "Solaris" "&[flock()]& support"
22968 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22969 have it (and some, I think, provide a not quite right version built on top of
22970 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22971 the ability to use it, and any attempt to do so will cause a configuration
22972 error.
22973
22974 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22975 is just being mapped onto &[fcntl()]& by the OS).
22976
22977
22978 .option use_lockfile appendfile boolean "see below"
22979 If this option is turned off, Exim does not attempt to create a lock file when
22980 appending to a mailbox file. In this situation, the only locking is by
22981 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22982 sure that every MUA that is ever going to look at your users' mailboxes uses
22983 &[fcntl()]& rather than a lock file, and even then only when you are not
22984 delivering over NFS from more than one host.
22985
22986 .cindex "NFS" "lock file"
22987 In order to append to an NFS file safely from more than one host, it is
22988 necessary to take out a lock &'before'& opening the file, and the lock file
22989 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22990 file corruption.
22991
22992 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22993 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22994 except when &%mbx_format%& is set.
22995
22996
22997 .option use_mbx_lock appendfile boolean "see below"
22998 This option is available only if Exim has been compiled with SUPPORT_MBX
22999 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23000 locking rules be used. It is set by default if &%mbx_format%& is set and none
23001 of the locking options are mentioned in the configuration. The locking rules
23002 are the same as are used by the &'c-client'& library that underlies Pine and
23003 the IMAP4 and POP daemons that come with it (see the discussion below). The
23004 rules allow for shared access to the mailbox. However, this kind of locking
23005 does not work when the mailbox is NFS mounted.
23006
23007 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23008 &%use_flock_lock%& to control what kind of locking is used in implementing the
23009 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23010 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23011
23012
23013
23014
23015 .section "Operational details for appending" "SECTopappend"
23016 .cindex "appending to a file"
23017 .cindex "file" "appending"
23018 Before appending to a file, the following preparations are made:
23019
23020 .ilist
23021 If the name of the file is &_/dev/null_&, no action is taken, and a success
23022 return is given.
23023
23024 .next
23025 .cindex "directory creation"
23026 If any directories on the file's path are missing, Exim creates them if the
23027 &%create_directory%& option is set. A created directory's mode is given by the
23028 &%directory_mode%& option.
23029
23030 .next
23031 If &%file_format%& is set, the format of an existing file is checked. If this
23032 indicates that a different transport should be used, control is passed to that
23033 transport.
23034
23035 .next
23036 .cindex "file" "locking"
23037 .cindex "locking files"
23038 .cindex "NFS" "lock file"
23039 If &%use_lockfile%& is set, a lock file is built in a way that will work
23040 reliably over NFS, as follows:
23041
23042 .olist
23043 Create a &"hitching post"& file whose name is that of the lock file with the
23044 current time, primary host name, and process id added, by opening for writing
23045 as a new file. If this fails with an access error, delivery is deferred.
23046 .next
23047 Close the hitching post file, and hard link it to the lock filename.
23048 .next
23049 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23050 Unlink the hitching post name.
23051 .next
23052 Otherwise, use &[stat()]& to get information about the hitching post file, and
23053 then unlink hitching post name. If the number of links is exactly two, creation
23054 of the lock file succeeded but something (for example, an NFS server crash and
23055 restart) caused this fact not to be communicated to the &[link()]& call.
23056 .next
23057 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23058 up to &%lock_retries%& times. However, since any program that writes to a
23059 mailbox should complete its task very quickly, it is reasonable to time out old
23060 lock files that are normally the result of user agent and system crashes. If an
23061 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23062 it before trying again.
23063 .endlist olist
23064
23065 .next
23066 A call is made to &[lstat()]& to discover whether the main file exists, and if
23067 so, what its characteristics are. If &[lstat()]& fails for any reason other
23068 than non-existence, delivery is deferred.
23069
23070 .next
23071 .cindex "symbolic link" "to mailbox"
23072 .cindex "mailbox" "symbolic link"
23073 If the file does exist and is a symbolic link, delivery is deferred, unless the
23074 &%allow_symlink%& option is set, in which case the ownership of the link is
23075 checked, and then &[stat()]& is called to find out about the real file, which
23076 is then subjected to the checks below. The check on the top-level link
23077 ownership prevents one user creating a link for another's mailbox in a sticky
23078 directory, though allowing symbolic links in this case is definitely not a good
23079 idea. If there is a chain of symbolic links, the intermediate ones are not
23080 checked.
23081
23082 .next
23083 If the file already exists but is not a regular file, or if the file's owner
23084 and group (if the group is being checked &-- see &%check_group%& above) are
23085 different from the user and group under which the delivery is running,
23086 delivery is deferred.
23087
23088 .next
23089 If the file's permissions are more generous than specified, they are reduced.
23090 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23091 is set false, in which case the delivery is tried using the existing
23092 permissions.
23093
23094 .next
23095 The file's inode number is saved, and the file is then opened for appending.
23096 If this fails because the file has vanished, &(appendfile)& behaves as if it
23097 hadn't existed (see below). For any other failures, delivery is deferred.
23098
23099 .next
23100 If the file is opened successfully, check that the inode number hasn't
23101 changed, that it is still a regular file, and that the owner and permissions
23102 have not changed. If anything is wrong, defer delivery and freeze the message.
23103
23104 .next
23105 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23106 option is set. Otherwise, check that the file is being created in a permitted
23107 directory if the &%create_file%& option is set (deferring on failure), and then
23108 open for writing as a new file, with the O_EXCL and O_CREAT options,
23109 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23110 set). In this case, which can happen if the link points to a non-existent file,
23111 the file is opened for writing using O_CREAT but not O_EXCL, because
23112 that prevents link following.
23113
23114 .next
23115 .cindex "loop" "while file testing"
23116 If opening fails because the file exists, obey the tests given above for
23117 existing files. However, to avoid looping in a situation where the file is
23118 being continuously created and destroyed, the exists/not-exists loop is broken
23119 after 10 repetitions, and the message is then frozen.
23120
23121 .next
23122 If opening fails with any other error, defer delivery.
23123
23124 .next
23125 .cindex "file" "locking"
23126 .cindex "locking files"
23127 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23128 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23129 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23130 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23131 file, and an exclusive lock on the file whose name is
23132 .code
23133 /tmp/.<device-number>.<inode-number>
23134 .endd
23135 using the device and inode numbers of the open mailbox file, in accordance with
23136 the MBX locking rules. This file is created with a mode that is specified by
23137 the &%lockfile_mode%& option.
23138
23139 If Exim fails to lock the file, there are two possible courses of action,
23140 depending on the value of the locking timeout. This is obtained from
23141 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23142
23143 If the timeout value is zero, the file is closed, Exim waits for
23144 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23145 to lock it again. This happens up to &%lock_retries%& times, after which the
23146 delivery is deferred.
23147
23148 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23149 &[flock()]& are used (with the given timeout), so there has already been some
23150 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23151 immediately. It retries up to
23152 .code
23153 (lock_retries * lock_interval) / <timeout>
23154 .endd
23155 times (rounded up).
23156 .endlist
23157
23158 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23159 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23160
23161
23162 .section "Operational details for delivery to a new file" "SECTopdir"
23163 .cindex "delivery" "to single file"
23164 .cindex "&""From""& line"
23165 When the &%directory%& option is set instead of &%file%&, each message is
23166 delivered into a newly-created file or set of files. When &(appendfile)& is
23167 activated directly from a &(redirect)& router, neither &%file%& nor
23168 &%directory%& is normally set, because the path for delivery is supplied by the
23169 router. (See for example, the &(address_file)& transport in the default
23170 configuration.) In this case, delivery is to a new file if either the path name
23171 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23172
23173 No locking is required while writing the message to a new file, so the various
23174 locking options of the transport are ignored. The &"From"& line that by default
23175 separates messages in a single file is not normally needed, nor is the escaping
23176 of message lines that start with &"From"&, and there is no need to ensure a
23177 newline at the end of each message. Consequently, the default values for
23178 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23179 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23180
23181 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23182 the files in the delivery directory by default. However, you can specify a
23183 different directory by setting &%quota_directory%&. Also, for maildir
23184 deliveries (see below) the &_maildirfolder_& convention is honoured.
23185
23186
23187 .cindex "maildir format"
23188 .cindex "mailstore format"
23189 There are three different ways in which delivery to individual files can be
23190 done, controlled by the settings of the &%maildir_format%& and
23191 &%mailstore_format%& options. Note that code to support maildir or mailstore
23192 formats is not included in the binary unless SUPPORT_MAILDIR or
23193 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23194
23195 .cindex "directory creation"
23196 In all three cases an attempt is made to create the directory and any necessary
23197 sub-directories if they do not exist, provided that the &%create_directory%&
23198 option is set (the default). The location of a created directory can be
23199 constrained by setting &%create_file%&. A created directory's mode is given by
23200 the &%directory_mode%& option. If creation fails, or if the
23201 &%create_directory%& option is not set when creation is required, delivery is
23202 deferred.
23203
23204
23205
23206 .section "Maildir delivery" "SECTmaildirdelivery"
23207 .cindex "maildir format" "description of"
23208 If the &%maildir_format%& option is true, Exim delivers each message by writing
23209 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23210 directory that is defined by the &%directory%& option (the &"delivery
23211 directory"&). If the delivery is successful, the file is renamed into the
23212 &_new_& subdirectory.
23213
23214 In the filename, <&'stime'&> is the current time of day in seconds, and
23215 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23216 Exim checks that the time-of-day clock has moved on by at least one microsecond
23217 before terminating the delivery process. This guarantees uniqueness for the
23218 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23219 opening it. If any response other than ENOENT (does not exist) is given,
23220 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23221
23222 Before Exim carries out a maildir delivery, it ensures that subdirectories
23223 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23224 do not exist, Exim tries to create them and any superior directories in their
23225 path, subject to the &%create_directory%& and &%create_file%& options. If the
23226 &%maildirfolder_create_regex%& option is set, and the regular expression it
23227 contains matches the delivery directory, Exim also ensures that a file called
23228 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23229 &_maildirfolder_& file cannot be created, delivery is deferred.
23230
23231 These features make it possible to use Exim to create all the necessary files
23232 and directories in a maildir mailbox, including subdirectories for maildir++
23233 folders. Consider this example:
23234 .code
23235 maildir_format = true
23236 directory = /var/mail/$local_part\
23237            ${if eq{$local_part_suffix}{}{}\
23238            {/.${substr_1:$local_part_suffix}}}
23239 maildirfolder_create_regex = /\.[^/]+$
23240 .endd
23241 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23242 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23243 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23244 not match this name, so Exim will not look for or create the file
23245 &_/var/mail/pimbo/maildirfolder_&, though it will create
23246 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23247
23248 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23249 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23250 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23251 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23252 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23253
23254 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23255 not inadvertently match the toplevel maildir directory, because a
23256 &_maildirfolder_& file at top level would completely break quota calculations.
23257
23258 .cindex "quota" "in maildir delivery"
23259 .cindex "maildir++"
23260 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23261 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23262 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23263 Exim assumes the directory is a maildir++ folder directory, which is one level
23264 down from the user's top level mailbox directory. This causes it to start at
23265 the parent directory instead of the current directory when calculating the
23266 amount of space used.
23267
23268 One problem with delivering into a multi-file mailbox is that it is
23269 computationally expensive to compute the size of the mailbox for quota
23270 checking. Various approaches have been taken to reduce the amount of work
23271 needed. The next two sections describe two of them. A third alternative is to
23272 use some external process for maintaining the size data, and use the expansion
23273 of the &%mailbox_size%& option as a way of importing it into Exim.
23274
23275
23276
23277
23278 .section "Using tags to record message sizes" "SECID135"
23279 If &%maildir_tag%& is set, the string is expanded for each delivery.
23280 When the maildir file is renamed into the &_new_& sub-directory, the
23281 tag is added to its name. However, if adding the tag takes the length of the
23282 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23283 the tag is dropped and the maildir file is created with no tag.
23284
23285
23286 .vindex "&$message_size$&"
23287 Tags can be used to encode the size of files in their names; see
23288 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23289 happens after the message has been written. The value of the &$message_size$&
23290 variable is set to the number of bytes actually written. If the expansion is
23291 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23292 be deferred. The expanded tag may contain any printing characters except &"/"&.
23293 Non-printing characters in the string are ignored; if the resulting string is
23294 empty, it is ignored. If it starts with an alphanumeric character, a leading
23295 colon is inserted; this default has not proven to be the path that popular
23296 maildir implementations have chosen (but changing it in Exim would break
23297 backwards compatibility).
23298
23299 For one common implementation, you might set:
23300 .code
23301 maildir_tag = ,S=${message_size}
23302 .endd
23303 but you should check the documentation of the other software to be sure.
23304
23305 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23306 as this allows Exim to extract the size from your tag, instead of having to
23307 &[stat()]& each message file.
23308
23309
23310 .section "Using a maildirsize file" "SECID136"
23311 .cindex "quota" "in maildir delivery"
23312 .cindex "maildir format" "&_maildirsize_& file"
23313 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23314 storing quota and message size information in a file called &_maildirsize_&
23315 within the toplevel maildir directory. If this file does not exist, Exim
23316 creates it, setting the quota from the &%quota%& option of the transport. If
23317 the maildir directory itself does not exist, it is created before any attempt
23318 to write a &_maildirsize_& file.
23319
23320 The &_maildirsize_& file is used to hold information about the sizes of
23321 messages in the maildir, thus speeding up quota calculations. The quota value
23322 in the file is just a cache; if the quota is changed in the transport, the new
23323 value overrides the cached value when the next message is delivered. The cache
23324 is maintained for the benefit of other programs that access the maildir and
23325 need to know the quota.
23326
23327 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23328 file is maintained (with a zero quota setting), but no quota is imposed.
23329
23330 A regular expression is available for controlling which directories in the
23331 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23332 See the description of the &%maildir_quota_directory_regex%& option above for
23333 details.
23334
23335
23336 .section "Mailstore delivery" "SECID137"
23337 .cindex "mailstore format" "description of"
23338 If the &%mailstore_format%& option is true, each message is written as two
23339 files in the given directory. A unique base name is constructed from the
23340 message id and the current delivery process, and the files that are written use
23341 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23342 contains the message's envelope, and the &_.msg_& file contains the message
23343 itself. The base name is placed in the variable &$mailstore_basename$&.
23344
23345 During delivery, the envelope is first written to a file with the suffix
23346 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23347 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23348 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23349 file before accessing either of them. An alternative approach is to wait for
23350 the absence of a &_.tmp_& file.
23351
23352 The envelope file starts with any text defined by the &%mailstore_prefix%&
23353 option, expanded and terminated by a newline if there isn't one. Then follows
23354 the sender address on one line, then all the recipient addresses, one per line.
23355 There can be more than one recipient only if the &%batch_max%& option is set
23356 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23357 appended to the file, followed by a newline if it does not end with one.
23358
23359 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23360 failure, it is ignored. Other expansion errors are treated as serious
23361 configuration errors, and delivery is deferred. The variable
23362 &$mailstore_basename$& is available for use during these expansions.
23363
23364
23365 .section "Non-special new file delivery" "SECID138"
23366 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23367 file is created directly in the named directory. For example, when delivering
23368 messages into files in batched SMTP format for later delivery to some host (see
23369 section &<<SECTbatchSMTP>>&), a setting such as
23370 .code
23371 directory = /var/bsmtp/$host
23372 .endd
23373 might be used. A message is written to a file with a temporary name, which is
23374 then renamed when the delivery is complete. The final name is obtained by
23375 expanding the contents of the &%directory_file%& option.
23376 .ecindex IIDapptra1
23377 .ecindex IIDapptra2
23378
23379
23380
23381
23382
23383
23384 . ////////////////////////////////////////////////////////////////////////////
23385 . ////////////////////////////////////////////////////////////////////////////
23386
23387 .chapter "The autoreply transport" "CHID8"
23388 .scindex IIDauttra1 "transports" "&(autoreply)&"
23389 .scindex IIDauttra2 "&(autoreply)& transport"
23390 The &(autoreply)& transport is not a true transport in that it does not cause
23391 the message to be transmitted. Instead, it generates a new mail message as an
23392 automatic reply to the incoming message. &'References:'& and
23393 &'Auto-Submitted:'& header lines are included. These are constructed according
23394 to the rules in RFCs 2822 and 3834, respectively.
23395
23396 If the router that passes the message to this transport does not have the
23397 &%unseen%& option set, the original message (for the current recipient) is not
23398 delivered anywhere. However, when the &%unseen%& option is set on the router
23399 that passes the message to this transport, routing of the address continues, so
23400 another router can set up a normal message delivery.
23401
23402
23403 The &(autoreply)& transport is usually run as the result of mail filtering, a
23404 &"vacation"& message being the standard example. However, it can also be run
23405 directly from a router like any other transport. To reduce the possibility of
23406 message cascades, messages created by the &(autoreply)& transport always have
23407 empty envelope sender addresses, like bounce messages.
23408
23409 The parameters of the message to be sent can be specified in the configuration
23410 by options described below. However, these are used only when the address
23411 passed to the transport does not contain its own reply information. When the
23412 transport is run as a consequence of a
23413 &%mail%&
23414 or &%vacation%& command in a filter file, the parameters of the message are
23415 supplied by the filter, and passed with the address. The transport's options
23416 that define the message are then ignored (so they are not usually set in this
23417 case). The message is specified entirely by the filter or by the transport; it
23418 is never built from a mixture of options. However, the &%file_optional%&,
23419 &%mode%&, and &%return_message%& options apply in all cases.
23420
23421 &(Autoreply)& is implemented as a local transport. When used as a result of a
23422 command in a user's filter file, &(autoreply)& normally runs under the uid and
23423 gid of the user, and with appropriate current and home directories (see chapter
23424 &<<CHAPenvironment>>&).
23425
23426 There is a subtle difference between routing a message to a &(pipe)& transport
23427 that generates some text to be returned to the sender, and routing it to an
23428 &(autoreply)& transport. This difference is noticeable only if more than one
23429 address from the same message is so handled. In the case of a pipe, the
23430 separate outputs from the different addresses are gathered up and returned to
23431 the sender in a single message, whereas if &(autoreply)& is used, a separate
23432 message is generated for each address that is passed to it.
23433
23434 Non-printing characters are not permitted in the header lines generated for the
23435 message that &(autoreply)& creates, with the exception of newlines that are
23436 immediately followed by white space. If any non-printing characters are found,
23437 the transport defers.
23438 Whether characters with the top bit set count as printing characters or not is
23439 controlled by the &%print_topbitchars%& global option.
23440
23441 If any of the generic options for manipulating headers (for example,
23442 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23443 of the original message that is included in the generated message when
23444 &%return_message%& is set. They do not apply to the generated message itself.
23445
23446 .vindex "&$sender_address$&"
23447 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23448 the message, indicating that there were no recipients, it does not treat this
23449 as an error. This means that autoreplies sent to &$sender_address$& when this
23450 is empty (because the incoming message is a bounce message) do not cause
23451 problems. They are just discarded.
23452
23453
23454
23455 .section "Private options for autoreply" "SECID139"
23456 .cindex "options" "&(autoreply)& transport"
23457
23458 .option bcc autoreply string&!! unset
23459 This specifies the addresses that are to receive &"blind carbon copies"& of the
23460 message when the message is specified by the transport.
23461
23462
23463 .option cc autoreply string&!! unset
23464 This specifies recipients of the message and the contents of the &'Cc:'& header
23465 when the message is specified by the transport.
23466
23467
23468 .option file autoreply string&!! unset
23469 The contents of the file are sent as the body of the message when the message
23470 is specified by the transport. If both &%file%& and &%text%& are set, the text
23471 string comes first.
23472
23473
23474 .option file_expand autoreply boolean false
23475 If this is set, the contents of the file named by the &%file%& option are
23476 subjected to string expansion as they are added to the message.
23477
23478
23479 .option file_optional autoreply boolean false
23480 If this option is true, no error is generated if the file named by the &%file%&
23481 option or passed with the address does not exist or cannot be read.
23482
23483
23484 .option from autoreply string&!! unset
23485 This specifies the contents of the &'From:'& header when the message is
23486 specified by the transport.
23487
23488
23489 .option headers autoreply string&!! unset
23490 This specifies additional RFC 2822 headers that are to be added to the message
23491 when the message is specified by the transport. Several can be given by using
23492 &"\n"& to separate them. There is no check on the format.
23493
23494
23495 .option log autoreply string&!! unset
23496 This option names a file in which a record of every message sent is logged when
23497 the message is specified by the transport.
23498
23499
23500 .option mode autoreply "octal integer" 0600
23501 If either the log file or the &"once"& file has to be created, this mode is
23502 used.
23503
23504
23505 .option never_mail autoreply "address list&!!" unset
23506 If any run of the transport creates a message with a recipient that matches any
23507 item in the list, that recipient is quietly discarded. If all recipients are
23508 discarded, no message is created. This applies both when the recipients are
23509 generated by a filter and when they are specified in the transport.
23510
23511
23512
23513 .option once autoreply string&!! unset
23514 This option names a file or DBM database in which a record of each &'To:'&
23515 recipient is kept when the message is specified by the transport. &*Note*&:
23516 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23517
23518 If &%once%& is unset, or is set to an empty string, the message is always sent.
23519 By default, if &%once%& is set to a non-empty filename, the message
23520 is not sent if a potential recipient is already listed in the database.
23521 However, if the &%once_repeat%& option specifies a time greater than zero, the
23522 message is sent if that much time has elapsed since a message was last sent to
23523 this recipient. A setting of zero time for &%once_repeat%& (the default)
23524 prevents a message from being sent a second time &-- in this case, zero means
23525 infinity.
23526
23527 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23528 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23529 greater than zero, it changes the way Exim implements the &%once%& option.
23530 Instead of using a DBM file to record every recipient it sends to, it uses a
23531 regular file, whose size will never get larger than the given value.
23532
23533 In the file, Exim keeps a linear list of recipient addresses and the times at
23534 which they were sent messages. If the file is full when a new address needs to
23535 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23536 means that a given recipient may receive multiple messages, but at
23537 unpredictable intervals that depend on the rate of turnover of addresses in the
23538 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23539
23540
23541 .option once_file_size autoreply integer 0
23542 See &%once%& above.
23543
23544
23545 .option once_repeat autoreply time&!! 0s
23546 See &%once%& above.
23547 After expansion, the value of this option must be a valid time value.
23548
23549
23550 .option reply_to autoreply string&!! unset
23551 This specifies the contents of the &'Reply-To:'& header when the message is
23552 specified by the transport.
23553
23554
23555 .option return_message autoreply boolean false
23556 If this is set, a copy of the original message is returned with the new
23557 message, subject to the maximum size set in the &%return_size_limit%& global
23558 configuration option.
23559
23560
23561 .option subject autoreply string&!! unset
23562 This specifies the contents of the &'Subject:'& header when the message is
23563 specified by the transport. It is tempting to quote the original subject in
23564 automatic responses. For example:
23565 .code
23566 subject = Re: $h_subject:
23567 .endd
23568 There is a danger in doing this, however. It may allow a third party to
23569 subscribe your users to an opt-in mailing list, provided that the list accepts
23570 bounce messages as subscription confirmations. Well-managed lists require a
23571 non-bounce message to confirm a subscription, so the danger is relatively
23572 small.
23573
23574
23575
23576 .option text autoreply string&!! unset
23577 This specifies a single string to be used as the body of the message when the
23578 message is specified by the transport. If both &%text%& and &%file%& are set,
23579 the text comes first.
23580
23581
23582 .option to autoreply string&!! unset
23583 This specifies recipients of the message and the contents of the &'To:'& header
23584 when the message is specified by the transport.
23585 .ecindex IIDauttra1
23586 .ecindex IIDauttra2
23587
23588
23589
23590
23591 . ////////////////////////////////////////////////////////////////////////////
23592 . ////////////////////////////////////////////////////////////////////////////
23593
23594 .chapter "The lmtp transport" "CHAPLMTP"
23595 .cindex "transports" "&(lmtp)&"
23596 .cindex "&(lmtp)& transport"
23597 .cindex "LMTP" "over a pipe"
23598 .cindex "LMTP" "over a socket"
23599 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23600 specified command
23601 or by interacting with a Unix domain socket.
23602 This transport is something of a cross between the &(pipe)& and &(smtp)&
23603 transports. Exim also has support for using LMTP over TCP/IP; this is
23604 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23605 to be of minority interest, the default build-time configure in &_src/EDITME_&
23606 has it commented out. You need to ensure that
23607 .code
23608 TRANSPORT_LMTP=yes
23609 .endd
23610 .cindex "options" "&(lmtp)& transport"
23611 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23612 included in the Exim binary. The private options of the &(lmtp)& transport are
23613 as follows:
23614
23615 .option batch_id lmtp string&!! unset
23616 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23617
23618
23619 .option batch_max lmtp integer 1
23620 This limits the number of addresses that can be handled in a single delivery.
23621 Most LMTP servers can handle several addresses at once, so it is normally a
23622 good idea to increase this value. See the description of local delivery
23623 batching in chapter &<<CHAPbatching>>&.
23624
23625
23626 .option command lmtp string&!! unset
23627 This option must be set if &%socket%& is not set. The string is a command which
23628 is run in a separate process. It is split up into a command name and list of
23629 arguments, each of which is separately expanded (so expansion cannot change the
23630 number of arguments). The command is run directly, not via a shell. The message
23631 is passed to the new process using the standard input and output to operate the
23632 LMTP protocol.
23633
23634 .option ignore_quota lmtp boolean false
23635 .cindex "LMTP" "ignoring quota errors"
23636 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23637 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23638 in its response to the LHLO command.
23639
23640 .option socket lmtp string&!! unset
23641 This option must be set if &%command%& is not set. The result of expansion must
23642 be the name of a Unix domain socket. The transport connects to the socket and
23643 delivers the message to it using the LMTP protocol.
23644
23645
23646 .option timeout lmtp time 5m
23647 The transport is aborted if the created process or Unix domain socket does not
23648 respond to LMTP commands or message input within this timeout. Delivery
23649 is deferred, and will be tried again later. Here is an example of a typical
23650 LMTP transport:
23651 .code
23652 lmtp:
23653   driver = lmtp
23654   command = /some/local/lmtp/delivery/program
23655   batch_max = 20
23656   user = exim
23657 .endd
23658 This delivers up to 20 addresses at a time, in a mixture of domains if
23659 necessary, running as the user &'exim'&.
23660
23661
23662
23663 . ////////////////////////////////////////////////////////////////////////////
23664 . ////////////////////////////////////////////////////////////////////////////
23665
23666 .chapter "The pipe transport" "CHAPpipetransport"
23667 .scindex IIDpiptra1 "transports" "&(pipe)&"
23668 .scindex IIDpiptra2 "&(pipe)& transport"
23669 The &(pipe)& transport is used to deliver messages via a pipe to a command
23670 running in another process. One example is the use of &(pipe)& as a
23671 pseudo-remote transport for passing messages to some other delivery mechanism
23672 (such as UUCP). Another is the use by individual users to automatically process
23673 their incoming messages. The &(pipe)& transport can be used in one of the
23674 following ways:
23675
23676 .ilist
23677 .vindex "&$local_part$&"
23678 A router routes one address to a transport in the normal way, and the
23679 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23680 contains the local part of the address (as usual), and the command that is run
23681 is specified by the &%command%& option on the transport.
23682 .next
23683 .vindex "&$pipe_addresses$&"
23684 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23685 transport can handle more than one address in a single run. In this case, when
23686 more than one address is routed to the transport, &$local_part$& is not set
23687 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23688 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23689 that are routed to the transport.
23690 .next
23691 .vindex "&$address_pipe$&"
23692 A router redirects an address directly to a pipe command (for example, from an
23693 alias or forward file). In this case, &$address_pipe$& contains the text of the
23694 pipe command, and the &%command%& option on the transport is ignored unless
23695 &%force_command%& is set. If only one address is being transported
23696 (&%batch_max%& is not greater than one, or only one address was redirected to
23697 this pipe command), &$local_part$& contains the local part that was redirected.
23698 .endlist
23699
23700
23701 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23702 deliver messages over pipes using the LMTP interactive protocol. This is
23703 implemented by the &(lmtp)& transport.
23704
23705 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23706 &_.forward_& file, the command runs under the uid and gid of that user. In
23707 other cases, the uid and gid have to be specified explicitly, either on the
23708 transport or on the router that handles the address. Current and &"home"&
23709 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23710 details of the local delivery environment and chapter &<<CHAPbatching>>&
23711 for a discussion of local delivery batching.
23712
23713
23714 .section "Concurrent delivery" "SECID140"
23715 If two messages arrive at almost the same time, and both are routed to a pipe
23716 delivery, the two pipe transports may be run concurrently. You must ensure that
23717 any pipe commands you set up are robust against this happening. If the commands
23718 write to a file, the &%exim_lock%& utility might be of use.
23719 Alternatively the &%max_parallel%& option could be used with a value
23720 of "1" to enforce serialization.
23721
23722
23723
23724
23725 .section "Returned status and data" "SECID141"
23726 .cindex "&(pipe)& transport" "returned data"
23727 If the command exits with a non-zero return code, the delivery is deemed to
23728 have failed, unless either the &%ignore_status%& option is set (in which case
23729 the return code is treated as zero), or the return code is one of those listed
23730 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23731 later"&. In this case, delivery is deferred. Details of a permanent failure are
23732 logged, but are not included in the bounce message, which merely contains
23733 &"local delivery failed"&.
23734
23735 If the command exits on a signal and the &%freeze_signal%& option is set then
23736 the message will be frozen in the queue. If that option is not set, a bounce
23737 will be sent as normal.
23738
23739 If the return code is greater than 128 and the command being run is a shell
23740 script, it normally means that the script was terminated by a signal whose
23741 value is the return code minus 128. The &%freeze_signal%& option does not
23742 apply in this case.
23743
23744 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23745 return code is set to 127. This is the value that a shell returns if it is
23746 asked to run a non-existent command. The wording for the log line suggests that
23747 a non-existent command may be the problem.
23748
23749 The &%return_output%& option can affect the result of a pipe delivery. If it is
23750 set and the command produces any output on its standard output or standard
23751 error streams, the command is considered to have failed, even if it gave a zero
23752 return code or if &%ignore_status%& is set. The output from the command is
23753 included as part of the bounce message. The &%return_fail_output%& option is
23754 similar, except that output is returned only when the command exits with a
23755 failure return code, that is, a value other than zero or a code that matches
23756 &%temp_errors%&.
23757
23758
23759
23760 .section "How the command is run" "SECThowcommandrun"
23761 .cindex "&(pipe)& transport" "path for command"
23762 The command line is (by default) broken down into a command name and arguments
23763 by the &(pipe)& transport itself. The &%allow_commands%& and
23764 &%restrict_to_path%& options can be used to restrict the commands that may be
23765 run.
23766
23767 .cindex "quoting" "in pipe command"
23768 Unquoted arguments are delimited by white space. If an argument appears in
23769 double quotes, backslash is interpreted as an escape character in the usual
23770 way. If an argument appears in single quotes, no escaping is done.
23771
23772 String expansion is applied to the command line except when it comes from a
23773 traditional &_.forward_& file (commands from a filter file are expanded). The
23774 expansion is applied to each argument in turn rather than to the whole line.
23775 For this reason, any string expansion item that contains white space must be
23776 quoted so as to be contained within a single argument. A setting such as
23777 .code
23778 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23779 .endd
23780 will not work, because the expansion item gets split between several
23781 arguments. You have to write
23782 .code
23783 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23784 .endd
23785 to ensure that it is all in one argument. The expansion is done in this way,
23786 argument by argument, so that the number of arguments cannot be changed as a
23787 result of expansion, and quotes or backslashes in inserted variables do not
23788 interact with external quoting. However, this leads to problems if you want to
23789 generate multiple arguments (or the command name plus arguments) from a single
23790 expansion. In this situation, the simplest solution is to use a shell. For
23791 example:
23792 .code
23793 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23794 .endd
23795
23796 .cindex "transport" "filter"
23797 .cindex "filter" "transport filter"
23798 .vindex "&$pipe_addresses$&"
23799 Special handling takes place when an argument consists of precisely the text
23800 &`$pipe_addresses`& (no quotes).
23801 This is not a general expansion variable; the only
23802 place this string is recognized is when it appears as an argument for a pipe or
23803 transport filter command. It causes each address that is being handled to be
23804 inserted in the argument list at that point &'as a separate argument'&. This
23805 avoids any problems with spaces or shell metacharacters, and is of use when a
23806 &(pipe)& transport is handling groups of addresses in a batch.
23807
23808 If &%force_command%& is enabled on the transport, special handling takes place
23809 for an argument that consists of precisely the text &`$address_pipe`&.  It
23810 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23811 argument is inserted in the argument list at that point
23812 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23813 the only item in the argument; in fact, if it were then &%force_command%&
23814 should behave as a no-op.  Rather, it should be used to adjust the command
23815 run while preserving the argument vector separation.
23816
23817 After splitting up into arguments and expansion, the resulting command is run
23818 in a subprocess directly from the transport, &'not'& under a shell. The
23819 message that is being delivered is supplied on the standard input, and the
23820 standard output and standard error are both connected to a single pipe that is
23821 read by Exim. The &%max_output%& option controls how much output the command
23822 may produce, and the &%return_output%& and &%return_fail_output%& options
23823 control what is done with it.
23824
23825 Not running the command under a shell (by default) lessens the security risks
23826 in cases when a command from a user's filter file is built out of data that was
23827 taken from an incoming message. If a shell is required, it can of course be
23828 explicitly specified as the command to be run. However, there are circumstances
23829 where existing commands (for example, in &_.forward_& files) expect to be run
23830 under a shell and cannot easily be modified. To allow for these cases, there is
23831 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23832 works. Instead of breaking up the command line as just described, it expands it
23833 as a single string and passes the result to &_/bin/sh_&. The
23834 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23835 with &%use_shell%&, and the whole mechanism is inherently less secure.
23836
23837
23838
23839 .section "Environment variables" "SECTpipeenv"
23840 .cindex "&(pipe)& transport" "environment for command"
23841 .cindex "environment" "&(pipe)& transport"
23842 The environment variables listed below are set up when the command is invoked.
23843 This list is a compromise for maximum compatibility with other MTAs. Note that
23844 the &%environment%& option can be used to add additional variables to this
23845 environment. The environment for the &(pipe)& transport is not subject
23846 to the &%add_environment%& and &%keep_environment%& main config options.
23847 .display
23848 &`DOMAIN            `&   the domain of the address
23849 &`HOME              `&   the home directory, if set
23850 &`HOST              `&   the host name when called from a router (see below)
23851 &`LOCAL_PART        `&   see below
23852 &`LOCAL_PART_PREFIX `&   see below
23853 &`LOCAL_PART_SUFFIX `&   see below
23854 &`LOGNAME           `&   see below
23855 &`MESSAGE_ID        `&   Exim's local ID for the message
23856 &`PATH              `&   as specified by the &%path%& option below
23857 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23858 &`RECIPIENT         `&   the complete recipient address
23859 &`SENDER            `&   the sender of the message (empty if a bounce)
23860 &`SHELL             `&   &`/bin/sh`&
23861 &`TZ                `&   the value of the &%timezone%& option, if set
23862 &`USER              `&   see below
23863 .endd
23864 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23865 router, LOCAL_PART is set to the local part of the address. When it is
23866 called as a result of a forward or alias expansion, LOCAL_PART is set to
23867 the local part of the address that was expanded. In both cases, any affixes are
23868 removed from the local part, and made available in LOCAL_PART_PREFIX and
23869 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23870 same value as LOCAL_PART for compatibility with other MTAs.
23871
23872 .cindex "HOST"
23873 HOST is set only when a &(pipe)& transport is called from a router that
23874 associates hosts with an address, typically when using &(pipe)& as a
23875 pseudo-remote transport. HOST is set to the first host name specified by
23876 the router.
23877
23878 .cindex "HOME"
23879 If the transport's generic &%home_directory%& option is set, its value is used
23880 for the HOME environment variable. Otherwise, a home directory may be set
23881 by the router's &%transport_home_directory%& option, which defaults to the
23882 user's home directory if &%check_local_user%& is set.
23883
23884
23885 .section "Private options for pipe" "SECID142"
23886 .cindex "options" "&(pipe)& transport"
23887
23888
23889
23890 .option allow_commands pipe "string list&!!" unset
23891 .cindex "&(pipe)& transport" "permitted commands"
23892 The string is expanded, and is then interpreted as a colon-separated list of
23893 permitted commands. If &%restrict_to_path%& is not set, the only commands
23894 permitted are those in the &%allow_commands%& list. They need not be absolute
23895 paths; the &%path%& option is still used for relative paths. If
23896 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23897 in the &%allow_commands%& list, or a name without any slashes that is found on
23898 the path. In other words, if neither &%allow_commands%& nor
23899 &%restrict_to_path%& is set, there is no restriction on the command, but
23900 otherwise only commands that are permitted by one or the other are allowed. For
23901 example, if
23902 .code
23903 allow_commands = /usr/bin/vacation
23904 .endd
23905 and &%restrict_to_path%& is not set, the only permitted command is
23906 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23907 &%use_shell%& is set.
23908
23909
23910 .option batch_id pipe string&!! unset
23911 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23912
23913
23914 .option batch_max pipe integer 1
23915 This limits the number of addresses that can be handled in a single delivery.
23916 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23917
23918
23919 .option check_string pipe string unset
23920 As &(pipe)& writes the message, the start of each line is tested for matching
23921 &%check_string%&, and if it does, the initial matching characters are replaced
23922 by the contents of &%escape_string%&, provided both are set. The value of
23923 &%check_string%& is a literal string, not a regular expression, and the case of
23924 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23925 of &%check_string%& and &%escape_string%& are forced to values that implement
23926 the SMTP escaping protocol. Any settings made in the configuration file are
23927 ignored.
23928
23929
23930 .option command pipe string&!! unset
23931 This option need not be set when &(pipe)& is being used to deliver to pipes
23932 obtained directly from address redirections. In other cases, the option must be
23933 set, to provide a command to be run. It need not yield an absolute path (see
23934 the &%path%& option below). The command is split up into separate arguments by
23935 Exim, and each argument is separately expanded, as described in section
23936 &<<SECThowcommandrun>>& above.
23937
23938
23939 .option environment pipe string&!! unset
23940 .cindex "&(pipe)& transport" "environment for command"
23941 .cindex "environment" "&(pipe)& transport"
23942 This option is used to add additional variables to the environment in which the
23943 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23944 a string which is expanded, and then interpreted as a colon-separated list of
23945 environment settings of the form <&'name'&>=<&'value'&>.
23946
23947
23948 .option escape_string pipe string unset
23949 See &%check_string%& above.
23950
23951
23952 .option freeze_exec_fail pipe boolean false
23953 .cindex "exec failure"
23954 .cindex "failure of exec"
23955 .cindex "&(pipe)& transport" "failure of exec"
23956 Failure to exec the command in a pipe transport is by default treated like
23957 any other failure while running the command. However, if &%freeze_exec_fail%&
23958 is set, failure to exec is treated specially, and causes the message to be
23959 frozen, whatever the setting of &%ignore_status%&.
23960
23961
23962 .option freeze_signal pipe boolean false
23963 .cindex "signal exit"
23964 .cindex "&(pipe)& transport", "signal exit"
23965 Normally if the process run by a command in a pipe transport exits on a signal,
23966 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23967 frozen in Exim's queue instead.
23968
23969
23970 .option force_command pipe boolean false
23971 .cindex "force command"
23972 .cindex "&(pipe)& transport", "force command"
23973 Normally when a router redirects an address directly to a pipe command
23974 the &%command%& option on the transport is ignored.  If &%force_command%&
23975 is set, the &%command%& option will used. This is especially
23976 useful for forcing a wrapper or additional argument to be added to the
23977 command. For example:
23978 .code
23979 command = /usr/bin/remote_exec myhost -- $address_pipe
23980 force_command
23981 .endd
23982
23983 Note that &$address_pipe$& is handled specially in &%command%& when
23984 &%force_command%& is set, expanding out to the original argument vector as
23985 separate items, similarly to a Unix shell &`"$@"`& construct.
23986
23987
23988 .option ignore_status pipe boolean false
23989 If this option is true, the status returned by the subprocess that is set up to
23990 run the command is ignored, and Exim behaves as if zero had been returned.
23991 Otherwise, a non-zero status or termination by signal causes an error return
23992 from the transport unless the status value is one of those listed in
23993 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23994
23995 &*Note*&: This option does not apply to timeouts, which do not return a status.
23996 See the &%timeout_defer%& option for how timeouts are handled.
23997
23998
23999 .option log_defer_output pipe boolean false
24000 .cindex "&(pipe)& transport" "logging output"
24001 If this option is set, and the status returned by the command is
24002 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24003 and any output was produced on stdout or stderr, the first line of it is
24004 written to the main log.
24005
24006
24007 .option log_fail_output pipe boolean false
24008 If this option is set, and the command returns any output on stdout or
24009 stderr, and also ends with a return code that is neither zero nor one of
24010 the return codes listed in &%temp_errors%& (that is, the delivery
24011 failed), the first line of output is written to the main log. This
24012 option and &%log_output%& are mutually exclusive.  Only one of them may
24013 be set.
24014
24015
24016 .option log_output pipe boolean false
24017 If this option is set and the command returns any output on stdout or
24018 stderr, the first line of output is written to the main log, whatever
24019 the return code. This option and &%log_fail_output%& are mutually
24020 exclusive. Only one of them may be set.
24021
24022
24023 .option max_output pipe integer 20K
24024 This specifies the maximum amount of output that the command may produce on its
24025 standard output and standard error file combined. If the limit is exceeded, the
24026 process running the command is killed. This is intended as a safety measure to
24027 catch runaway processes. The limit is applied independently of the settings of
24028 the options that control what is done with such output (for example,
24029 &%return_output%&). Because of buffering effects, the amount of output may
24030 exceed the limit by a small amount before Exim notices.
24031
24032
24033 .option message_prefix pipe string&!! "see below"
24034 The string specified here is expanded and output at the start of every message.
24035 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24036 .code
24037 message_prefix = \
24038   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24039   ${tod_bsdinbox}\n
24040 .endd
24041 .cindex "Cyrus"
24042 .cindex "&%tmail%&"
24043 .cindex "&""From""& line"
24044 This is required by the commonly used &_/usr/bin/vacation_& program.
24045 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24046 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24047 setting
24048 .code
24049 message_prefix =
24050 .endd
24051 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24052 &`\n`& to &`\r\n`& in &%message_prefix%&.
24053
24054
24055 .option message_suffix pipe string&!! "see below"
24056 The string specified here is expanded and output at the end of every message.
24057 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24058 The suffix can be suppressed by setting
24059 .code
24060 message_suffix =
24061 .endd
24062 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24063 &`\n`& to &`\r\n`& in &%message_suffix%&.
24064
24065
24066 .option path pipe string&!! "/bin:/usr/bin"
24067 This option is expanded and
24068 specifies the string that is set up in the PATH environment
24069 variable of the subprocess.
24070 If the &%command%& option does not yield an absolute path name, the command is
24071 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24072 apply to a command specified as a transport filter.
24073
24074
24075 .option permit_coredump pipe boolean false
24076 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24077 a core-dump of a pipe command, enable this command.  This enables core-dumps
24078 during delivery and affects both the Exim binary and the pipe command run.
24079 It is recommended that this option remain off unless and until you have a need
24080 for it and that this only be enabled when needed, as the risk of excessive
24081 resource consumption can be quite high.  Note also that Exim is typically
24082 installed as a setuid binary and most operating systems will inhibit coredumps
24083 of these by default, so further OS-specific action may be required.
24084
24085
24086 .option pipe_as_creator pipe boolean false
24087 .cindex "uid (user id)" "local delivery"
24088 If the generic &%user%& option is not set and this option is true, the delivery
24089 process is run under the uid that was in force when Exim was originally called
24090 to accept the message. If the group id is not otherwise set (via the generic
24091 &%group%& option), the gid that was in force when Exim was originally called to
24092 accept the message is used.
24093
24094
24095 .option restrict_to_path pipe boolean false
24096 When this option is set, any command name not listed in &%allow_commands%& must
24097 contain no slashes. The command is searched for only in the directories listed
24098 in the &%path%& option. This option is intended for use in the case when a pipe
24099 command has been generated from a user's &_.forward_& file. This is usually
24100 handled by a &(pipe)& transport called &%address_pipe%&.
24101
24102
24103 .option return_fail_output pipe boolean false
24104 If this option is true, and the command produced any output and ended with a
24105 return code other than zero or one of the codes listed in &%temp_errors%& (that
24106 is, the delivery failed), the output is returned in the bounce message.
24107 However, if the message has a null sender (that is, it is itself a bounce
24108 message), output from the command is discarded. This option and
24109 &%return_output%& are mutually exclusive. Only one of them may be set.
24110
24111
24112
24113 .option return_output pipe boolean false
24114 If this option is true, and the command produced any output, the delivery is
24115 deemed to have failed whatever the return code from the command, and the output
24116 is returned in the bounce message. Otherwise, the output is just discarded.
24117 However, if the message has a null sender (that is, it is a bounce message),
24118 output from the command is always discarded, whatever the setting of this
24119 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24120 of them may be set.
24121
24122
24123
24124 .option temp_errors pipe "string list" "see below"
24125 .cindex "&(pipe)& transport" "temporary failure"
24126 This option contains either a colon-separated list of numbers, or a single
24127 asterisk. If &%ignore_status%& is false
24128 and &%return_output%& is not set,
24129 and the command exits with a non-zero return code, the failure is treated as
24130 temporary and the delivery is deferred if the return code matches one of the
24131 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24132 codes are treated as permanent errors. The default setting contains the codes
24133 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24134 compiled on a system that does not define these macros, it assumes values of 75
24135 and 73, respectively.
24136
24137
24138 .option timeout pipe time 1h
24139 If the command fails to complete within this time, it is killed. This normally
24140 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24141 specifies no timeout. In order to ensure that any subprocesses created by the
24142 command are also killed, Exim makes the initial process a process group leader,
24143 and kills the whole process group on a timeout. However, this can be defeated
24144 if one of the processes starts a new process group.
24145
24146 .option timeout_defer pipe boolean false
24147 A timeout in a &(pipe)& transport, either in the command that the transport
24148 runs, or in a transport filter that is associated with it, is by default
24149 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24150 is set true, both kinds of timeout become temporary errors, causing the
24151 delivery to be deferred.
24152
24153 .option umask pipe "octal integer" 022
24154 This specifies the umask setting for the subprocess that runs the command.
24155
24156
24157 .option use_bsmtp pipe boolean false
24158 .cindex "envelope sender"
24159 If this option is set true, the &(pipe)& transport writes messages in &"batch
24160 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24161 commands. If you want to include a leading HELO command with such messages,
24162 you can do so by setting the &%message_prefix%& option. See section
24163 &<<SECTbatchSMTP>>& for details of batch SMTP.
24164
24165 .option use_classresources pipe boolean false
24166 .cindex "class resources (BSD)"
24167 This option is available only when Exim is running on FreeBSD, NetBSD, or
24168 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24169 resource limits when a &(pipe)& transport is run to perform a delivery. The
24170 limits for the uid under which the pipe is to run are obtained from the login
24171 class database.
24172
24173
24174 .option use_crlf pipe boolean false
24175 .cindex "carriage return"
24176 .cindex "linefeed"
24177 This option causes lines to be terminated with the two-character CRLF sequence
24178 (carriage return, linefeed) instead of just a linefeed character. In the case
24179 of batched SMTP, the byte sequence written to the pipe is then an exact image
24180 of what would be sent down a real SMTP connection.
24181
24182 The contents of the &%message_prefix%& and &%message_suffix%& options are
24183 written verbatim, so must contain their own carriage return characters if these
24184 are needed. When &%use_bsmtp%& is not set, the default values for both
24185 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24186 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24187
24188
24189 .option use_shell pipe boolean false
24190 .vindex "&$pipe_addresses$&"
24191 If this option is set, it causes the command to be passed to &_/bin/sh_&
24192 instead of being run directly from the transport, as described in section
24193 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24194 where the command is expected to be run under a shell and cannot easily be
24195 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24196 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24197 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24198 its &%-c%& option.
24199
24200
24201
24202 .section "Using an external local delivery agent" "SECID143"
24203 .cindex "local delivery" "using an external agent"
24204 .cindex "&'procmail'&"
24205 .cindex "external local delivery"
24206 .cindex "delivery" "&'procmail'&"
24207 .cindex "delivery" "by external agent"
24208 The &(pipe)& transport can be used to pass all messages that require local
24209 delivery to a separate local delivery agent such as &%procmail%&. When doing
24210 this, care must be taken to ensure that the pipe is run under an appropriate
24211 uid and gid. In some configurations one wants this to be a uid that is trusted
24212 by the delivery agent to supply the correct sender of the message. It may be
24213 necessary to recompile or reconfigure the delivery agent so that it trusts an
24214 appropriate user. The following is an example transport and router
24215 configuration for &%procmail%&:
24216 .code
24217 # transport
24218 procmail_pipe:
24219   driver = pipe
24220   command = /usr/local/bin/procmail -d $local_part
24221   return_path_add
24222   delivery_date_add
24223   envelope_to_add
24224   check_string = "From "
24225   escape_string = ">From "
24226   umask = 077
24227   user = $local_part
24228   group = mail
24229
24230 # router
24231 procmail:
24232   driver = accept
24233   check_local_user
24234   transport = procmail_pipe
24235 .endd
24236 In this example, the pipe is run as the local user, but with the group set to
24237 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24238 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24239 user to supply a correct sender address. If you do not specify either a
24240 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24241 home directory is the user's home directory by default.
24242
24243 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24244 .code
24245 IFS=" "
24246 .endd
24247 as shown in some &%procmail%& documentation, because Exim does not by default
24248 use a shell to run pipe commands.
24249
24250 .cindex "Cyrus"
24251 The next example shows a transport and a router for a system where local
24252 deliveries are handled by the Cyrus IMAP server.
24253 .code
24254 # transport
24255 local_delivery_cyrus:
24256   driver = pipe
24257   command = /usr/cyrus/bin/deliver \
24258             -m ${substr_1:$local_part_suffix} -- $local_part
24259   user = cyrus
24260   group = mail
24261   return_output
24262   log_output
24263   message_prefix =
24264   message_suffix =
24265
24266 # router
24267 local_user_cyrus:
24268   driver = accept
24269   check_local_user
24270   local_part_suffix = .*
24271   transport = local_delivery_cyrus
24272 .endd
24273 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24274 &%return_output%& to cause any text written by Cyrus to be returned to the
24275 sender.
24276 .ecindex IIDpiptra1
24277 .ecindex IIDpiptra2
24278
24279
24280 . ////////////////////////////////////////////////////////////////////////////
24281 . ////////////////////////////////////////////////////////////////////////////
24282
24283 .chapter "The smtp transport" "CHAPsmtptrans"
24284 .scindex IIDsmttra1 "transports" "&(smtp)&"
24285 .scindex IIDsmttra2 "&(smtp)& transport"
24286 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24287 or LMTP protocol. The list of hosts to try can either be taken from the address
24288 that is being processed (having been set up by the router), or specified
24289 explicitly for the transport. Timeout and retry processing (see chapter
24290 &<<CHAPretry>>&) is applied to each IP address independently.
24291
24292
24293 .section "Multiple messages on a single connection" "SECID144"
24294 The sending of multiple messages over a single TCP/IP connection can arise in
24295 two ways:
24296
24297 .ilist
24298 If a message contains more than &%max_rcpt%& (see below) addresses that are
24299 routed to the same host, more than one copy of the message has to be sent to
24300 that host. In this situation, multiple copies may be sent in a single run of
24301 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24302 does when it has too many addresses to send in one message also depends on the
24303 value of the global &%remote_max_parallel%& option. Details are given in
24304 section &<<SECToutSMTPTCP>>&.)
24305 .next
24306 .cindex "hints database" "remembering routing"
24307 When a message has been successfully delivered over a TCP/IP connection, Exim
24308 looks in its hints database to see if there are any other messages awaiting a
24309 connection to the same host. If there are, a new delivery process is started
24310 for one of them, and the current TCP/IP connection is passed on to it. The new
24311 process may in turn send multiple copies and possibly create yet another
24312 process.
24313 .endlist
24314
24315
24316 For each copy sent over the same TCP/IP connection, a sequence counter is
24317 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24318 no further messages are sent over that connection.
24319
24320
24321
24322 .section "Use of the $host and $host_address variables" "SECID145"
24323 .vindex "&$host$&"
24324 .vindex "&$host_address$&"
24325 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24326 &$host_address$& are the name and IP address of the first host on the host list
24327 passed by the router. However, when the transport is about to connect to a
24328 specific host, and while it is connected to that host, &$host$& and
24329 &$host_address$& are set to the values for that host. These are the values
24330 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24331 &%serialize_hosts%&, and the various TLS options are expanded.
24332
24333
24334 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24335 .vindex &$tls_bits$&
24336 .vindex &$tls_cipher$&
24337 .vindex &$tls_peerdn$&
24338 .vindex &$tls_sni$&
24339 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24340 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24341 are the values that were set when the message was received.
24342 These are the values that are used for options that are expanded before any
24343 SMTP connections are made. Just before each connection is made, these four
24344 variables are emptied. If TLS is subsequently started, they are set to the
24345 appropriate values for the outgoing connection, and these are the values that
24346 are in force when any authenticators are run and when the
24347 &%authenticated_sender%& option is expanded.
24348
24349 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24350 and will be removed in a future release.
24351
24352
24353 .section "Private options for smtp" "SECID146"
24354 .cindex "options" "&(smtp)& transport"
24355 The private options of the &(smtp)& transport are as follows:
24356
24357
24358 .option address_retry_include_sender smtp boolean true
24359 .cindex "4&'xx'& responses" "retrying after"
24360 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24361 is the combination of sender and recipient that is delayed in subsequent queue
24362 runs until the retry time is reached. You can delay the recipient without
24363 reference to the sender (which is what earlier versions of Exim did), by
24364 setting &%address_retry_include_sender%& false. However, this can lead to
24365 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24366
24367 .option allow_localhost smtp boolean false
24368 .cindex "local host" "sending to"
24369 .cindex "fallback" "hosts specified on transport"
24370 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24371 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24372 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24373 the delivery anyway. This should be used only in special cases when the
24374 configuration ensures that no looping will result (for example, a differently
24375 configured Exim is listening on the port to which the message is sent).
24376
24377
24378 .option authenticated_sender smtp string&!! unset
24379 .cindex "Cyrus"
24380 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24381 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24382 overriding any existing authenticated sender value. If the string expansion is
24383 forced to fail, the option is ignored. Other expansion failures cause delivery
24384 to be deferred. If the result of expansion is an empty string, that is also
24385 ignored.
24386
24387 The expansion happens after the outgoing connection has been made and TLS
24388 started, if required. This means that the &$host$&, &$host_address$&,
24389 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24390 particular connection.
24391
24392 If the SMTP session is not authenticated, the expansion of
24393 &%authenticated_sender%& still happens (and can cause the delivery to be
24394 deferred if it fails), but no AUTH= item is added to MAIL commands
24395 unless &%authenticated_sender_force%& is true.
24396
24397 This option allows you to use the &(smtp)& transport in LMTP mode to
24398 deliver mail to Cyrus IMAP and provide the proper local part as the
24399 &"authenticated sender"&, via a setting such as:
24400 .code
24401 authenticated_sender = $local_part
24402 .endd
24403 This removes the need for IMAP subfolders to be assigned special ACLs to
24404 allow direct delivery to those subfolders.
24405
24406 Because of expected uses such as that just described for Cyrus (when no
24407 domain is involved), there is no checking on the syntax of the provided
24408 value.
24409
24410
24411 .option authenticated_sender_force smtp boolean false
24412 If this option is set true, the &%authenticated_sender%& option's value
24413 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24414 authenticated as a client.
24415
24416
24417 .option command_timeout smtp time 5m
24418 This sets a timeout for receiving a response to an SMTP command that has been
24419 sent out. It is also used when waiting for the initial banner line from the
24420 remote host. Its value must not be zero.
24421
24422
24423 .option connect_timeout smtp time 5m
24424 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24425 to a remote host. A setting of zero allows the system timeout (typically
24426 several minutes) to act. To have any effect, the value of this option must be
24427 less than the system timeout. However, it has been observed that on some
24428 systems there is no system timeout, which is why the default value for this
24429 option is 5 minutes, a value recommended by RFC 1123.
24430
24431
24432 .option connection_max_messages smtp integer 500
24433 .cindex "SMTP" "passed connection"
24434 .cindex "SMTP" "multiple deliveries"
24435 .cindex "multiple SMTP deliveries"
24436 This controls the maximum number of separate message deliveries that are sent
24437 over a single TCP/IP connection. If the value is zero, there is no limit.
24438 For testing purposes, this value can be overridden by the &%-oB%& command line
24439 option.
24440
24441
24442 .option dane_require_tls_ciphers smtp string&!! unset
24443 .cindex "TLS" "requiring specific ciphers for DANE"
24444 .cindex "cipher" "requiring specific"
24445 .cindex DANE "TLS ciphers"
24446 This option may be used to override &%tls_require_ciphers%& for connections
24447 where DANE has been determined to be in effect.
24448 If not set, then &%tls_require_ciphers%& will be used.
24449 Normal SMTP delivery is not able to make strong demands of TLS cipher
24450 configuration, because delivery will fall back to plaintext.  Once DANE has
24451 been determined to be in effect, there is no plaintext fallback and making the
24452 TLS cipherlist configuration stronger will increase security, rather than
24453 counter-intuitively decreasing it.
24454 If the option expands to be empty or is forced to fail, then it will
24455 be treated as unset and &%tls_require_ciphers%& will be used instead.
24456
24457
24458 .option data_timeout smtp time 5m
24459 This sets a timeout for the transmission of each block in the data portion of
24460 the message. As a result, the overall timeout for a message depends on the size
24461 of the message. Its value must not be zero. See also &%final_timeout%&.
24462
24463
24464 .option dkim_canon smtp string&!! unset
24465 .option dkim_domain smtp string list&!! unset
24466 .option dkim_hash smtp string&!! sha256
24467 .option dkim_identity smtp string&!! unset
24468 .option dkim_private_key smtp string&!! unset
24469 .option dkim_selector smtp string&!! unset
24470 .option dkim_strict smtp string&!! unset
24471 .option dkim_sign_headers smtp string&!! "per RFC"
24472 .option dkim_timestamps smtp string&!! unset
24473 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24474
24475
24476 .option delay_after_cutoff smtp boolean true
24477 .cindex "final cutoff" "retries, controlling"
24478 .cindex retry "final cutoff"
24479 This option controls what happens when all remote IP addresses for a given
24480 domain have been inaccessible for so long that they have passed their retry
24481 cutoff times.
24482
24483 In the default state, if the next retry time has not been reached for any of
24484 them, the address is bounced without trying any deliveries. In other words,
24485 Exim delays retrying an IP address after the final cutoff time until a new
24486 retry time is reached, and can therefore bounce an address without ever trying
24487 a delivery, when machines have been down for a long time. Some people are
24488 unhappy at this prospect, so...
24489
24490 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24491 addresses are past their final cutoff time, Exim tries to deliver to those
24492 IP addresses that have not been tried since the message arrived. If there are
24493 none, of if they all fail, the address is bounced. In other words, it does not
24494 delay when a new message arrives, but immediately tries those expired IP
24495 addresses that haven't been tried since the message arrived. If there is a
24496 continuous stream of messages for the dead hosts, unsetting
24497 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24498 to them.
24499
24500
24501 .option dns_qualify_single smtp boolean true
24502 If the &%hosts%& or &%fallback_hosts%& option is being used,
24503 and the &%gethostbyname%& option is false,
24504 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24505 in chapter &<<CHAPdnslookup>>& for more details.
24506
24507
24508 .option dns_search_parents smtp boolean false
24509 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24510 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24511 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24512 details.
24513
24514
24515 .option dnssec_request_domains smtp "domain list&!!" unset
24516 .cindex "MX record" "security"
24517 .cindex "DNSSEC" "MX lookup"
24518 .cindex "security" "MX lookup"
24519 .cindex "DNS" "DNSSEC"
24520 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24521 the dnssec request bit set.
24522 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24523
24524
24525
24526 .option dnssec_require_domains smtp "domain list&!!" unset
24527 .cindex "MX record" "security"
24528 .cindex "DNSSEC" "MX lookup"
24529 .cindex "security" "MX lookup"
24530 .cindex "DNS" "DNSSEC"
24531 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24532 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24533 (AD bit) set will be ignored and logged as a host-lookup failure.
24534 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24535
24536
24537
24538 .option dscp smtp string&!! unset
24539 .cindex "DCSP" "outbound"
24540 This option causes the DSCP value associated with a socket to be set to one
24541 of a number of fixed strings or to numeric value.
24542 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24543 Common values include &`throughput`&, &`mincost`&, and on newer systems
24544 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24545
24546 The outbound packets from Exim will be marked with this value in the header
24547 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24548 that these values will have any effect, not be stripped by networking
24549 equipment, or do much of anything without cooperation with your Network
24550 Engineer and those of all network operators between the source and destination.
24551
24552
24553 .option fallback_hosts smtp "string list" unset
24554 .cindex "fallback" "hosts specified on transport"
24555 String expansion is not applied to this option. The argument must be a
24556 colon-separated list of host names or IP addresses, optionally also including
24557 port numbers, though the separator can be changed, as described in section
24558 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24559 item in a &%route_list%& setting for the &(manualroute)& router, as described
24560 in section &<<SECTformatonehostitem>>&.
24561
24562 Fallback hosts can also be specified on routers, which associate them with the
24563 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24564 &%fallback_hosts%& specified on the transport is used only if the address does
24565 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24566 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24567 However, &%hosts_randomize%& does apply to fallback host lists.
24568
24569 If Exim is unable to deliver to any of the hosts for a particular address, and
24570 the errors are not permanent rejections, the address is put on a separate
24571 transport queue with its host list replaced by the fallback hosts, unless the
24572 address was routed via MX records and the current host was in the original MX
24573 list. In that situation, the fallback host list is not used.
24574
24575 Once normal deliveries are complete, the fallback queue is delivered by
24576 re-running the same transports with the new host lists. If several failing
24577 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24578 copy of the message is sent.
24579
24580 The resolution of the host names on the fallback list is controlled by the
24581 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24582 both to cases when the host list comes with the address and when it is taken
24583 from &%hosts%&. This option provides a &"use a smart host only if delivery
24584 fails"& facility.
24585
24586
24587 .option final_timeout smtp time 10m
24588 This is the timeout that applies while waiting for the response to the final
24589 line containing just &"."& that terminates a message. Its value must not be
24590 zero.
24591
24592 .option gethostbyname smtp boolean false
24593 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24594 being used, names are looked up using &[gethostbyname()]&
24595 (or &[getipnodebyname()]& when available)
24596 instead of using the DNS. Of course, that function may in fact use the DNS, but
24597 it may also consult other sources of information such as &_/etc/hosts_&.
24598
24599 .option gnutls_compat_mode smtp boolean unset
24600 This option controls whether GnuTLS is used in compatibility mode in an Exim
24601 server. This reduces security slightly, but improves interworking with older
24602 implementations of TLS.
24603
24604 .option helo_data smtp string&!! "see below"
24605 .cindex "HELO" "argument, setting"
24606 .cindex "EHLO" "argument, setting"
24607 .cindex "LHLO argument setting"
24608 The value of this option is expanded after a connection to a another host has
24609 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24610 command that starts the outgoing SMTP or LMTP session. The default value of the
24611 option is:
24612 .code
24613 $primary_hostname
24614 .endd
24615 During the expansion, the variables &$host$& and &$host_address$& are set to
24616 the identity of the remote host, and the variables &$sending_ip_address$& and
24617 &$sending_port$& are set to the local IP address and port number that are being
24618 used. These variables can be used to generate different values for different
24619 servers or different local IP addresses. For example, if you want the string
24620 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24621 interface address, you could use this:
24622 .code
24623 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24624   {$primary_hostname}}
24625 .endd
24626 The use of &%helo_data%& applies both to sending messages and when doing
24627 callouts.
24628
24629 .option hosts smtp "string list&!!" unset
24630 Hosts are associated with an address by a router such as &(dnslookup)&, which
24631 finds the hosts by looking up the address domain in the DNS, or by
24632 &(manualroute)&, which has lists of hosts in its configuration. However,
24633 email addresses can be passed to the &(smtp)& transport by any router, and not
24634 all of them can provide an associated list of hosts.
24635
24636 The &%hosts%& option specifies a list of hosts to be used if the address being
24637 processed does not have any hosts associated with it. The hosts specified by
24638 &%hosts%& are also used, whether or not the address has its own hosts, if
24639 &%hosts_override%& is set.
24640
24641 The string is first expanded, before being interpreted as a colon-separated
24642 list of host names or IP addresses, possibly including port numbers. The
24643 separator may be changed to something other than colon, as described in section
24644 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24645 item in a &%route_list%& setting for the &(manualroute)& router, as described
24646 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24647 of the &(manualroute)& router is not available here.
24648
24649 If the expansion fails, delivery is deferred. Unless the failure was caused by
24650 the inability to complete a lookup, the error is logged to the panic log as
24651 well as the main log. Host names are looked up either by searching directly for
24652 address records in the DNS or by calling &[gethostbyname()]& (or
24653 &[getipnodebyname()]& when available), depending on the setting of the
24654 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24655 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24656 address are used.
24657
24658 During delivery, the hosts are tried in order, subject to their retry status,
24659 unless &%hosts_randomize%& is set.
24660
24661
24662 .option hosts_avoid_esmtp smtp "host list&!!" unset
24663 .cindex "ESMTP, avoiding use of"
24664 .cindex "HELO" "forcing use of"
24665 .cindex "EHLO" "avoiding use of"
24666 .cindex "PIPELINING" "avoiding the use of"
24667 This option is for use with broken hosts that announce ESMTP facilities (for
24668 example, PIPELINING) and then fail to implement them properly. When a host
24669 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24670 start of the SMTP session. This means that it cannot use any of the ESMTP
24671 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24672
24673
24674 .option hosts_avoid_pipelining smtp "host list&!!" unset
24675 .cindex "PIPELINING" "avoiding the use of"
24676 Exim will not use the SMTP PIPELINING extension when delivering to any host
24677 that matches this list, even if the server host advertises PIPELINING support.
24678
24679 .new
24680 .option hosts_pipe_connect smtp "host list&!!" unset
24681 .cindex "pipelining" "early connection"
24682 .cindex "pipelining" PIPE_CONNECT
24683 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24684 this option controls which to hosts the facility watched for
24685 and recorded, and used for subsequent connections.
24686
24687 The retry hints database is used for the record,
24688 and records are subject to the &%retry_data_expire%& option.
24689 When used, the pipelining saves on roundtrip times.
24690 It also turns SMTP into a client-first protocol
24691 so combines well with TCP Fast Open.
24692
24693 Note:
24694 When the facility is used, the transport &%helo_data%& option
24695 will be expanded before the &$sending_ip_address$& variable
24696 is filled in.
24697 A check is made for the use of that variable, without the
24698 presence of a &"def:"& test on it, but suitably complex coding
24699 can avoid the check and produce unexpected results.
24700 You have been warned.
24701 .wen
24702
24703
24704 .option hosts_avoid_tls smtp "host list&!!" unset
24705 .cindex "TLS" "avoiding for certain hosts"
24706 Exim will not try to start a TLS session when delivering to any host that
24707 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24708
24709 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24710 .cindex "TLS" "avoiding for certain hosts"
24711 Exim will not try to start a TLS session for a verify callout,
24712 or when delivering in cutthrough mode,
24713 to any host that matches this list.
24714
24715
24716 .option hosts_max_try smtp integer 5
24717 .cindex "host" "maximum number to try"
24718 .cindex "limit" "number of hosts tried"
24719 .cindex "limit" "number of MX tried"
24720 .cindex "MX record" "maximum tried"
24721 This option limits the number of IP addresses that are tried for any one
24722 delivery in cases where there are temporary delivery errors. Section
24723 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24724
24725
24726 .option hosts_max_try_hardlimit smtp integer 50
24727 This is an additional check on the maximum number of IP addresses that Exim
24728 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24729 why it exists.
24730
24731
24732
24733 .option hosts_nopass_tls smtp "host list&!!" unset
24734 .cindex "TLS" "passing connection"
24735 .cindex "multiple SMTP deliveries"
24736 .cindex "TLS" "multiple message deliveries"
24737 For any host that matches this list, a connection on which a TLS session has
24738 been started will not be passed to a new delivery process for sending another
24739 message on the same connection. See section &<<SECTmulmessam>>& for an
24740 explanation of when this might be needed.
24741
24742 .new
24743 .option hosts_noproxy_tls smtp "host list&!!" unset
24744 .cindex "TLS" "passing connection"
24745 .cindex "multiple SMTP deliveries"
24746 .cindex "TLS" "multiple message deliveries"
24747 For any host that matches this list, a TLS session which has
24748 been started will not be passed to a new delivery process for sending another
24749 message on the same session.
24750 .wen
24751
24752 The traditional implementation closes down TLS and re-starts it in the new
24753 process, on the same open TCP connection, for each successive message
24754 sent.  If permitted by this option a pipe to to the new process is set up
24755 instead, and the original process maintains the TLS connection and proxies
24756 the SMTP connection from and to the new process and any subsequents.
24757 The new process has no access to TLS information, so cannot include it in
24758 logging.
24759
24760
24761
24762 .option hosts_override smtp boolean false
24763 If this option is set and the &%hosts%& option is also set, any hosts that are
24764 attached to the address are ignored, and instead the hosts specified by the
24765 &%hosts%& option are always used. This option does not apply to
24766 &%fallback_hosts%&.
24767
24768
24769 .option hosts_randomize smtp boolean false
24770 .cindex "randomized host list"
24771 .cindex "host" "list of; randomized"
24772 .cindex "fallback" "randomized hosts"
24773 If this option is set, and either the list of hosts is taken from the
24774 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24775 were not obtained from MX records (this includes fallback hosts from the
24776 router), and were not randomized by the router, the order of trying the hosts
24777 is randomized each time the transport runs. Randomizing the order of a host
24778 list can be used to do crude load sharing.
24779
24780 When &%hosts_randomize%& is true, a host list may be split into groups whose
24781 order is separately randomized. This makes it possible to set up MX-like
24782 behaviour. The boundaries between groups are indicated by an item that is just
24783 &`+`& in the host list. For example:
24784 .code
24785 hosts = host1:host2:host3:+:host4:host5
24786 .endd
24787 The order of the first three hosts and the order of the last two hosts is
24788 randomized for each use, but the first three always end up before the last two.
24789 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24790
24791 .option hosts_require_auth smtp "host list&!!" unset
24792 .cindex "authentication" "required by client"
24793 This option provides a list of servers for which authentication must succeed
24794 before Exim will try to transfer a message. If authentication fails for
24795 servers which are not in this list, Exim tries to send unauthenticated. If
24796 authentication fails for one of these servers, delivery is deferred. This
24797 temporary error is detectable in the retry rules, so it can be turned into a
24798 hard failure if required. See also &%hosts_try_auth%&, and chapter
24799 &<<CHAPSMTPAUTH>>& for details of authentication.
24800
24801
24802 .option hosts_request_ocsp smtp "host list&!!" *
24803 .cindex "TLS" "requiring for certain servers"
24804 Exim will request a Certificate Status on a
24805 TLS session for any host that matches this list.
24806 &%tls_verify_certificates%& should also be set for the transport.
24807
24808 .option hosts_require_dane smtp "host list&!!" unset
24809 .cindex DANE "transport options"
24810 .cindex DANE "requiring for certain servers"
24811 If built with DANE support, Exim  will require that a DNSSEC-validated
24812 TLSA record is present for any host matching the list,
24813 and that a DANE-verified TLS connection is made.
24814 There will be no fallback to in-clear communication.
24815 See section &<<SECDANE>>&.
24816
24817 .option hosts_require_ocsp smtp "host list&!!" unset
24818 .cindex "TLS" "requiring for certain servers"
24819 Exim will request, and check for a valid Certificate Status being given, on a
24820 TLS session for any host that matches this list.
24821 &%tls_verify_certificates%& should also be set for the transport.
24822
24823 .option hosts_require_tls smtp "host list&!!" unset
24824 .cindex "TLS" "requiring for certain servers"
24825 Exim will insist on using a TLS session when delivering to any host that
24826 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24827 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24828 incoming messages, use an appropriate ACL.
24829
24830 .option hosts_try_auth smtp "host list&!!" unset
24831 .cindex "authentication" "optional in client"
24832 This option provides a list of servers to which, provided they announce
24833 authentication support, Exim will attempt to authenticate as a client when it
24834 connects. If authentication fails, Exim will try to transfer the message
24835 unauthenticated. See also &%hosts_require_auth%&, and chapter
24836 &<<CHAPSMTPAUTH>>& for details of authentication.
24837
24838 .option hosts_try_chunking smtp "host list&!!" *
24839 .cindex CHUNKING "enabling, in client"
24840 .cindex BDAT "SMTP command"
24841 .cindex "RFC 3030" "CHUNKING"
24842 This option provides a list of servers to which, provided they announce
24843 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24844 BDAT will not be used in conjunction with a transport filter.
24845
24846 .option hosts_try_dane smtp "host list&!!" *
24847 .cindex DANE "transport options"
24848 .cindex DANE "attempting for certain servers"
24849 If built with DANE support, Exim  will lookup a
24850 TLSA record for any host matching the list.
24851 If found and verified by DNSSEC,
24852 a DANE-verified TLS connection is made to that host;
24853 there will be no fallback to in-clear communication.
24854 See section &<<SECDANE>>&.
24855
24856 .option hosts_try_fastopen smtp "host list&!!" *
24857 .cindex "fast open, TCP" "enabling, in client"
24858 .cindex "TCP Fast Open" "enabling, in client"
24859 .cindex "RFC 7413" "TCP Fast Open"
24860 This option provides a list of servers to which, provided
24861 the facility is supported by this system, Exim will attempt to
24862 perform a TCP Fast Open.
24863 No data is sent on the SYN segment but, if the remote server also
24864 supports the facility, it can send its SMTP banner immediately after
24865 the SYN,ACK segment.  This can save up to one round-trip time.
24866
24867 The facility is only active for previously-contacted servers,
24868 as the initiator must present a cookie in the SYN segment.
24869
24870 On (at least some) current Linux distributions the facility must be enabled
24871 in the kernel by the sysadmin before the support is usable.
24872 There is no option for control of the server side; if the system supports
24873 it it is always enabled.  Note that lengthy operations in the connect ACL,
24874 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24875
24876 .option hosts_try_prdr smtp "host list&!!" *
24877 .cindex "PRDR" "enabling, optional in client"
24878 This option provides a list of servers to which, provided they announce
24879 PRDR support, Exim will attempt to negotiate PRDR
24880 for multi-recipient messages.
24881 The option can usually be left as default.
24882
24883 .option interface smtp "string list&!!" unset
24884 .cindex "bind IP address"
24885 .cindex "IP address" "binding"
24886 .vindex "&$host$&"
24887 .vindex "&$host_address$&"
24888 This option specifies which interface to bind to when making an outgoing SMTP
24889 call. The value is an IP address, not an interface name such as
24890 &`eth0`&. Do not confuse this with the interface address that was used when a
24891 message was received, which is in &$received_ip_address$&, formerly known as
24892 &$interface_address$&. The name was changed to minimize confusion with the
24893 outgoing interface address. There is no variable that contains an outgoing
24894 interface address because, unless it is set by this option, its value is
24895 unknown.
24896
24897 During the expansion of the &%interface%& option the variables &$host$& and
24898 &$host_address$& refer to the host to which a connection is about to be made
24899 during the expansion of the string. Forced expansion failure, or an empty
24900 string result causes the option to be ignored. Otherwise, after expansion, the
24901 string must be a list of IP addresses, colon-separated by default, but the
24902 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24903 For example:
24904 .code
24905 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24906 .endd
24907 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24908 connection. If none of them are the correct type, the option is ignored. If
24909 &%interface%& is not set, or is ignored, the system's IP functions choose which
24910 interface to use if the host has more than one.
24911
24912
24913 .option keepalive smtp boolean true
24914 .cindex "keepalive" "on outgoing connection"
24915 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24916 connections. When set, it causes the kernel to probe idle connections
24917 periodically, by sending packets with &"old"& sequence numbers. The other end
24918 of the connection should send a acknowledgment if the connection is still okay
24919 or a reset if the connection has been aborted. The reason for doing this is
24920 that it has the beneficial effect of freeing up certain types of connection
24921 that can get stuck when the remote host is disconnected without tidying up the
24922 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24923 unreachable hosts.
24924
24925
24926 .option lmtp_ignore_quota smtp boolean false
24927 .cindex "LMTP" "ignoring quota errors"
24928 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24929 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24930 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24931
24932 .option max_rcpt smtp integer 100
24933 .cindex "RCPT" "maximum number of outgoing"
24934 This option limits the number of RCPT commands that are sent in a single
24935 SMTP message transaction. Each set of addresses is treated independently, and
24936 so can cause parallel connections to the same host if &%remote_max_parallel%&
24937 permits this.
24938
24939
24940 .option multi_domain smtp boolean&!! true
24941 .vindex "&$domain$&"
24942 When this option is set, the &(smtp)& transport can handle a number of
24943 addresses containing a mixture of different domains provided they all resolve
24944 to the same list of hosts. Turning the option off restricts the transport to
24945 handling only one domain at a time. This is useful if you want to use
24946 &$domain$& in an expansion for the transport, because it is set only when there
24947 is a single domain involved in a remote delivery.
24948
24949 It is expanded per-address and can depend on any of
24950 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24951 &$host$&, &$host_address$& and &$host_port$&.
24952
24953 .option port smtp string&!! "see below"
24954 .cindex "port" "sending TCP/IP"
24955 .cindex "TCP/IP" "setting outgoing port"
24956 This option specifies the TCP/IP port on the server to which Exim connects.
24957 &*Note:*& Do not confuse this with the port that was used when a message was
24958 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24959 The name was changed to minimize confusion with the outgoing port. There is no
24960 variable that contains an outgoing port.
24961
24962 If the value of this option begins with a digit it is taken as a port number;
24963 otherwise it is looked up using &[getservbyname()]&. The default value is
24964 normally &"smtp"&,
24965 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
24966 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
24967 If the expansion fails, or if a port number cannot be found, delivery
24968 is deferred.
24969
24970 Note that at least one Linux distribution has been seen failing
24971 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
24972
24973
24974
24975 .option protocol smtp string smtp
24976 .cindex "LMTP" "over TCP/IP"
24977 .cindex "ssmtp protocol" "outbound"
24978 .cindex "TLS" "SSL-on-connect outbound"
24979 .vindex "&$port$&"
24980 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24981 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24982 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24983 deliveries into closed message stores. Exim also has support for running LMTP
24984 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24985
24986 If this option is set to &"smtps"&, the default value for the &%port%& option
24987 changes to &"smtps"&, and the transport initiates TLS immediately after
24988 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24989 The Internet standards bodies used to strongly discourage use of this mode,
24990 but as of RFC 8314 it is perferred over STARTTLS for message submission
24991 (as distinct from MTA-MTA communication).
24992
24993
24994 .option retry_include_ip_address smtp boolean&!! true
24995 Exim normally includes both the host name and the IP address in the key it
24996 constructs for indexing retry data after a temporary delivery failure. This
24997 means that when one of several IP addresses for a host is failing, it gets
24998 tried periodically (controlled by the retry rules), but use of the other IP
24999 addresses is not affected.
25000
25001 However, in some dialup environments hosts are assigned a different IP address
25002 each time they connect. In this situation the use of the IP address as part of
25003 the retry key leads to undesirable behaviour. Setting this option false causes
25004 Exim to use only the host name.
25005 Since it is expanded it can be made to depend on the host or domain.
25006
25007
25008 .option serialize_hosts smtp "host list&!!" unset
25009 .cindex "serializing connections"
25010 .cindex "host" "serializing connections"
25011 Because Exim operates in a distributed manner, if several messages for the same
25012 host arrive at around the same time, more than one simultaneous connection to
25013 the remote host can occur. This is not usually a problem except when there is a
25014 slow link between the hosts. In that situation it may be helpful to restrict
25015 Exim to one connection at a time. This can be done by setting
25016 &%serialize_hosts%& to match the relevant hosts.
25017
25018 .cindex "hints database" "serializing deliveries to a host"
25019 Exim implements serialization by means of a hints database in which a record is
25020 written whenever a process connects to one of the restricted hosts. The record
25021 is deleted when the connection is completed. Obviously there is scope for
25022 records to get left lying around if there is a system or program crash. To
25023 guard against this, Exim ignores any records that are more than six hours old.
25024
25025 If you set up this kind of serialization, you should also arrange to delete the
25026 relevant hints database whenever your system reboots. The names of the files
25027 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25028 may be one or two files, depending on the type of DBM in use. The same files
25029 are used for ETRN serialization.
25030
25031 See also the &%max_parallel%& generic transport option.
25032
25033
25034 .option size_addition smtp integer 1024
25035 .cindex "SMTP" "SIZE"
25036 .cindex "message" "size issue for transport filter"
25037 .cindex "size" "of message"
25038 .cindex "transport" "filter"
25039 .cindex "filter" "transport filter"
25040 If a remote SMTP server indicates that it supports the SIZE option of the
25041 MAIL command, Exim uses this to pass over the message size at the start of
25042 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25043 sends, to allow for headers and other text that may be added during delivery by
25044 configuration options or in a transport filter. It may be necessary to increase
25045 this if a lot of text is added to messages.
25046
25047 Alternatively, if the value of &%size_addition%& is set negative, it disables
25048 the use of the SIZE option altogether.
25049
25050
25051 .option socks_proxy smtp string&!! unset
25052 .cindex proxy SOCKS
25053 This option enables use of SOCKS proxies for connections made by the
25054 transport.  For details see section &<<SECTproxySOCKS>>&.
25055
25056
25057 .option tls_certificate smtp string&!! unset
25058 .cindex "TLS" "client certificate, location of"
25059 .cindex "certificate" "client, location of"
25060 .vindex "&$host$&"
25061 .vindex "&$host_address$&"
25062 The value of this option must be the absolute path to a file which contains the
25063 client's certificate, for possible use when sending a message over an encrypted
25064 connection. The values of &$host$& and &$host_address$& are set to the name and
25065 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25066 details of TLS.
25067
25068 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25069 certificate when sending messages as a client. The global option of the same
25070 name specifies the certificate for Exim as a server; it is not automatically
25071 assumed that the same certificate should be used when Exim is operating as a
25072 client.
25073
25074
25075 .option tls_crl smtp string&!! unset
25076 .cindex "TLS" "client certificate revocation list"
25077 .cindex "certificate" "revocation list for client"
25078 This option specifies a certificate revocation list. The expanded value must
25079 be the name of a file that contains a CRL in PEM format.
25080
25081
25082 .option tls_dh_min_bits smtp integer 1024
25083 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25084 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25085 key agreement is negotiated, the server will provide a large prime number
25086 for use.  This option establishes the minimum acceptable size of that number.
25087 If the parameter offered by the server is too small, then the TLS handshake
25088 will fail.
25089
25090 Only supported when using GnuTLS.
25091
25092
25093 .option tls_privatekey smtp string&!! unset
25094 .cindex "TLS" "client private key, location of"
25095 .vindex "&$host$&"
25096 .vindex "&$host_address$&"
25097 The value of this option must be the absolute path to a file which contains the
25098 client's private key. This is used when sending a message over an encrypted
25099 connection using a client certificate. The values of &$host$& and
25100 &$host_address$& are set to the name and address of the server during the
25101 expansion. If this option is unset, or the expansion is forced to fail, or the
25102 result is an empty string, the private key is assumed to be in the same file as
25103 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25104
25105
25106 .option tls_require_ciphers smtp string&!! unset
25107 .cindex "TLS" "requiring specific ciphers"
25108 .cindex "cipher" "requiring specific"
25109 .vindex "&$host$&"
25110 .vindex "&$host_address$&"
25111 The value of this option must be a list of permitted cipher suites, for use
25112 when setting up an outgoing encrypted connection. (There is a global option of
25113 the same name for controlling incoming connections.) The values of &$host$& and
25114 &$host_address$& are set to the name and address of the server during the
25115 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25116 is used in different ways by OpenSSL and GnuTLS (see sections
25117 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25118 ciphers is a preference order.
25119
25120
25121
25122 .option tls_sni smtp string&!! unset
25123 .cindex "TLS" "Server Name Indication"
25124 .vindex "&$tls_sni$&"
25125 If this option is set then it sets the $tls_out_sni variable and causes any
25126 TLS session to pass this value as the Server Name Indication extension to
25127 the remote side, which can be used by the remote side to select an appropriate
25128 certificate and private key for the session.
25129
25130 See &<<SECTtlssni>>& for more information.
25131
25132 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25133 TLS extensions.
25134
25135
25136
25137
25138 .option tls_tempfail_tryclear smtp boolean true
25139 .cindex "4&'xx'& responses" "to STARTTLS"
25140 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25141 setting up a TLS session, this option determines whether or not Exim should try
25142 to deliver the message unencrypted. If it is set false, delivery to the
25143 current host is deferred; if there are other hosts, they are tried. If this
25144 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25145 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25146 TLS negotiation fails, Exim closes the current connection (because it is in an
25147 unknown state), opens a new one to the same host, and then tries the delivery
25148 in clear.
25149
25150
25151 .option tls_try_verify_hosts smtp "host list&!!" *
25152 .cindex "TLS" "server certificate verification"
25153 .cindex "certificate" "verification of server"
25154 This option gives a list of hosts for which, on encrypted connections,
25155 certificate verification will be tried but need not succeed.
25156 The &%tls_verify_certificates%& option must also be set.
25157 Note that unless the host is in this list
25158 TLS connections will be denied to hosts using self-signed certificates
25159 when &%tls_verify_certificates%& is matched.
25160 The &$tls_out_certificate_verified$& variable is set when
25161 certificate verification succeeds.
25162
25163
25164 .option tls_verify_cert_hostnames smtp "host list&!!" *
25165 .cindex "TLS" "server certificate hostname verification"
25166 .cindex "certificate" "verification of server"
25167 This option give a list of hosts for which,
25168 while verifying the server certificate,
25169 checks will be included on the host name
25170 (note that this will generally be the result of a DNS MX lookup)
25171 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25172 limited to being the initial component of a 3-or-more component FQDN.
25173
25174 There is no equivalent checking on client certificates.
25175
25176
25177 .option tls_verify_certificates smtp string&!! system
25178 .cindex "TLS" "server certificate verification"
25179 .cindex "certificate" "verification of server"
25180 .vindex "&$host$&"
25181 .vindex "&$host_address$&"
25182 The value of this option must be either the
25183 word "system"
25184 or the absolute path to
25185 a file or directory containing permitted certificates for servers,
25186 for use when setting up an encrypted connection.
25187
25188 The "system" value for the option will use a location compiled into the SSL library.
25189 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25190 is taken as empty and an explicit location
25191 must be specified.
25192
25193 The use of a directory for the option value is not available for GnuTLS versions
25194 preceding 3.3.6 and a single file must be used.
25195
25196 With OpenSSL the certificates specified
25197 explicitly
25198 either by file or directory
25199 are added to those given by the system default location.
25200
25201 The values of &$host$& and
25202 &$host_address$& are set to the name and address of the server during the
25203 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25204
25205 For back-compatibility,
25206 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25207 (a single-colon empty list counts as being set)
25208 and certificate verification fails the TLS connection is closed.
25209
25210
25211 .option tls_verify_hosts smtp "host list&!!" unset
25212 .cindex "TLS" "server certificate verification"
25213 .cindex "certificate" "verification of server"
25214 This option gives a list of hosts for which, on encrypted connections,
25215 certificate verification must succeed.
25216 The &%tls_verify_certificates%& option must also be set.
25217 If both this option and &%tls_try_verify_hosts%& are unset
25218 operation is as if this option selected all hosts.
25219
25220 .option utf8_downconvert smtp integer!! unset
25221 .cindex utf8 "address downconversion"
25222 .cindex i18n "utf8 address downconversion"
25223 If built with internationalization support,
25224 this option controls conversion of UTF-8 in message addresses
25225 to a-label form.
25226 For details see section &<<SECTi18nMTA>>&.
25227
25228
25229
25230
25231 .section "How the limits for the number of hosts to try are used" &&&
25232          "SECTvalhosmax"
25233 .cindex "host" "maximum number to try"
25234 .cindex "limit" "hosts; maximum number tried"
25235 There are two options that are concerned with the number of hosts that are
25236 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25237 &%hosts_max_try_hardlimit%&.
25238
25239
25240 The &%hosts_max_try%& option limits the number of hosts that are tried
25241 for a single delivery. However, despite the term &"host"& in its name, the
25242 option actually applies to each IP address independently. In other words, a
25243 multihomed host is treated as several independent hosts, just as it is for
25244 retrying.
25245
25246 Many of the larger ISPs have multiple MX records which often point to
25247 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25248 created as a result of routing one of these domains.
25249
25250 Trying every single IP address on such a long list does not seem sensible; if
25251 several at the top of the list fail, it is reasonable to assume there is some
25252 problem that is likely to affect all of them. Roughly speaking, the value of
25253 &%hosts_max_try%& is the maximum number that are tried before deferring the
25254 delivery. However, the logic cannot be quite that simple.
25255
25256 Firstly, IP addresses that are skipped because their retry times have not
25257 arrived do not count, and in addition, addresses that are past their retry
25258 limits are also not counted, even when they are tried. This means that when
25259 some IP addresses are past their retry limits, more than the value of
25260 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25261 that all IP addresses are considered before timing out an email address (but
25262 see below for an exception).
25263
25264 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25265 list to see if there is a subsequent host with a different (higher valued) MX.
25266 If there is, that host is considered next, and the current IP address is used
25267 but not counted. This behaviour helps in the case of a domain with a retry rule
25268 that hardly ever delays any hosts, as is now explained:
25269
25270 Consider the case of a long list of hosts with one MX value, and a few with a
25271 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25272 hosts at the top of the list are tried at first. With the default retry rule,
25273 which specifies increasing retry times, the higher MX hosts are eventually
25274 tried when those at the top of the list are skipped because they have not
25275 reached their retry times.
25276
25277 However, it is common practice to put a fixed short retry time on domains for
25278 large ISPs, on the grounds that their servers are rarely down for very long.
25279 Unfortunately, these are exactly the domains that tend to resolve to long lists
25280 of hosts. The short retry time means that the lowest MX hosts are tried every
25281 time. The attempts may be in a different order because of random sorting, but
25282 without the special MX check, the higher MX hosts would never be tried until
25283 all the lower MX hosts had timed out (which might be several days), because
25284 there are always some lower MX hosts that have reached their retry times. With
25285 the special check, Exim considers at least one IP address from each MX value at
25286 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25287 reached.
25288
25289 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25290 particular, Exim normally eventually tries all the IP addresses before timing
25291 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25292 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25293 been set up with hundreds of IP addresses for some domains. It can
25294 take a very long time indeed for an address to time out in these cases.
25295
25296 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25297 Exim never tries more than this number of IP addresses; if it hits this limit
25298 and they are all timed out, the email address is bounced, even though not all
25299 possible IP addresses have been tried.
25300 .ecindex IIDsmttra1
25301 .ecindex IIDsmttra2
25302
25303
25304
25305
25306
25307 . ////////////////////////////////////////////////////////////////////////////
25308 . ////////////////////////////////////////////////////////////////////////////
25309
25310 .chapter "Address rewriting" "CHAPrewrite"
25311 .scindex IIDaddrew "rewriting" "addresses"
25312 There are some circumstances in which Exim automatically rewrites domains in
25313 addresses. The two most common are when an address is given without a domain
25314 (referred to as an &"unqualified address"&) or when an address contains an
25315 abbreviated domain that is expanded by DNS lookup.
25316
25317 Unqualified envelope addresses are accepted only for locally submitted
25318 messages, or for messages that are received from hosts matching
25319 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25320 appropriate. Unqualified addresses in header lines are qualified if they are in
25321 locally submitted messages, or messages from hosts that are permitted to send
25322 unqualified envelope addresses. Otherwise, unqualified addresses in header
25323 lines are neither qualified nor rewritten.
25324
25325 One situation in which Exim does &'not'& automatically rewrite a domain is
25326 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25327 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25328 do this. The new RFCs do not contain this suggestion.
25329
25330
25331 .section "Explicitly configured address rewriting" "SECID147"
25332 This chapter describes the rewriting rules that can be used in the
25333 main rewrite section of the configuration file, and also in the generic
25334 &%headers_rewrite%& option that can be set on any transport.
25335
25336 Some people believe that configured address rewriting is a Mortal Sin.
25337 Others believe that life is not possible without it. Exim provides the
25338 facility; you do not have to use it.
25339
25340 The main rewriting rules that appear in the &"rewrite"& section of the
25341 configuration file are applied to addresses in incoming messages, both envelope
25342 addresses and addresses in header lines. Each rule specifies the types of
25343 address to which it applies.
25344
25345 Whether or not addresses in header lines are rewritten depends on the origin of
25346 the headers and the type of rewriting. Global rewriting, that is, rewriting
25347 rules from the rewrite section of the configuration file, is applied only to
25348 those headers that were received with the message. Header lines that are added
25349 by ACLs or by a system filter or by individual routers or transports (which
25350 are specific to individual recipient addresses) are not rewritten by the global
25351 rules.
25352
25353 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25354 applies all headers except those added by routers and transports. That is, as
25355 well as the headers that were received with the message, it also applies to
25356 headers that were added by an ACL or a system filter.
25357
25358
25359 In general, rewriting addresses from your own system or domain has some
25360 legitimacy. Rewriting other addresses should be done only with great care and
25361 in special circumstances. The author of Exim believes that rewriting should be
25362 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25363 Although it can sometimes be used as a routing tool, this is very strongly
25364 discouraged.
25365
25366 There are two commonly encountered circumstances where rewriting is used, as
25367 illustrated by these examples:
25368
25369 .ilist
25370 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25371 exchange mail with each other behind a firewall, but there is only a single
25372 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25373 &'hitch.fict.example'& when sending mail off-site.
25374 .next
25375 A host rewrites the local parts of its own users so that, for example,
25376 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25377 .endlist
25378
25379
25380
25381 .section "When does rewriting happen?" "SECID148"
25382 .cindex "rewriting" "timing of"
25383 .cindex "&ACL;" "rewriting addresses in"
25384 Configured address rewriting can take place at several different stages of a
25385 message's processing.
25386
25387 .vindex "&$sender_address$&"
25388 At the start of an ACL for MAIL, the sender address may have been rewritten
25389 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25390 ordinary rewrite rules have yet been applied. If, however, the sender address
25391 is verified in the ACL, it is rewritten before verification, and remains
25392 rewritten thereafter. The subsequent value of &$sender_address$& is the
25393 rewritten address. This also applies if sender verification happens in a
25394 RCPT ACL. Otherwise, when the sender address is not verified, it is
25395 rewritten as soon as a message's header lines have been received.
25396
25397 .vindex "&$domain$&"
25398 .vindex "&$local_part$&"
25399 Similarly, at the start of an ACL for RCPT, the current recipient's address
25400 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25401 rewrite rules have yet been applied to it. However, the behaviour is different
25402 from the sender address when a recipient is verified. The address is rewritten
25403 for the verification, but the rewriting is not remembered at this stage. The
25404 value of &$local_part$& and &$domain$& after verification are always the same
25405 as they were before (that is, they contain the unrewritten &-- except for
25406 SMTP-time rewriting &-- address).
25407
25408 As soon as a message's header lines have been received, all the envelope
25409 recipient addresses are permanently rewritten, and rewriting is also applied to
25410 the addresses in the header lines (if configured). This happens before adding
25411 any header lines that were specified in MAIL or RCPT ACLs, and
25412 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25413 before the DATA ACL and &[local_scan()]& functions are run.
25414
25415 When an address is being routed, either for delivery or for verification,
25416 rewriting is applied immediately to child addresses that are generated by
25417 redirection, unless &%no_rewrite%& is set on the router.
25418
25419 .cindex "envelope from"
25420 .cindex "envelope sender" "rewriting at transport time"
25421 .cindex "rewriting" "at transport time"
25422 .cindex "header lines" "rewriting at transport time"
25423 At transport time, additional rewriting of addresses in header lines can be
25424 specified by setting the generic &%headers_rewrite%& option on a transport.
25425 This option contains rules that are identical in form to those in the rewrite
25426 section of the configuration file. They are applied to the original message
25427 header lines and any that were added by ACLs or a system filter. They are not
25428 applied to header lines that are added by routers or the transport.
25429
25430 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25431 transport option. However, it is not possible to rewrite envelope recipients at
25432 transport time.
25433
25434
25435
25436
25437 .section "Testing the rewriting rules that apply on input" "SECID149"
25438 .cindex "rewriting" "testing"
25439 .cindex "testing" "rewriting"
25440 Exim's input rewriting configuration appears in a part of the runtime
25441 configuration file headed by &"begin rewrite"&. It can be tested by the
25442 &%-brw%& command line option. This takes an address (which can be a full RFC
25443 2822 address) as its argument. The output is a list of how the address would be
25444 transformed by the rewriting rules for each of the different places it might
25445 appear in an incoming message, that is, for each different header and for the
25446 envelope sender and recipient fields. For example,
25447 .code
25448 exim -brw ph10@exim.workshop.example
25449 .endd
25450 might produce the output
25451 .code
25452 sender: Philip.Hazel@exim.workshop.example
25453 from: Philip.Hazel@exim.workshop.example
25454 to: ph10@exim.workshop.example
25455 cc: ph10@exim.workshop.example
25456 bcc: ph10@exim.workshop.example
25457 reply-to: Philip.Hazel@exim.workshop.example
25458 env-from: Philip.Hazel@exim.workshop.example
25459 env-to: ph10@exim.workshop.example
25460 .endd
25461 which shows that rewriting has been set up for that address when used in any of
25462 the source fields, but not when it appears as a recipient address. At the
25463 present time, there is no equivalent way of testing rewriting rules that are
25464 set for a particular transport.
25465
25466
25467 .section "Rewriting rules" "SECID150"
25468 .cindex "rewriting" "rules"
25469 The rewrite section of the configuration file consists of lines of rewriting
25470 rules in the form
25471 .display
25472 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25473 .endd
25474 Rewriting rules that are specified for the &%headers_rewrite%& generic
25475 transport option are given as a colon-separated list. Each item in the list
25476 takes the same form as a line in the main rewriting configuration (except that
25477 any colons must be doubled, of course).
25478
25479 The formats of source patterns and replacement strings are described below.
25480 Each is terminated by white space, unless enclosed in double quotes, in which
25481 case normal quoting conventions apply inside the quotes. The flags are single
25482 characters which may appear in any order. Spaces and tabs between them are
25483 ignored.
25484
25485 For each address that could potentially be rewritten, the rules are scanned in
25486 order, and replacements for the address from earlier rules can themselves be
25487 replaced by later rules (but see the &"q"& and &"R"& flags).
25488
25489 The order in which addresses are rewritten is undefined, may change between
25490 releases, and must not be relied on, with one exception: when a message is
25491 received, the envelope sender is always rewritten first, before any header
25492 lines are rewritten. For example, the replacement string for a rewrite of an
25493 address in &'To:'& must not assume that the message's address in &'From:'& has
25494 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25495 that the envelope sender has already been rewritten.
25496
25497 .vindex "&$domain$&"
25498 .vindex "&$local_part$&"
25499 The variables &$local_part$& and &$domain$& can be used in the replacement
25500 string to refer to the address that is being rewritten. Note that lookup-driven
25501 rewriting can be done by a rule of the form
25502 .code
25503 *@*   ${lookup ...
25504 .endd
25505 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25506 refer to the address that is being rewritten.
25507
25508
25509 .section "Rewriting patterns" "SECID151"
25510 .cindex "rewriting" "patterns"
25511 .cindex "address list" "in a rewriting pattern"
25512 The source pattern in a rewriting rule is any item which may appear in an
25513 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25514 single-item address list, which means that it is expanded before being tested
25515 against the address. As always, if you use a regular expression as a pattern,
25516 you must take care to escape dollar and backslash characters, or use the &`\N`&
25517 facility to suppress string expansion within the regular expression.
25518
25519 Domains in patterns should be given in lower case. Local parts in patterns are
25520 case-sensitive. If you want to do case-insensitive matching of local parts, you
25521 can use a regular expression that starts with &`^(?i)`&.
25522
25523 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25524 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25525 depending on the type of match which occurred. These can be used in the
25526 replacement string to insert portions of the incoming address. &$0$& always
25527 refers to the complete incoming address. When a regular expression is used, the
25528 numerical variables are set from its capturing subexpressions. For other types
25529 of pattern they are set as follows:
25530
25531 .ilist
25532 If a local part or domain starts with an asterisk, the numerical variables
25533 refer to the character strings matched by asterisks, with &$1$& associated with
25534 the first asterisk, and &$2$& with the second, if present. For example, if the
25535 pattern
25536 .code
25537 *queen@*.fict.example
25538 .endd
25539 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25540 .code
25541 $0 = hearts-queen@wonderland.fict.example
25542 $1 = hearts-
25543 $2 = wonderland
25544 .endd
25545 Note that if the local part does not start with an asterisk, but the domain
25546 does, it is &$1$& that contains the wild part of the domain.
25547
25548 .next
25549 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25550 of the domain are placed in the next available numerical variables. Suppose,
25551 for example, that the address &'foo@bar.baz.example'& is processed by a
25552 rewriting rule of the form
25553 .display
25554 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25555 .endd
25556 and the key in the file that matches the domain is &`*.baz.example`&. Then
25557 .code
25558 $1 = foo
25559 $2 = bar
25560 $3 = baz.example
25561 .endd
25562 If the address &'foo@baz.example'& is looked up, this matches the same
25563 wildcard file entry, and in this case &$2$& is set to the empty string, but
25564 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25565 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25566 whole domain. For non-partial domain lookups, no numerical variables are set.
25567 .endlist
25568
25569
25570 .section "Rewriting replacements" "SECID152"
25571 .cindex "rewriting" "replacements"
25572 If the replacement string for a rule is a single asterisk, addresses that
25573 match the pattern and the flags are &'not'& rewritten, and no subsequent
25574 rewriting rules are scanned. For example,
25575 .code
25576 hatta@lookingglass.fict.example  *  f
25577 .endd
25578 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25579 &'From:'& headers.
25580
25581 .vindex "&$domain$&"
25582 .vindex "&$local_part$&"
25583 If the replacement string is not a single asterisk, it is expanded, and must
25584 yield a fully qualified address. Within the expansion, the variables
25585 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25586 Any letters they contain retain their original case &-- they are not lower
25587 cased. The numerical variables are set up according to the type of pattern that
25588 matched the address, as described above. If the expansion is forced to fail by
25589 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25590 current rule is abandoned, but subsequent rules may take effect. Any other
25591 expansion failure causes the entire rewriting operation to be abandoned, and an
25592 entry written to the panic log.
25593
25594
25595
25596 .section "Rewriting flags" "SECID153"
25597 There are three different kinds of flag that may appear on rewriting rules:
25598
25599 .ilist
25600 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25601 c, f, h, r, s, t.
25602 .next
25603 A flag that specifies rewriting at SMTP time: S.
25604 .next
25605 Flags that control the rewriting process: Q, q, R, w.
25606 .endlist
25607
25608 For rules that are part of the &%headers_rewrite%& generic transport option,
25609 E, F, T, and S are not permitted.
25610
25611
25612
25613 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25614          "SECID154"
25615 .cindex "rewriting" "flags"
25616 If none of the following flag letters, nor the &"S"& flag (see section
25617 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25618 and to both the sender and recipient fields of the envelope, whereas a
25619 transport-time rewriting rule just applies to all headers. Otherwise, the
25620 rewriting rule is skipped unless the relevant addresses are being processed.
25621 .display
25622 &`E`&       rewrite all envelope fields
25623 &`F`&       rewrite the envelope From field
25624 &`T`&       rewrite the envelope To field
25625 &`b`&       rewrite the &'Bcc:'& header
25626 &`c`&       rewrite the &'Cc:'& header
25627 &`f`&       rewrite the &'From:'& header
25628 &`h`&       rewrite all headers
25629 &`r`&       rewrite the &'Reply-To:'& header
25630 &`s`&       rewrite the &'Sender:'& header
25631 &`t`&       rewrite the &'To:'& header
25632 .endd
25633 "All headers" means all of the headers listed above that can be selected
25634 individually, plus their &'Resent-'& versions. It does not include
25635 other headers such as &'Subject:'& etc.
25636
25637 You should be particularly careful about rewriting &'Sender:'& headers, and
25638 restrict this to special known cases in your own domains.
25639
25640
25641 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25642 .cindex "SMTP" "rewriting malformed addresses"
25643 .cindex "RCPT" "rewriting argument of"
25644 .cindex "MAIL" "rewriting argument of"
25645 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25646 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25647 before any other processing; even before syntax checking. The pattern is
25648 required to be a regular expression, and it is matched against the whole of the
25649 data for the command, including any surrounding angle brackets.
25650
25651 .vindex "&$domain$&"
25652 .vindex "&$local_part$&"
25653 This form of rewrite rule allows for the handling of addresses that are not
25654 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25655 input). Because the input is not required to be a syntactically valid address,
25656 the variables &$local_part$& and &$domain$& are not available during the
25657 expansion of the replacement string. The result of rewriting replaces the
25658 original address in the MAIL or RCPT command.
25659
25660
25661 .section "Flags controlling the rewriting process" "SECID155"
25662 There are four flags which control the way the rewriting process works. These
25663 take effect only when a rule is invoked, that is, when the address is of the
25664 correct type (matches the flags) and matches the pattern:
25665
25666 .ilist
25667 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25668 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25669 absence of &"Q"& the rewritten address must always include a domain.
25670 .next
25671 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25672 even if no rewriting actually takes place because of a &"fail"& in the
25673 expansion. The &"q"& flag is not effective if the address is of the wrong type
25674 (does not match the flags) or does not match the pattern.
25675 .next
25676 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25677 address, up to ten times. It can be combined with the &"q"& flag, to stop
25678 rewriting once it fails to match (after at least one successful rewrite).
25679 .next
25680 .cindex "rewriting" "whole addresses"
25681 When an address in a header is rewritten, the rewriting normally applies only
25682 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25683 left unchanged. For example, rewriting might change
25684 .code
25685 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25686 .endd
25687 into
25688 .code
25689 From: Ford Prefect <prefectf@hitch.fict.example>
25690 .endd
25691 .cindex "RFC 2047"
25692 Sometimes there is a need to replace the whole address item, and this can be
25693 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25694 causes an address in a header line to be rewritten, the entire address is
25695 replaced, not just the working part. The replacement must be a complete RFC
25696 2822 address, including the angle brackets if necessary. If text outside angle
25697 brackets contains a character whose value is greater than 126 or less than 32
25698 (except for tab), the text is encoded according to RFC 2047. The character set
25699 is taken from &%headers_charset%&, which gets its default at build time.
25700
25701 When the &"w"& flag is set on a rule that causes an envelope address to be
25702 rewritten, all but the working part of the replacement address is discarded.
25703 .endlist
25704
25705
25706 .section "Rewriting examples" "SECID156"
25707 Here is an example of the two common rewriting paradigms:
25708 .code
25709 *@*.hitch.fict.example  $1@hitch.fict.example
25710 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25711                      {$value}fail}@hitch.fict.example bctfrF
25712 .endd
25713 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25714 the string expansion to fail if the lookup does not succeed. In this context it
25715 has the effect of leaving the original address unchanged, but Exim goes on to
25716 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25717 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25718 explicitly, which would cause the rewritten address to be the same as before,
25719 at the cost of a small bit of processing. Not supplying either of these is an
25720 error, since the rewritten address would then contain no local part.
25721
25722 The first example above replaces the domain with a superior, more general
25723 domain. This may not be desirable for certain local parts. If the rule
25724 .code
25725 root@*.hitch.fict.example  *
25726 .endd
25727 were inserted before the first rule, rewriting would be suppressed for the
25728 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25729
25730 Rewriting can be made conditional on a number of tests, by making use of
25731 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25732 messages that originate outside the local host:
25733 .code
25734 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25735                          {$1@hitch.fict.example}fail}"
25736 .endd
25737 The replacement string is quoted in this example because it contains white
25738 space.
25739
25740 .cindex "rewriting" "bang paths"
25741 .cindex "bang paths" "rewriting"
25742 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25743 an address it treats it as an unqualified local part which it qualifies with
25744 the local qualification domain (if the source of the message is local or if the
25745 remote host is permitted to send unqualified addresses). Rewriting can
25746 sometimes be used to handle simple bang paths with a fixed number of
25747 components. For example, the rule
25748 .code
25749 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25750 .endd
25751 rewrites a two-component bang path &'host.name!user'& as the domain address
25752 &'user@host.name'&. However, there is a security implication in using this as
25753 a global rewriting rule for envelope addresses. It can provide a backdoor
25754 method for using your system as a relay, because the incoming addresses appear
25755 to be local. If the bang path addresses are received via SMTP, it is safer to
25756 use the &"S"& flag to rewrite them as they are received, so that relay checking
25757 can be done on the rewritten addresses.
25758 .ecindex IIDaddrew
25759
25760
25761
25762
25763
25764 . ////////////////////////////////////////////////////////////////////////////
25765 . ////////////////////////////////////////////////////////////////////////////
25766
25767 .chapter "Retry configuration" "CHAPretry"
25768 .scindex IIDretconf1 "retry" "configuration, description of"
25769 .scindex IIDregconf2 "configuration file" "retry section"
25770 The &"retry"& section of the runtime configuration file contains a list of
25771 retry rules that control how often Exim tries to deliver messages that cannot
25772 be delivered at the first attempt. If there are no retry rules (the section is
25773 empty or not present), there are no retries. In this situation, temporary
25774 errors are treated as permanent. The default configuration contains a single,
25775 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25776 line option can be used to test which retry rule will be used for a given
25777 address, domain and error.
25778
25779 The most common cause of retries is temporary failure to deliver to a remote
25780 host because the host is down, or inaccessible because of a network problem.
25781 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25782 address) basis, not on a per-message basis. Thus, if one message has recently
25783 been delayed, delivery of a new message to the same host is not immediately
25784 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25785 log selector is set, the message
25786 .cindex "retry" "time not reached"
25787 &"retry time not reached"& is written to the main log whenever a delivery is
25788 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25789 the handling of errors during remote deliveries.
25790
25791 Retry processing applies to routing as well as to delivering, except as covered
25792 in the next paragraph. The retry rules do not distinguish between these
25793 actions. It is not possible, for example, to specify different behaviour for
25794 failures to route the domain &'snark.fict.example'& and failures to deliver to
25795 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25796 added complication, so did not implement it. However, although they share the
25797 same retry rule, the actual retry times for routing and transporting a given
25798 domain are maintained independently.
25799
25800 When a delivery is not part of a queue run (typically an immediate delivery on
25801 receipt of a message), the routers are always run, and local deliveries are
25802 always attempted, even if retry times are set for them. This makes for better
25803 behaviour if one particular message is causing problems (for example, causing
25804 quota overflow, or provoking an error in a filter file). If such a delivery
25805 suffers a temporary failure, the retry data is updated as normal, and
25806 subsequent delivery attempts from queue runs occur only when the retry time for
25807 the local address is reached.
25808
25809 .section "Changing retry rules" "SECID157"
25810 If you change the retry rules in your configuration, you should consider
25811 whether or not to delete the retry data that is stored in Exim's spool area in
25812 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25813 always safe; that is why they are called &"hints"&.
25814
25815 The hints retry data contains suggested retry times based on the previous
25816 rules. In the case of a long-running problem with a remote host, it might
25817 record the fact that the host has timed out. If your new rules increase the
25818 timeout time for such a host, you should definitely remove the old retry data
25819 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25820 messages that it should now be retaining.
25821
25822
25823
25824 .section "Format of retry rules" "SECID158"
25825 .cindex "retry" "rules"
25826 Each retry rule occupies one line and consists of three or four parts,
25827 separated by white space: a pattern, an error name, an optional list of sender
25828 addresses, and a list of retry parameters. The pattern and sender lists must be
25829 enclosed in double quotes if they contain white space. The rules are searched
25830 in order until one is found where the pattern, error name, and sender list (if
25831 present) match the failing host or address, the error that occurred, and the
25832 message's sender, respectively.
25833
25834
25835 The pattern is any single item that may appear in an address list (see section
25836 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25837 which means that it is expanded before being tested against the address that
25838 has been delayed. A negated address list item is permitted. Address
25839 list processing treats a plain domain name as if it were preceded by &"*@"&,
25840 which makes it possible for many retry rules to start with just a domain. For
25841 example,
25842 .code
25843 lookingglass.fict.example        *  F,24h,30m;
25844 .endd
25845 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25846 whereas
25847 .code
25848 alice@lookingglass.fict.example  *  F,24h,30m;
25849 .endd
25850 applies only to temporary failures involving the local part &%alice%&.
25851 In practice, almost all rules start with a domain name pattern without a local
25852 part.
25853
25854 .cindex "regular expressions" "in retry rules"
25855 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25856 must match a complete address, not just a domain, because that is how regular
25857 expressions work in address lists.
25858 .display
25859 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25860 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25861 .endd
25862
25863
25864 .section "Choosing which retry rule to use for address errors" "SECID159"
25865 When Exim is looking for a retry rule after a routing attempt has failed (for
25866 example, after a DNS timeout), each line in the retry configuration is tested
25867 against the complete address only if &%retry_use_local_part%& is set for the
25868 router. Otherwise, only the domain is used, except when matching against a
25869 regular expression, when the local part of the address is replaced with &"*"&.
25870 A domain on its own can match a domain pattern, or a pattern that starts with
25871 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25872 &%check_local_user%& is true, and false for other routers.
25873
25874 Similarly, when Exim is looking for a retry rule after a local delivery has
25875 failed (for example, after a mailbox full error), each line in the retry
25876 configuration is tested against the complete address only if
25877 &%retry_use_local_part%& is set for the transport (it defaults true for all
25878 local transports).
25879
25880 .cindex "4&'xx'& responses" "retry rules for"
25881 However, when Exim is looking for a retry rule after a remote delivery attempt
25882 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25883 whole address is always used as the key when searching the retry rules. The
25884 rule that is found is used to create a retry time for the combination of the
25885 failing address and the message's sender. It is the combination of sender and
25886 recipient that is delayed in subsequent queue runs until its retry time is
25887 reached. You can delay the recipient without regard to the sender by setting
25888 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25889 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25890 commands.
25891
25892
25893
25894 .section "Choosing which retry rule to use for host and message errors" &&&
25895          "SECID160"
25896 For a temporary error that is not related to an individual address (for
25897 example, a connection timeout), each line in the retry configuration is checked
25898 twice. First, the name of the remote host is used as a domain name (preceded by
25899 &"*@"& when matching a regular expression). If this does not match the line,
25900 the domain from the email address is tried in a similar fashion. For example,
25901 suppose the MX records for &'a.b.c.example'& are
25902 .code
25903 a.b.c.example  MX  5  x.y.z.example
25904                MX  6  p.q.r.example
25905                MX  7  m.n.o.example
25906 .endd
25907 and the retry rules are
25908 .code
25909 p.q.r.example    *      F,24h,30m;
25910 a.b.c.example    *      F,4d,45m;
25911 .endd
25912 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25913 first rule matches neither the host nor the domain, so Exim looks at the second
25914 rule. This does not match the host, but it does match the domain, so it is used
25915 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25916 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25917 first retry rule is used, because it matches the host.
25918
25919 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25920 first rule to determine retry times, but for all the other hosts for the domain
25921 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25922 routing to &'a.b.c.example'& suffers a temporary failure.
25923
25924 &*Note*&: The host name is used when matching the patterns, not its IP address.
25925 However, if a message is routed directly to an IP address without the use of a
25926 host name, for example, if a &(manualroute)& router contains a setting such as:
25927 .code
25928 route_list = *.a.example  192.168.34.23
25929 .endd
25930 then the &"host name"& that is used when searching for a retry rule is the
25931 textual form of the IP address.
25932
25933 .section "Retry rules for specific errors" "SECID161"
25934 .cindex "retry" "specific errors; specifying"
25935 The second field in a retry rule is the name of a particular error, or an
25936 asterisk, which matches any error. The errors that can be tested for are:
25937
25938 .vlist
25939 .vitem &%auth_failed%&
25940 Authentication failed when trying to send to a host in the
25941 &%hosts_require_auth%& list in an &(smtp)& transport.
25942
25943 .vitem &%data_4xx%&
25944 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25945 after the command, or after sending the message's data.
25946
25947 .vitem &%mail_4xx%&
25948 A 4&'xx'& error was received for an outgoing MAIL command.
25949
25950 .vitem &%rcpt_4xx%&
25951 A 4&'xx'& error was received for an outgoing RCPT command.
25952 .endlist
25953
25954 For the three 4&'xx'& errors, either the first or both of the x's can be given
25955 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25956 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25957 and have retries every ten minutes with a one-hour timeout, you could set up a
25958 retry rule of this form:
25959 .code
25960 the.domain.name  rcpt_452   F,1h,10m
25961 .endd
25962 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25963 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25964
25965 .vlist
25966 .vitem &%lost_connection%&
25967 A server unexpectedly closed the SMTP connection. There may, of course,
25968 legitimate reasons for this (host died, network died), but if it repeats a lot
25969 for the same host, it indicates something odd.
25970
25971 .vitem &%lookup%&
25972 A DNS lookup for a host failed.
25973 Note that a &%dnslookup%& router will need to have matched
25974 its &%fail_defer_domains%& option for this retry type to be usable.
25975 Also note that a &%manualroute%& router will probably need
25976 its &%host_find_failed%& option set to &%defer%&.
25977
25978 .vitem &%refused_MX%&
25979 A connection to a host obtained from an MX record was refused.
25980
25981 .vitem &%refused_A%&
25982 A connection to a host not obtained from an MX record was refused.
25983
25984 .vitem &%refused%&
25985 A connection was refused.
25986
25987 .vitem &%timeout_connect_MX%&
25988 A connection attempt to a host obtained from an MX record timed out.
25989
25990 .vitem &%timeout_connect_A%&
25991 A connection attempt to a host not obtained from an MX record timed out.
25992
25993 .vitem &%timeout_connect%&
25994 A connection attempt timed out.
25995
25996 .vitem &%timeout_MX%&
25997 There was a timeout while connecting or during an SMTP session with a host
25998 obtained from an MX record.
25999
26000 .vitem &%timeout_A%&
26001 There was a timeout while connecting or during an SMTP session with a host not
26002 obtained from an MX record.
26003
26004 .vitem &%timeout%&
26005 There was a timeout while connecting or during an SMTP session.
26006
26007 .vitem &%tls_required%&
26008 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26009 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26010 to STARTTLS, or there was a problem setting up the TLS connection.
26011
26012 .vitem &%quota%&
26013 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26014 transport.
26015
26016 .vitem &%quota_%&<&'time'&>
26017 .cindex "quota" "error testing in retry rule"
26018 .cindex "retry" "quota error testing"
26019 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26020 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26021 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26022 for four days.
26023 .endlist
26024
26025 .cindex "mailbox" "time of last read"
26026 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26027 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26028 it should be based on the last time that the user accessed the mailbox.
26029 However, it is not always possible to determine this. Exim uses the following
26030 heuristic rules:
26031
26032 .ilist
26033 If the mailbox is a single file, the time of last access (the &"atime"&) is
26034 used. As no new messages are being delivered (because the mailbox is over
26035 quota), Exim does not access the file, so this is the time of last user access.
26036 .next
26037 .cindex "maildir format" "time of last read"
26038 For a maildir delivery, the time of last modification of the &_new_&
26039 subdirectory is used. As the mailbox is over quota, no new files are created in
26040 the &_new_& subdirectory, because no new messages are being delivered. Any
26041 change to the &_new_& subdirectory is therefore assumed to be the result of an
26042 MUA moving a new message to the &_cur_& directory when it is first read. The
26043 time that is used is therefore the last time that the user read a new message.
26044 .next
26045 For other kinds of multi-file mailbox, the time of last access cannot be
26046 obtained, so a retry rule that uses this type of error field is never matched.
26047 .endlist
26048
26049 The quota errors apply both to system-enforced quotas and to Exim's own quota
26050 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26051 when a local delivery is deferred because a partition is full (the ENOSPC
26052 error).
26053
26054
26055
26056 .section "Retry rules for specified senders" "SECID162"
26057 .cindex "retry" "rules; sender-specific"
26058 You can specify retry rules that apply only when the failing message has a
26059 specific sender. In particular, this can be used to define retry rules that
26060 apply only to bounce messages. The third item in a retry rule can be of this
26061 form:
26062 .display
26063 &`senders=`&<&'address list'&>
26064 .endd
26065 The retry timings themselves are then the fourth item. For example:
26066 .code
26067 *   rcpt_4xx   senders=:   F,1h,30m
26068 .endd
26069 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26070 host. If the address list contains white space, it must be enclosed in quotes.
26071 For example:
26072 .code
26073 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26074 .endd
26075 &*Warning*&: This facility can be unhelpful if it is used for host errors
26076 (which do not depend on the recipient). The reason is that the sender is used
26077 only to match the retry rule. Once the rule has been found for a host error,
26078 its contents are used to set a retry time for the host, and this will apply to
26079 all messages, not just those with specific senders.
26080
26081 When testing retry rules using &%-brt%&, you can supply a sender using the
26082 &%-f%& command line option, like this:
26083 .code
26084 exim -f "" -brt user@dom.ain
26085 .endd
26086 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26087 list is never matched.
26088
26089
26090
26091
26092
26093 .section "Retry parameters" "SECID163"
26094 .cindex "retry" "parameters in rules"
26095 The third (or fourth, if a senders list is present) field in a retry rule is a
26096 sequence of retry parameter sets, separated by semicolons. Each set consists of
26097 .display
26098 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26099 .endd
26100 The letter identifies the algorithm for computing a new retry time; the cutoff
26101 time is the time beyond which this algorithm no longer applies, and the
26102 arguments vary the algorithm's action. The cutoff time is measured from the
26103 time that the first failure for the domain (combined with the local part if
26104 relevant) was detected, not from the time the message was received.
26105
26106 .cindex "retry" "algorithms"
26107 .cindex "retry" "fixed intervals"
26108 .cindex "retry" "increasing intervals"
26109 .cindex "retry" "random intervals"
26110 The available algorithms are:
26111
26112 .ilist
26113 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26114 the interval.
26115 .next
26116 &'G'&: retry at geometrically increasing intervals. The first argument
26117 specifies a starting value for the interval, and the second a multiplier, which
26118 is used to increase the size of the interval at each retry.
26119 .next
26120 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26121 retry, the previous interval is multiplied by the factor in order to get a
26122 maximum for the next interval. The minimum interval is the first argument of
26123 the parameter, and an actual interval is chosen randomly between them. Such a
26124 rule has been found to be helpful in cluster configurations when all the
26125 members of the cluster restart at once, and may therefore synchronize their
26126 queue processing times.
26127 .endlist
26128
26129 When computing the next retry time, the algorithm definitions are scanned in
26130 order until one whose cutoff time has not yet passed is reached. This is then
26131 used to compute a new retry time that is later than the current time. In the
26132 case of fixed interval retries, this simply means adding the interval to the
26133 current time. For geometrically increasing intervals, retry intervals are
26134 computed from the rule's parameters until one that is greater than the previous
26135 interval is found. The main configuration variable
26136 .cindex "limit" "retry interval"
26137 .cindex "retry" "interval, maximum"
26138 .oindex "&%retry_interval_max%&"
26139 &%retry_interval_max%& limits the maximum interval between retries. It
26140 cannot be set greater than &`24h`&, which is its default value.
26141
26142 A single remote domain may have a number of hosts associated with it, and each
26143 host may have more than one IP address. Retry algorithms are selected on the
26144 basis of the domain name, but are applied to each IP address independently. If,
26145 for example, a host has two IP addresses and one is unusable, Exim will
26146 generate retry times for it and will not try to use it until its next retry
26147 time comes. Thus the good IP address is likely to be tried first most of the
26148 time.
26149
26150 .cindex "hints database" "use for retrying"
26151 Retry times are hints rather than promises. Exim does not make any attempt to
26152 run deliveries exactly at the computed times. Instead, a queue runner process
26153 starts delivery processes for delayed messages periodically, and these attempt
26154 new deliveries only for those addresses that have passed their next retry time.
26155 If a new message arrives for a deferred address, an immediate delivery attempt
26156 occurs only if the address has passed its retry time. In the absence of new
26157 messages, the minimum time between retries is the interval between queue runner
26158 processes. There is not much point in setting retry times of five minutes if
26159 your queue runners happen only once an hour, unless there are a significant
26160 number of incoming messages (which might be the case on a system that is
26161 sending everything to a smart host, for example).
26162
26163 The data in the retry hints database can be inspected by using the
26164 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26165 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26166 &'exinext'& utility script can be used to find out what the next retry times
26167 are for the hosts associated with a particular mail domain, and also for local
26168 deliveries that have been deferred.
26169
26170
26171 .section "Retry rule examples" "SECID164"
26172 Here are some example retry rules:
26173 .code
26174 alice@wonderland.fict.example quota_5d  F,7d,3h
26175 wonderland.fict.example       quota_5d
26176 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26177 lookingglass.fict.example     *         F,24h,30m;
26178 *                 refused_A   F,2h,20m;
26179 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26180 .endd
26181 The first rule sets up special handling for mail to
26182 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26183 mailbox has not been read for at least 5 days. Retries continue every three
26184 hours for 7 days. The second rule handles over-quota errors for all other local
26185 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26186 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26187 fail are bounced immediately if the mailbox has not been read for at least 5
26188 days.
26189
26190 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26191 happen every 15 minutes for an hour, then with geometrically increasing
26192 intervals until two days have passed since a delivery first failed. After the
26193 first hour there is a delay of one hour, then two hours, then four hours, and
26194 so on (this is a rather extreme example).
26195
26196 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26197 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26198 all other domains, with special action for connection refusal from hosts that
26199 were not obtained from an MX record.
26200
26201 The final rule in a retry configuration should always have asterisks in the
26202 first two fields so as to provide a general catch-all for any addresses that do
26203 not have their own special handling. This example tries every 15 minutes for 2
26204 hours, then with intervals starting at one hour and increasing by a factor of
26205 1.5 up to 16 hours, then every 8 hours up to 5 days.
26206
26207
26208
26209 .section "Timeout of retry data" "SECID165"
26210 .cindex "timeout" "of retry data"
26211 .oindex "&%retry_data_expire%&"
26212 .cindex "hints database" "data expiry"
26213 .cindex "retry" "timeout of data"
26214 Exim timestamps the data that it writes to its retry hints database. When it
26215 consults the data during a delivery it ignores any that is older than the value
26216 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26217 been tried for 7 days, Exim will try to deliver to it immediately a message
26218 arrives, and if that fails, it will calculate a retry time as if it were
26219 failing for the first time.
26220
26221 This improves the behaviour for messages routed to rarely-used hosts such as MX
26222 backups. If such a host was down at one time, and happens to be down again when
26223 Exim tries a month later, using the old retry data would imply that it had been
26224 down all the time, which is not a justified assumption.
26225
26226 If a host really is permanently dead, this behaviour causes a burst of retries
26227 every now and again, but only if messages routed to it are rare. If there is a
26228 message at least once every 7 days the retry data never expires.
26229
26230
26231
26232
26233 .section "Long-term failures" "SECID166"
26234 .cindex "delivery failure, long-term"
26235 .cindex "retry" "after long-term failure"
26236 Special processing happens when an email address has been failing for so long
26237 that the cutoff time for the last algorithm is reached. For example, using the
26238 default retry rule:
26239 .code
26240 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26241 .endd
26242 the cutoff time is four days. Reaching the retry cutoff is independent of how
26243 long any specific message has been failing; it is the length of continuous
26244 failure for the recipient address that counts.
26245
26246 When the cutoff time is reached for a local delivery, or for all the IP
26247 addresses associated with a remote delivery, a subsequent delivery failure
26248 causes Exim to give up on the address, and a bounce message is generated.
26249 In order to cater for new messages that use the failing address, a next retry
26250 time is still computed from the final algorithm, and is used as follows:
26251
26252 For local deliveries, one delivery attempt is always made for any subsequent
26253 messages. If this delivery fails, the address fails immediately. The
26254 post-cutoff retry time is not used.
26255
26256 .cindex "final cutoff" "retries, controlling"
26257 .cindex retry "final cutoff"
26258 If the delivery is remote, there are two possibilities, controlled by the
26259 .oindex "&%delay_after_cutoff%&"
26260 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26261 default. Until the post-cutoff retry time for one of the IP addresses,
26262 as set by the &%retry_data_expire%& option, is
26263 reached, the failing email address is bounced immediately, without a delivery
26264 attempt taking place. After that time, one new delivery attempt is made to
26265 those IP addresses that are past their retry times, and if that still fails,
26266 the address is bounced and new retry times are computed.
26267
26268 In other words, when all the hosts for a given email address have been failing
26269 for a long time, Exim bounces rather then defers until one of the hosts' retry
26270 times is reached. Then it tries once, and bounces if that attempt fails. This
26271 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26272 to a broken destination, but if the host does recover, Exim will eventually
26273 notice.
26274
26275 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26276 addresses are past their final cutoff time, Exim tries to deliver to those IP
26277 addresses that have not been tried since the message arrived. If there are
26278 no suitable IP addresses, or if they all fail, the address is bounced. In other
26279 words, it does not delay when a new message arrives, but tries the expired
26280 addresses immediately, unless they have been tried since the message arrived.
26281 If there is a continuous stream of messages for the failing domains, setting
26282 &%delay_after_cutoff%& false means that there will be many more attempts to
26283 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26284 true.
26285
26286 .section "Deliveries that work intermittently" "SECID167"
26287 .cindex "retry" "intermittently working deliveries"
26288 Some additional logic is needed to cope with cases where a host is
26289 intermittently available, or when a message has some attribute that prevents
26290 its delivery when others to the same address get through. In this situation,
26291 because some messages are successfully delivered, the &"retry clock"& for the
26292 host or address keeps getting reset by the successful deliveries, and so
26293 failing messages remain in the queue for ever because the cutoff time is never
26294 reached.
26295
26296 Two exceptional actions are applied to prevent this happening. The first
26297 applies to errors that are related to a message rather than a remote host.
26298 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26299 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26300 commands, and quota failures. For this type of error, if a message's arrival
26301 time is earlier than the &"first failed"& time for the error, the earlier time
26302 is used when scanning the retry rules to decide when to try next and when to
26303 time out the address.
26304
26305 The exceptional second action applies in all cases. If a message has been on
26306 the queue for longer than the cutoff time of any applicable retry rule for a
26307 given address, a delivery is attempted for that address, even if it is not yet
26308 time, and if this delivery fails, the address is timed out. A new retry time is
26309 not computed in this case, so that other messages for the same address are
26310 considered immediately.
26311 .ecindex IIDretconf1
26312 .ecindex IIDregconf2
26313
26314
26315
26316
26317
26318
26319 . ////////////////////////////////////////////////////////////////////////////
26320 . ////////////////////////////////////////////////////////////////////////////
26321
26322 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26323 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26324 .scindex IIDauthconf2 "authentication"
26325 The &"authenticators"& section of Exim's runtime configuration is concerned
26326 with SMTP authentication. This facility is an extension to the SMTP protocol,
26327 described in RFC 2554, which allows a client SMTP host to authenticate itself
26328 to a server. This is a common way for a server to recognize clients that are
26329 permitted to use it as a relay. SMTP authentication is not of relevance to the
26330 transfer of mail between servers that have no managerial connection with each
26331 other.
26332
26333 .cindex "AUTH" "description of"
26334 Very briefly, the way SMTP authentication works is as follows:
26335
26336 .ilist
26337 The server advertises a number of authentication &'mechanisms'& in response to
26338 the client's EHLO command.
26339 .next
26340 The client issues an AUTH command, naming a specific mechanism. The command
26341 may, optionally, contain some authentication data.
26342 .next
26343 The server may issue one or more &'challenges'&, to which the client must send
26344 appropriate responses. In simple authentication mechanisms, the challenges are
26345 just prompts for user names and passwords. The server does not have to issue
26346 any challenges &-- in some mechanisms the relevant data may all be transmitted
26347 with the AUTH command.
26348 .next
26349 The server either accepts or denies authentication.
26350 .next
26351 If authentication succeeds, the client may optionally make use of the AUTH
26352 option on the MAIL command to pass an authenticated sender in subsequent
26353 mail transactions. Authentication lasts for the remainder of the SMTP
26354 connection.
26355 .next
26356 If authentication fails, the client may give up, or it may try a different
26357 authentication mechanism, or it may try transferring mail over the
26358 unauthenticated connection.
26359 .endlist
26360
26361 If you are setting up a client, and want to know which authentication
26362 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26363 SMTP port) on the server, and issue an EHLO command. The response to this
26364 includes the list of supported mechanisms. For example:
26365 .display
26366 &`$ `&&*&`telnet server.example 25`&*&
26367 &`Trying 192.168.34.25...`&
26368 &`Connected to server.example.`&
26369 &`Escape character is &#x0027;^]&#x0027;.`&
26370 &`220 server.example ESMTP Exim 4.20 ...`&
26371 &*&`ehlo client.example`&*&
26372 &`250-server.example Hello client.example [10.8.4.5]`&
26373 &`250-SIZE 52428800`&
26374 &`250-PIPELINING`&
26375 &`250-AUTH PLAIN`&
26376 &`250 HELP`&
26377 .endd
26378 The second-last line of this example output shows that the server supports
26379 authentication using the PLAIN mechanism. In Exim, the different authentication
26380 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26381 routers and transports, which authenticators are included in the binary is
26382 controlled by build-time definitions. The following are currently available,
26383 included by setting
26384 .code
26385 AUTH_CRAM_MD5=yes
26386 AUTH_CYRUS_SASL=yes
26387 AUTH_DOVECOT=yes
26388 AUTH_EXTERNAL=yes
26389 AUTH_GSASL=yes
26390 AUTH_HEIMDAL_GSSAPI=yes
26391 AUTH_PLAINTEXT=yes
26392 AUTH_SPA=yes
26393 AUTH_TLS=yes
26394 .endd
26395 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26396 authentication mechanism (RFC 2195), and the second provides an interface to
26397 the Cyrus SASL authentication library.
26398 The third is an interface to Dovecot's authentication system, delegating the
26399 work via a socket interface.
26400 .new
26401 The fourth provides for negotiation of authentication done via non-SMTP means,
26402 as defined by RFC 4422 Appendix A.
26403 .wen
26404 The fifth provides an interface to the GNU SASL authentication library, which
26405 provides mechanisms but typically not data sources.
26406 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26407 supporting setting a server keytab.
26408 The seventh can be configured to support
26409 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26410 not formally documented, but used by several MUAs.
26411 The eighth authenticator
26412 supports Microsoft's &'Secure Password Authentication'& mechanism.
26413 The last is an Exim authenticator but not an SMTP one;
26414 instead it can use information from a TLS negotiation.
26415
26416 The authenticators are configured using the same syntax as other drivers (see
26417 section &<<SECTfordricon>>&). If no authenticators are required, no
26418 authentication section need be present in the configuration file. Each
26419 authenticator can in principle have both server and client functions. When Exim
26420 is receiving SMTP mail, it is acting as a server; when it is sending out
26421 messages over SMTP, it is acting as a client. Authenticator configuration
26422 options are provided for use in both these circumstances.
26423
26424 To make it clear which options apply to which situation, the prefixes
26425 &%server_%& and &%client_%& are used on option names that are specific to
26426 either the server or the client function, respectively. Server and client
26427 functions are disabled if none of their options are set. If an authenticator is
26428 to be used for both server and client functions, a single definition, using
26429 both sets of options, is required. For example:
26430 .code
26431 cram:
26432   driver = cram_md5
26433   public_name = CRAM-MD5
26434   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26435   client_name = ph10
26436   client_secret = secret2
26437 .endd
26438 The &%server_%& option is used when Exim is acting as a server, and the
26439 &%client_%& options when it is acting as a client.
26440
26441 Descriptions of the individual authenticators are given in subsequent chapters.
26442 The remainder of this chapter covers the generic options for the
26443 authenticators, followed by general discussion of the way authentication works
26444 in Exim.
26445
26446 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26447 per-mechanism basis.  Please read carefully to determine which variables hold
26448 account labels such as usercodes and which hold passwords or other
26449 authenticating data.
26450
26451 Note that some mechanisms support two different identifiers for accounts: the
26452 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26453 and &'authz'& are commonly encountered.  The American spelling is standard here.
26454 Conceptually, authentication data such as passwords are tied to the identifier
26455 used to authenticate; servers may have rules to permit one user to act as a
26456 second user, so that after login the session is treated as though that second
26457 user had logged in.  That second user is the &'authorization id'&.  A robust
26458 configuration might confirm that the &'authz'& field is empty or matches the
26459 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26460 as verified data, the &'authz'& as an unverified request which the server might
26461 choose to honour.
26462
26463 A &'realm'& is a text string, typically a domain name, presented by a server
26464 to a client to help it select an account and credentials to use.  In some
26465 mechanisms, the client and server provably agree on the realm, but clients
26466 typically can not treat the realm as secure data to be blindly trusted.
26467
26468
26469
26470 .section "Generic options for authenticators" "SECID168"
26471 .cindex "authentication" "generic options"
26472 .cindex "options" "generic; for authenticators"
26473
26474 .option client_condition authenticators string&!! unset
26475 When Exim is authenticating as a client, it skips any authenticator whose
26476 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26477 used, for example, to skip plain text authenticators when the connection is not
26478 encrypted by a setting such as:
26479 .code
26480 client_condition = ${if !eq{$tls_out_cipher}{}}
26481 .endd
26482
26483
26484 .option client_set_id authenticators string&!! unset
26485 When client authentication succeeds, this condition is expanded; the
26486 result is used in the log lines for outbound messages.
26487 Typically it will be the user name used for authentication.
26488
26489
26490 .option driver authenticators string unset
26491 This option must always be set. It specifies which of the available
26492 authenticators is to be used.
26493
26494
26495 .option public_name authenticators string unset
26496 This option specifies the name of the authentication mechanism that the driver
26497 implements, and by which it is known to the outside world. These names should
26498 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26499 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26500 defaults to the driver's instance name.
26501
26502
26503 .option server_advertise_condition authenticators string&!! unset
26504 When a server is about to advertise an authentication mechanism, the condition
26505 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26506 mechanism is not advertised.
26507 If the expansion fails, the mechanism is not advertised. If the failure was not
26508 forced, and was not caused by a lookup defer, the incident is logged.
26509 See section &<<SECTauthexiser>>& below for further discussion.
26510
26511
26512 .option server_condition authenticators string&!! unset
26513 This option must be set for a &%plaintext%& server authenticator, where it
26514 is used directly to control authentication. See section &<<SECTplainserver>>&
26515 for details.
26516
26517 For the &(gsasl)& authenticator, this option is required for various
26518 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26519
26520 For the other authenticators, &%server_condition%& can be used as an additional
26521 authentication or authorization mechanism that is applied after the other
26522 authenticator conditions succeed. If it is set, it is expanded when the
26523 authenticator would otherwise return a success code. If the expansion is forced
26524 to fail, authentication fails. Any other expansion failure causes a temporary
26525 error code to be returned. If the result of a successful expansion is an empty
26526 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26527 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26528 other result, a temporary error code is returned, with the expanded string as
26529 the error text.
26530
26531
26532 .option server_debug_print authenticators string&!! unset
26533 If this option is set and authentication debugging is enabled (see the &%-d%&
26534 command line option), the string is expanded and included in the debugging
26535 output when the authenticator is run as a server. This can help with checking
26536 out the values of variables.
26537 If expansion of the string fails, the error message is written to the debugging
26538 output, and Exim carries on processing.
26539
26540
26541 .option server_set_id authenticators string&!! unset
26542 .vindex "&$authenticated_id$&"
26543 .vindex "&$authenticated_fail_id$&"
26544 When an Exim server successfully authenticates a client, this string is
26545 expanded using data from the authentication, and preserved for any incoming
26546 messages in the variable &$authenticated_id$&. It is also included in the log
26547 lines for incoming messages. For example, a user/password authenticator
26548 configuration might preserve the user name that was used to authenticate, and
26549 refer to it subsequently during delivery of the message.
26550 On a failing authentication the expansion result is instead saved in
26551 the &$authenticated_fail_id$& variable.
26552 If expansion fails, the option is ignored.
26553
26554
26555 .option server_mail_auth_condition authenticators string&!! unset
26556 This option allows a server to discard authenticated sender addresses supplied
26557 as part of MAIL commands in SMTP connections that are authenticated by the
26558 driver on which &%server_mail_auth_condition%& is set. The option is not used
26559 as part of the authentication process; instead its (unexpanded) value is
26560 remembered for later use.
26561 How it is used is described in the following section.
26562
26563
26564
26565
26566
26567 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26568 .cindex "authentication" "sender; authenticated"
26569 .cindex "AUTH" "on MAIL command"
26570 When a client supplied an AUTH= item on a MAIL command, Exim applies
26571 the following checks before accepting it as the authenticated sender of the
26572 message:
26573
26574 .ilist
26575 If the connection is not using extended SMTP (that is, HELO was used rather
26576 than EHLO), the use of AUTH= is a syntax error.
26577 .next
26578 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26579 .next
26580 .vindex "&$authenticated_sender$&"
26581 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26582 running, the value of &$authenticated_sender$& is set to the value obtained
26583 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26584 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26585 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26586 given for the MAIL command.
26587 .next
26588 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26589 is accepted and placed in &$authenticated_sender$& only if the client has
26590 authenticated.
26591 .next
26592 If the AUTH= value was accepted by either of the two previous rules, and
26593 the client has authenticated, and the authenticator has a setting for the
26594 &%server_mail_auth_condition%&, the condition is checked at this point. The
26595 valued that was saved from the authenticator is expanded. If the expansion
26596 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26597 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26598 the value of &$authenticated_sender$& is retained and passed on with the
26599 message.
26600 .endlist
26601
26602
26603 When &$authenticated_sender$& is set for a message, it is passed on to other
26604 hosts to which Exim authenticates as a client. Do not confuse this value with
26605 &$authenticated_id$&, which is a string obtained from the authentication
26606 process, and which is not usually a complete email address.
26607
26608 .vindex "&$sender_address$&"
26609 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26610 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26611 therefore make use of &$authenticated_sender$&. The converse is not true: the
26612 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26613 ACL is run.
26614
26615
26616
26617 .section "Authentication on an Exim server" "SECTauthexiser"
26618 .cindex "authentication" "on an Exim server"
26619 When Exim receives an EHLO command, it advertises the public names of those
26620 authenticators that are configured as servers, subject to the following
26621 conditions:
26622
26623 .ilist
26624 The client host must match &%auth_advertise_hosts%& (default *).
26625 .next
26626 It the &%server_advertise_condition%& option is set, its expansion must not
26627 yield the empty string, &"0"&, &"no"&, or &"false"&.
26628 .endlist
26629
26630 The order in which the authenticators are defined controls the order in which
26631 the mechanisms are advertised.
26632
26633 Some mail clients (for example, some versions of Netscape) require the user to
26634 provide a name and password for authentication whenever AUTH is advertised,
26635 even though authentication may not in fact be needed (for example, Exim may be
26636 set up to allow unconditional relaying from the client by an IP address check).
26637 You can make such clients more friendly by not advertising AUTH to them.
26638 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26639 that runs for RCPT) to relay without authentication, you should set
26640 .code
26641 auth_advertise_hosts = ! 10.9.8.0/24
26642 .endd
26643 so that no authentication mechanisms are advertised to them.
26644
26645 The &%server_advertise_condition%& controls the advertisement of individual
26646 authentication mechanisms. For example, it can be used to restrict the
26647 advertisement of a particular mechanism to encrypted connections, by a setting
26648 such as:
26649 .code
26650 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26651 .endd
26652 .vindex "&$tls_in_cipher$&"
26653 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26654 yields &"yes"&, which allows the advertisement to happen.
26655
26656 When an Exim server receives an AUTH command from a client, it rejects it
26657 immediately if AUTH was not advertised in response to an earlier EHLO
26658 command. This is the case if
26659
26660 .ilist
26661 The client host does not match &%auth_advertise_hosts%&; or
26662 .next
26663 No authenticators are configured with server options; or
26664 .next
26665 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26666 server authenticators.
26667 .endlist
26668
26669
26670 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26671 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26672 AUTH is accepted from any client host.
26673
26674 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26675 server authentication mechanism that was advertised in response to EHLO and
26676 that matches the one named in the AUTH command. If it finds one, it runs
26677 the appropriate authentication protocol, and authentication either succeeds or
26678 fails. If there is no matching advertised mechanism, the AUTH command is
26679 rejected with a 504 error.
26680
26681 .vindex "&$received_protocol$&"
26682 .vindex "&$sender_host_authenticated$&"
26683 When a message is received from an authenticated host, the value of
26684 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26685 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26686 public name) of the authenticator driver that successfully authenticated the
26687 client from which the message was received. This variable is empty if there was
26688 no successful authentication.
26689
26690 .cindex authentication "expansion item"
26691 Successful authentication sets up information used by the
26692 &$authresults$& expansion item.
26693
26694
26695
26696
26697 .section "Testing server authentication" "SECID169"
26698 .cindex "authentication" "testing a server"
26699 .cindex "AUTH" "testing a server"
26700 .cindex "base64 encoding" "creating authentication test data"
26701 Exim's &%-bh%& option can be useful for testing server authentication
26702 configurations. The data for the AUTH command has to be sent using base64
26703 encoding. A quick way to produce such data for testing is the following Perl
26704 script:
26705 .code
26706 use MIME::Base64;
26707 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26708 .endd
26709 .cindex "binary zero" "in authentication data"
26710 This interprets its argument as a Perl string, and then encodes it. The
26711 interpretation as a Perl string allows binary zeros, which are required for
26712 some kinds of authentication, to be included in the data. For example, a
26713 command line to run this script on such data might be
26714 .code
26715 encode '\0user\0password'
26716 .endd
26717 Note the use of single quotes to prevent the shell interpreting the
26718 backslashes, so that they can be interpreted by Perl to specify characters
26719 whose code value is zero.
26720
26721 &*Warning 1*&: If either of the user or password strings starts with an octal
26722 digit, you must use three zeros instead of one after the leading backslash. If
26723 you do not, the octal digit that starts your string will be incorrectly
26724 interpreted as part of the code for the first character.
26725
26726 &*Warning 2*&: If there are characters in the strings that Perl interprets
26727 specially, you must use a Perl escape to prevent them being misinterpreted. For
26728 example, a command such as
26729 .code
26730 encode '\0user@domain.com\0pas$$word'
26731 .endd
26732 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26733
26734 If you have the &%mimencode%& command installed, another way to do produce
26735 base64-encoded strings is to run the command
26736 .code
26737 echo -e -n `\0user\0password' | mimencode
26738 .endd
26739 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26740 in the argument, and the &%-n%& option specifies no newline at the end of its
26741 output. However, not all versions of &%echo%& recognize these options, so you
26742 should check your version before relying on this suggestion.
26743
26744
26745
26746 .section "Authentication by an Exim client" "SECID170"
26747 .cindex "authentication" "on an Exim client"
26748 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26749 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26750 announces support for authentication, and the host matches an entry in either
26751 of these options, Exim (as a client) tries to authenticate as follows:
26752
26753 .ilist
26754 For each authenticator that is configured as a client, in the order in which
26755 they are defined in the configuration, it searches the authentication
26756 mechanisms announced by the server for one whose name matches the public name
26757 of the authenticator.
26758 .next
26759 .vindex "&$host$&"
26760 .vindex "&$host_address$&"
26761 When it finds one that matches, it runs the authenticator's client code. The
26762 variables &$host$& and &$host_address$& are available for any string expansions
26763 that the client might do. They are set to the server's name and IP address. If
26764 any expansion is forced to fail, the authentication attempt is abandoned, and
26765 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26766 delivery to be deferred.
26767 .next
26768 If the result of the authentication attempt is a temporary error or a timeout,
26769 Exim abandons trying to send the message to the host for the moment. It will
26770 try again later. If there are any backup hosts available, they are tried in the
26771 usual way.
26772 .next
26773 If the response to authentication is a permanent error (5&'xx'& code), Exim
26774 carries on searching the list of authenticators and tries another one if
26775 possible. If all authentication attempts give permanent errors, or if there are
26776 no attempts because no mechanisms match (or option expansions force failure),
26777 what happens depends on whether the host matches &%hosts_require_auth%& or
26778 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26779 delivery is deferred. The error can be detected in the retry rules, and thereby
26780 turned into a permanent error if you wish. In the second case, Exim tries to
26781 deliver the message unauthenticated.
26782 .endlist
26783
26784 Note that the hostlist test for whether to do authentication can be
26785 confused if name-IP lookups change between the time the peer is decided
26786 upon and the time that the transport runs.  For example, with a manualroute
26787 router given a host name, and with DNS "round-robin" used by that name: if
26788 the local resolver cache times out between the router and the transport
26789 running, the transport may get an IP for the name for its authentication
26790 check which does not match the connection peer IP.
26791 No authentication will then be done, despite the names being identical.
26792
26793 For such cases use a separate transport which always authenticates.
26794
26795 .cindex "AUTH" "on MAIL command"
26796 When Exim has authenticated itself to a remote server, it adds the AUTH
26797 parameter to the MAIL commands it sends, if it has an authenticated sender for
26798 the message. If the message came from a remote host, the authenticated sender
26799 is the one that was receiving on an incoming MAIL command, provided that the
26800 incoming connection was authenticated and the &%server_mail_auth%& condition
26801 allowed the authenticated sender to be retained. If a local process calls Exim
26802 to send a message, the sender address that is built from the login name and
26803 &%qualify_domain%& is treated as authenticated. However, if the
26804 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26805 the authenticated sender that was received with the message.
26806 .ecindex IIDauthconf1
26807 .ecindex IIDauthconf2
26808
26809
26810
26811
26812
26813
26814 . ////////////////////////////////////////////////////////////////////////////
26815 . ////////////////////////////////////////////////////////////////////////////
26816
26817 .chapter "The plaintext authenticator" "CHAPplaintext"
26818 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26819 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26820 The &(plaintext)& authenticator can be configured to support the PLAIN and
26821 LOGIN authentication mechanisms, both of which transfer authentication data as
26822 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26823 security risk; you are strongly advised to insist on the use of SMTP encryption
26824 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26825 use unencrypted plain text, you should not use the same passwords for SMTP
26826 connections as you do for login accounts.
26827
26828 .section "Plaintext options" "SECID171"
26829 .cindex "options" "&(plaintext)& authenticator (server)"
26830 When configured as a server, &(plaintext)& uses the following options:
26831
26832 .option server_condition authenticators string&!! unset
26833 This is actually a global authentication option, but it must be set in order to
26834 configure the &(plaintext)& driver as a server. Its use is described below.
26835
26836 .option server_prompts plaintext string&!! unset
26837 The contents of this option, after expansion, must be a colon-separated list of
26838 prompt strings. If expansion fails, a temporary authentication rejection is
26839 given.
26840
26841 .section "Using plaintext in a server" "SECTplainserver"
26842 .cindex "AUTH" "in &(plaintext)& authenticator"
26843 .cindex "binary zero" "in &(plaintext)& authenticator"
26844 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26845         "in &(plaintext)& authenticator"
26846 .vindex "&$auth1$&, &$auth2$&, etc"
26847 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26848
26849 When running as a server, &(plaintext)& performs the authentication test by
26850 expanding a string. The data sent by the client with the AUTH command, or in
26851 response to subsequent prompts, is base64 encoded, and so may contain any byte
26852 values when decoded. If any data is supplied with the command, it is treated as
26853 a list of strings, separated by NULs (binary zeros), the first three of which
26854 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26855 (neither LOGIN nor PLAIN uses more than three strings).
26856
26857 For compatibility with previous releases of Exim, the values are also placed in
26858 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26859 variables for this purpose is now deprecated, as it can lead to confusion in
26860 string expansions that also use them for other things.
26861
26862 If there are more strings in &%server_prompts%& than the number of strings
26863 supplied with the AUTH command, the remaining prompts are used to obtain more
26864 data. Each response from the client may be a list of NUL-separated strings.
26865
26866 .vindex "&$authenticated_id$&"
26867 Once a sufficient number of data strings have been received,
26868 &%server_condition%& is expanded. If the expansion is forced to fail,
26869 authentication fails. Any other expansion failure causes a temporary error code
26870 to be returned. If the result of a successful expansion is an empty string,
26871 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26872 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26873 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26874 For any other result, a temporary error code is returned, with the expanded
26875 string as the error text.
26876
26877 &*Warning*&: If you use a lookup in the expansion to find the user's
26878 password, be sure to make the authentication fail if the user is unknown.
26879 There are good and bad examples at the end of the next section.
26880
26881
26882
26883 .section "The PLAIN authentication mechanism" "SECID172"
26884 .cindex "PLAIN authentication mechanism"
26885 .cindex "authentication" "PLAIN mechanism"
26886 .cindex "binary zero" "in &(plaintext)& authenticator"
26887 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26888 sent as one item of data (that is, one combined string containing two NUL
26889 separators). The data is sent either as part of the AUTH command, or
26890 subsequently in response to an empty prompt from the server.
26891
26892 The second and third strings are a user name and a corresponding password.
26893 Using a single fixed user name and password as an example, this could be
26894 configured as follows:
26895 .code
26896 fixed_plain:
26897   driver = plaintext
26898   public_name = PLAIN
26899   server_prompts = :
26900   server_condition = \
26901     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26902   server_set_id = $auth2
26903 .endd
26904 Note that the default result strings from &%if%& (&"true"& or an empty string)
26905 are exactly what we want here, so they need not be specified. Obviously, if the
26906 password contains expansion-significant characters such as dollar, backslash,
26907 or closing brace, they have to be escaped.
26908
26909 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26910 the end of a string list are ignored). If all the data comes as part of the
26911 AUTH command, as is commonly the case, the prompt is not used. This
26912 authenticator is advertised in the response to EHLO as
26913 .code
26914 250-AUTH PLAIN
26915 .endd
26916 and a client host can authenticate itself by sending the command
26917 .code
26918 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26919 .endd
26920 As this contains three strings (more than the number of prompts), no further
26921 data is required from the client. Alternatively, the client may just send
26922 .code
26923 AUTH PLAIN
26924 .endd
26925 to initiate authentication, in which case the server replies with an empty
26926 prompt. The client must respond with the combined data string.
26927
26928 The data string is base64 encoded, as required by the RFC. This example,
26929 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26930 represents a zero byte. This is split up into three strings, the first of which
26931 is empty. The &%server_condition%& option in the authenticator checks that the
26932 second two are &`username`& and &`mysecret`& respectively.
26933
26934 Having just one fixed user name and password, as in this example, is not very
26935 realistic, though for a small organization with only a handful of
26936 authenticating clients it could make sense.
26937
26938 A more sophisticated instance of this authenticator could use the user name in
26939 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26940 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26941 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26942 This is an incorrect example:
26943 .code
26944 server_condition = \
26945   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26946 .endd
26947 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26948 which it then compares to the supplied password (&$auth3$&). Why is this example
26949 incorrect? It works fine for existing users, but consider what happens if a
26950 non-existent user name is given. The lookup fails, but as no success/failure
26951 strings are given for the lookup, it yields an empty string. Thus, to defeat
26952 the authentication, all a client has to do is to supply a non-existent user
26953 name and an empty password. The correct way of writing this test is:
26954 .code
26955 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26956   {${if eq{$value}{$auth3}}} {false}}
26957 .endd
26958 In this case, if the lookup succeeds, the result is checked; if the lookup
26959 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26960 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26961 always fails if its second argument is empty. However, the second way of
26962 writing the test makes the logic clearer.
26963
26964
26965 .section "The LOGIN authentication mechanism" "SECID173"
26966 .cindex "LOGIN authentication mechanism"
26967 .cindex "authentication" "LOGIN mechanism"
26968 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26969 in a number of programs. No data is sent with the AUTH command. Instead, a
26970 user name and password are supplied separately, in response to prompts. The
26971 plaintext authenticator can be configured to support this as in this example:
26972 .code
26973 fixed_login:
26974   driver = plaintext
26975   public_name = LOGIN
26976   server_prompts = User Name : Password
26977   server_condition = \
26978     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26979   server_set_id = $auth1
26980 .endd
26981 Because of the way plaintext operates, this authenticator accepts data supplied
26982 with the AUTH command (in contravention of the specification of LOGIN), but
26983 if the client does not supply it (as is the case for LOGIN clients), the prompt
26984 strings are used to obtain two data items.
26985
26986 Some clients are very particular about the precise text of the prompts. For
26987 example, Outlook Express is reported to recognize only &"Username:"& and
26988 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26989 strings. It uses the &%ldapauth%& expansion condition to check the user
26990 name and password by binding to an LDAP server:
26991 .code
26992 login:
26993   driver = plaintext
26994   public_name = LOGIN
26995   server_prompts = Username:: : Password::
26996   server_condition = ${if and{{ \
26997     !eq{}{$auth1} }{ \
26998     ldapauth{\
26999       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27000       pass=${quote:$auth2} \
27001       ldap://ldap.example.org/} }} }
27002   server_set_id = uid=$auth1,ou=people,o=example.org
27003 .endd
27004 We have to check that the username is not empty before using it, because LDAP
27005 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27006 operator to correctly quote the DN for authentication. However, the basic
27007 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27008 correct one to use for the password, because quoting is needed only to make
27009 the password conform to the Exim syntax. At the LDAP level, the password is an
27010 uninterpreted string.
27011
27012
27013 .section "Support for different kinds of authentication" "SECID174"
27014 A number of string expansion features are provided for the purpose of
27015 interfacing to different ways of user authentication. These include checking
27016 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27017 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27018 &<<SECTexpcond>>&.
27019
27020
27021
27022
27023 .section "Using plaintext in a client" "SECID175"
27024 .cindex "options" "&(plaintext)& authenticator (client)"
27025 The &(plaintext)& authenticator has two client options:
27026
27027 .option client_ignore_invalid_base64 plaintext boolean false
27028 If the client receives a server prompt that is not a valid base64 string,
27029 authentication is abandoned by default. However, if this option is set true,
27030 the error in the challenge is ignored and the client sends the response as
27031 usual.
27032
27033 .option client_send plaintext string&!! unset
27034 The string is a colon-separated list of authentication data strings. Each
27035 string is independently expanded before being sent to the server. The first
27036 string is sent with the AUTH command; any more strings are sent in response
27037 to prompts from the server. Before each string is expanded, the value of the
27038 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27039 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27040 way. Thus, the prompt that is received in response to sending the first string
27041 (with the AUTH command) can be used in the expansion of the second string, and
27042 so on. If an invalid base64 string is received when
27043 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27044 &$auth$&<&'n'&> variable.
27045
27046 &*Note*&: You cannot use expansion to create multiple strings, because
27047 splitting takes priority and happens first.
27048
27049 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27050 the data, further processing is applied to each string before it is sent. If
27051 there are any single circumflex characters in the string, they are converted to
27052 NULs. Should an actual circumflex be required as data, it must be doubled in
27053 the string.
27054
27055 This is an example of a client configuration that implements the PLAIN
27056 authentication mechanism with a fixed user name and password:
27057 .code
27058 fixed_plain:
27059   driver = plaintext
27060   public_name = PLAIN
27061   client_send = ^username^mysecret
27062 .endd
27063 The lack of colons means that the entire text is sent with the AUTH
27064 command, with the circumflex characters converted to NULs. A similar example
27065 that uses the LOGIN mechanism is:
27066 .code
27067 fixed_login:
27068   driver = plaintext
27069   public_name = LOGIN
27070   client_send = : username : mysecret
27071 .endd
27072 The initial colon means that the first string is empty, so no data is sent with
27073 the AUTH command itself. The remaining strings are sent in response to
27074 prompts.
27075 .ecindex IIDplaiauth1
27076 .ecindex IIDplaiauth2
27077
27078
27079
27080
27081 . ////////////////////////////////////////////////////////////////////////////
27082 . ////////////////////////////////////////////////////////////////////////////
27083
27084 .chapter "The cram_md5 authenticator" "CHID9"
27085 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27086 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27087 .cindex "CRAM-MD5 authentication mechanism"
27088 .cindex "authentication" "CRAM-MD5 mechanism"
27089 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27090 sends a challenge string to the client, and the response consists of a user
27091 name and the CRAM-MD5 digest of the challenge string combined with a secret
27092 string (password) which is known to both server and client. Thus, the secret
27093 is not sent over the network as plain text, which makes this authenticator more
27094 secure than &(plaintext)&. However, the downside is that the secret has to be
27095 available in plain text at either end.
27096
27097
27098 .section "Using cram_md5 as a server" "SECID176"
27099 .cindex "options" "&(cram_md5)& authenticator (server)"
27100 This authenticator has one server option, which must be set to configure the
27101 authenticator as a server:
27102
27103 .option server_secret cram_md5 string&!! unset
27104 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27105 When the server receives the client's response, the user name is placed in
27106 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27107 obtain the password for that user. The server then computes the CRAM-MD5 digest
27108 that the client should have sent, and checks that it received the correct
27109 string. If the expansion of &%server_secret%& is forced to fail, authentication
27110 fails. If the expansion fails for some other reason, a temporary error code is
27111 returned to the client.
27112
27113 For compatibility with previous releases of Exim, the user name is also placed
27114 in &$1$&. However, the use of this variables for this purpose is now
27115 deprecated, as it can lead to confusion in string expansions that also use
27116 numeric variables for other things.
27117
27118 For example, the following authenticator checks that the user name given by the
27119 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27120 user name, authentication fails.
27121 .code
27122 fixed_cram:
27123   driver = cram_md5
27124   public_name = CRAM-MD5
27125   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27126   server_set_id = $auth1
27127 .endd
27128 .vindex "&$authenticated_id$&"
27129 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27130 name in &$authenticated_id$&. A more typical configuration might look up the
27131 secret string in a file, using the user name as the key. For example:
27132 .code
27133 lookup_cram:
27134   driver = cram_md5
27135   public_name = CRAM-MD5
27136   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27137                   {$value}fail}
27138   server_set_id = $auth1
27139 .endd
27140 Note that this expansion explicitly forces failure if the lookup fails
27141 because &$auth1$& contains an unknown user name.
27142
27143 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27144 using the relevant libraries, you need to know the realm to specify in the
27145 lookup and then ask for the &"userPassword"& attribute for that user in that
27146 realm, with:
27147 .code
27148 cyrusless_crammd5:
27149   driver = cram_md5
27150   public_name = CRAM-MD5
27151   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27152                   dbmjz{/etc/sasldb2}{$value}fail}
27153   server_set_id = $auth1
27154 .endd
27155
27156 .section "Using cram_md5 as a client" "SECID177"
27157 .cindex "options" "&(cram_md5)& authenticator (client)"
27158 When used as a client, the &(cram_md5)& authenticator has two options:
27159
27160
27161
27162 .option client_name cram_md5 string&!! "the primary host name"
27163 This string is expanded, and the result used as the user name data when
27164 computing the response to the server's challenge.
27165
27166
27167 .option client_secret cram_md5 string&!! unset
27168 This option must be set for the authenticator to work as a client. Its value is
27169 expanded and the result used as the secret string when computing the response.
27170
27171
27172 .vindex "&$host$&"
27173 .vindex "&$host_address$&"
27174 Different user names and secrets can be used for different servers by referring
27175 to &$host$& or &$host_address$& in the options. Forced failure of either
27176 expansion string is treated as an indication that this authenticator is not
27177 prepared to handle this case. Exim moves on to the next configured client
27178 authenticator. Any other expansion failure causes Exim to give up trying to
27179 send the message to the current server.
27180
27181 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27182 strings, is:
27183 .code
27184 fixed_cram:
27185   driver = cram_md5
27186   public_name = CRAM-MD5
27187   client_name = ph10
27188   client_secret = secret
27189 .endd
27190 .ecindex IIDcramauth1
27191 .ecindex IIDcramauth2
27192
27193
27194
27195 . ////////////////////////////////////////////////////////////////////////////
27196 . ////////////////////////////////////////////////////////////////////////////
27197
27198 .chapter "The cyrus_sasl authenticator" "CHID10"
27199 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27200 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27201 .cindex "Cyrus" "SASL library"
27202 .cindex "Kerberos"
27203 The code for this authenticator was provided by Matthew Byng-Maddick while
27204 at A L Digital Ltd.
27205
27206 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27207 library implementation of the RFC 2222 (&"Simple Authentication and Security
27208 Layer"&). This library supports a number of authentication mechanisms,
27209 including PLAIN and LOGIN, but also several others that Exim does not support
27210 directly. In particular, there is support for Kerberos authentication.
27211
27212 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27213 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27214 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27215 name of the driver to determine which mechanism to support.
27216
27217 Where access to some kind of secret file is required, for example, in GSSAPI
27218 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27219 user, and that the Cyrus SASL library has no way of escalating privileges
27220 by default. You may also find you need to set environment variables,
27221 depending on the driver you are using.
27222
27223 The application name provided by Exim is &"exim"&, so various SASL options may
27224 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27225 Kerberos, note that because of limitations in the GSSAPI interface,
27226 changing the server keytab might need to be communicated down to the Kerberos
27227 layer independently. The mechanism for doing so is dependent upon the Kerberos
27228 implementation.
27229
27230 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27231 may be set to point to an alternative keytab file. Exim will pass this
27232 variable through from its own inherited environment when started as root or the
27233 Exim user. The keytab file needs to be readable by the Exim user.
27234 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27235 environment variable.  In practice, for those releases, the Cyrus authenticator
27236 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27237 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27238
27239
27240 .section "Using cyrus_sasl as a server" "SECID178"
27241 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27242 (on a successful authentication) into &$auth1$&. For compatibility with
27243 previous releases of Exim, the username is also placed in &$1$&. However, the
27244 use of this variable for this purpose is now deprecated, as it can lead to
27245 confusion in string expansions that also use numeric variables for other
27246 things.
27247
27248
27249 .option server_hostname cyrus_sasl string&!! "see below"
27250 This option selects the hostname that is used when communicating with the
27251 library. The default value is &`$primary_hostname`&. It is up to the underlying
27252 SASL plug-in what it does with this data.
27253
27254
27255 .option server_mech cyrus_sasl string "see below"
27256 This option selects the authentication mechanism this driver should use. The
27257 default is the value of the generic &%public_name%& option. This option allows
27258 you to use a different underlying mechanism from the advertised name. For
27259 example:
27260 .code
27261 sasl:
27262   driver = cyrus_sasl
27263   public_name = X-ANYTHING
27264   server_mech = CRAM-MD5
27265   server_set_id = $auth1
27266 .endd
27267
27268 .option server_realm cyrus_sasl string&!! unset
27269 This specifies the SASL realm that the server claims to be in.
27270
27271
27272 .option server_service cyrus_sasl string &`smtp`&
27273 This is the SASL service that the server claims to implement.
27274
27275
27276 For straightforward cases, you do not need to set any of the authenticator's
27277 private options. All you need to do is to specify an appropriate mechanism as
27278 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27279 PLAIN, you could have two authenticators as follows:
27280 .code
27281 sasl_cram_md5:
27282   driver = cyrus_sasl
27283   public_name = CRAM-MD5
27284   server_set_id = $auth1
27285
27286 sasl_plain:
27287   driver = cyrus_sasl
27288   public_name = PLAIN
27289   server_set_id = $auth2
27290 .endd
27291 Cyrus SASL does implement the LOGIN authentication method, even though it is
27292 not a standard method. It is disabled by default in the source distribution,
27293 but it is present in many binary distributions.
27294 .ecindex IIDcyrauth1
27295 .ecindex IIDcyrauth2
27296
27297
27298
27299
27300 . ////////////////////////////////////////////////////////////////////////////
27301 . ////////////////////////////////////////////////////////////////////////////
27302 .chapter "The dovecot authenticator" "CHAPdovecot"
27303 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27304 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27305 This authenticator is an interface to the authentication facility of the
27306 Dovecot POP/IMAP server, which can support a number of authentication methods.
27307 Note that Dovecot must be configured to use auth-client not auth-userdb.
27308 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27309 to use the same mechanisms for SMTP authentication. This is a server
27310 authenticator only. There is only one option:
27311
27312 .option server_socket dovecot string unset
27313
27314 This option must specify the UNIX socket that is the interface to Dovecot
27315 authentication. The &%public_name%& option must specify an authentication
27316 mechanism that Dovecot is configured to support. You can have several
27317 authenticators for different mechanisms. For example:
27318 .code
27319 dovecot_plain:
27320   driver = dovecot
27321   public_name = PLAIN
27322   server_socket = /var/run/dovecot/auth-client
27323   server_set_id = $auth1
27324
27325 dovecot_ntlm:
27326   driver = dovecot
27327   public_name = NTLM
27328   server_socket = /var/run/dovecot/auth-client
27329   server_set_id = $auth1
27330 .endd
27331 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27332 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27333 option is passed in the Dovecot authentication command. If, for a TLS
27334 connection, a client certificate has been verified, the &"valid-client-cert"&
27335 option is passed. When authentication succeeds, the identity of the user
27336 who authenticated is placed in &$auth1$&.
27337 .ecindex IIDdcotauth1
27338 .ecindex IIDdcotauth2
27339
27340
27341 . ////////////////////////////////////////////////////////////////////////////
27342 . ////////////////////////////////////////////////////////////////////////////
27343 .chapter "The gsasl authenticator" "CHAPgsasl"
27344 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27345 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27346 .cindex "authentication" "GNU SASL"
27347 .cindex "authentication" "SASL"
27348 .cindex "authentication" "EXTERNAL"
27349 .cindex "authentication" "ANONYMOUS"
27350 .cindex "authentication" "PLAIN"
27351 .cindex "authentication" "LOGIN"
27352 .cindex "authentication" "DIGEST-MD5"
27353 .cindex "authentication" "CRAM-MD5"
27354 .cindex "authentication" "SCRAM-SHA-1"
27355 The &(gsasl)& authenticator provides server integration for the GNU SASL
27356 library and the mechanisms it provides.  This is new as of the 4.80 release
27357 and there are a few areas where the library does not let Exim smoothly
27358 scale to handle future authentication mechanisms, so no guarantee can be
27359 made that any particular new authentication mechanism will be supported
27360 without code changes in Exim.
27361
27362 Exim's &(gsasl)& authenticator does not have client-side support at this
27363 time; only the server-side support is implemented.  Patches welcome.
27364
27365
27366 .option server_channelbinding gsasl boolean false
27367 Do not set this true without consulting a cryptographic engineer.
27368
27369 Some authentication mechanisms are able to use external context at both ends
27370 of the session to bind the authentication to that context, and fail the
27371 authentication process if that context differs.  Specifically, some TLS
27372 ciphersuites can provide identifying information about the cryptographic
27373 context.
27374
27375 This should have meant that certificate identity and verification becomes a
27376 non-issue, as a man-in-the-middle attack will cause the correct client and
27377 server to see different identifiers and authentication will fail.
27378
27379 This is currently only supported when using the GnuTLS library.  This is
27380 only usable by mechanisms which support "channel binding"; at time of
27381 writing, that's the SCRAM family.
27382
27383 This defaults off to ensure smooth upgrade across Exim releases, in case
27384 this option causes some clients to start failing.  Some future release
27385 of Exim might have switched the default to be true.
27386
27387 However, Channel Binding in TLS has proven to be broken in current versions.
27388 Do not plan to rely upon this feature for security, ever, without consulting
27389 with a subject matter expert (a cryptographic engineer).
27390
27391
27392 .option server_hostname gsasl string&!! "see below"
27393 This option selects the hostname that is used when communicating with the
27394 library. The default value is &`$primary_hostname`&.
27395 Some mechanisms will use this data.
27396
27397
27398 .option server_mech gsasl string "see below"
27399 This option selects the authentication mechanism this driver should use. The
27400 default is the value of the generic &%public_name%& option. This option allows
27401 you to use a different underlying mechanism from the advertised name. For
27402 example:
27403 .code
27404 sasl:
27405   driver = gsasl
27406   public_name = X-ANYTHING
27407   server_mech = CRAM-MD5
27408   server_set_id = $auth1
27409 .endd
27410
27411
27412 .option server_password gsasl string&!! unset
27413 Various mechanisms need access to the cleartext password on the server, so
27414 that proof-of-possession can be demonstrated on the wire, without sending
27415 the password itself.
27416
27417 The data available for lookup varies per mechanism.
27418 In all cases, &$auth1$& is set to the &'authentication id'&.
27419 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27420 if available, else the empty string.
27421 The &$auth3$& variable will always be the &'realm'& if available,
27422 else the empty string.
27423
27424 A forced failure will cause authentication to defer.
27425
27426 If using this option, it may make sense to set the &%server_condition%&
27427 option to be simply "true".
27428
27429
27430 .option server_realm gsasl string&!! unset
27431 This specifies the SASL realm that the server claims to be in.
27432 Some mechanisms will use this data.
27433
27434
27435 .option server_scram_iter gsasl string&!! unset
27436 This option provides data for the SCRAM family of mechanisms.
27437 &$auth1$& is not available at evaluation time.
27438 (This may change, as we receive feedback on use)
27439
27440
27441 .option server_scram_salt gsasl string&!! unset
27442 This option provides data for the SCRAM family of mechanisms.
27443 &$auth1$& is not available at evaluation time.
27444 (This may change, as we receive feedback on use)
27445
27446
27447 .option server_service gsasl string &`smtp`&
27448 This is the SASL service that the server claims to implement.
27449 Some mechanisms will use this data.
27450
27451
27452 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27453 .vindex "&$auth1$&, &$auth2$&, etc"
27454 These may be set when evaluating specific options, as detailed above.
27455 They will also be set when evaluating &%server_condition%&.
27456
27457 Unless otherwise stated below, the &(gsasl)& integration will use the following
27458 meanings for these variables:
27459
27460 .ilist
27461 .vindex "&$auth1$&"
27462 &$auth1$&: the &'authentication id'&
27463 .next
27464 .vindex "&$auth2$&"
27465 &$auth2$&: the &'authorization id'&
27466 .next
27467 .vindex "&$auth3$&"
27468 &$auth3$&: the &'realm'&
27469 .endlist
27470
27471 On a per-mechanism basis:
27472
27473 .ilist
27474 .cindex "authentication" "EXTERNAL"
27475 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27476 the &%server_condition%& option must be present.
27477 .next
27478 .cindex "authentication" "ANONYMOUS"
27479 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27480 the &%server_condition%& option must be present.
27481 .next
27482 .cindex "authentication" "GSSAPI"
27483 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27484 &$auth2$& will be set to the &'authorization id'&,
27485 the &%server_condition%& option must be present.
27486 .endlist
27487
27488 An &'anonymous token'& is something passed along as an unauthenticated
27489 identifier; this is analogous to FTP anonymous authentication passing an
27490 email address, or software-identifier@, as the "password".
27491
27492
27493 An example showing the password having the realm specified in the callback
27494 and demonstrating a Cyrus SASL to GSASL migration approach is:
27495 .code
27496 gsasl_cyrusless_crammd5:
27497   driver = gsasl
27498   public_name = CRAM-MD5
27499   server_realm = imap.example.org
27500   server_password = ${lookup{$auth1:$auth3:userPassword}\
27501                     dbmjz{/etc/sasldb2}{$value}fail}
27502   server_set_id = ${quote:$auth1}
27503   server_condition = yes
27504 .endd
27505
27506
27507 . ////////////////////////////////////////////////////////////////////////////
27508 . ////////////////////////////////////////////////////////////////////////////
27509
27510 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27511 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27512 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27513 .cindex "authentication" "GSSAPI"
27514 .cindex "authentication" "Kerberos"
27515 The &(heimdal_gssapi)& authenticator provides server integration for the
27516 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27517 reliably.
27518
27519 .option server_hostname heimdal_gssapi string&!! "see below"
27520 This option selects the hostname that is used, with &%server_service%&,
27521 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27522 identifier.  The default value is &`$primary_hostname`&.
27523
27524 .option server_keytab heimdal_gssapi string&!! unset
27525 If set, then Heimdal will not use the system default keytab (typically
27526 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27527 The value should be a pathname, with no &"file:"& prefix.
27528
27529 .option server_service heimdal_gssapi string&!! "smtp"
27530 This option specifies the service identifier used, in conjunction with
27531 &%server_hostname%&, for building the identifier for finding credentials
27532 from the keytab.
27533
27534
27535 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27536 Beware that these variables will typically include a realm, thus will appear
27537 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27538 not verified, so a malicious client can set it to anything.
27539
27540 The &$auth1$& field should be safely trustable as a value from the Key
27541 Distribution Center.  Note that these are not quite email addresses.
27542 Each identifier is for a role, and so the left-hand-side may include a
27543 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27544
27545 .vindex "&$auth1$&, &$auth2$&, etc"
27546 .ilist
27547 .vindex "&$auth1$&"
27548 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27549 .next
27550 .vindex "&$auth2$&"
27551 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27552 authentication.  If that was empty, this will also be set to the
27553 GSS Display Name.
27554 .endlist
27555
27556
27557 . ////////////////////////////////////////////////////////////////////////////
27558 . ////////////////////////////////////////////////////////////////////////////
27559
27560 .chapter "The spa authenticator" "CHAPspa"
27561 .scindex IIDspaauth1 "&(spa)& authenticator"
27562 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27563 .cindex "authentication" "Microsoft Secure Password"
27564 .cindex "authentication" "NTLM"
27565 .cindex "Microsoft Secure Password Authentication"
27566 .cindex "NTLM authentication"
27567 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27568 Password Authentication'& mechanism,
27569 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27570 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27571 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27572 server side was subsequently contributed by Tom Kistner. The mechanism works as
27573 follows:
27574
27575 .ilist
27576 After the AUTH command has been accepted, the client sends an SPA
27577 authentication request based on the user name and optional domain.
27578 .next
27579 The server sends back a challenge.
27580 .next
27581 The client builds a challenge response which makes use of the user's password
27582 and sends it to the server, which then accepts or rejects it.
27583 .endlist
27584
27585 Encryption is used to protect the password in transit.
27586
27587
27588
27589 .section "Using spa as a server" "SECID179"
27590 .cindex "options" "&(spa)& authenticator (server)"
27591 The &(spa)& authenticator has just one server option:
27592
27593 .option server_password spa string&!! unset
27594 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27595 This option is expanded, and the result must be the cleartext password for the
27596 authenticating user, whose name is at this point in &$auth1$&. For
27597 compatibility with previous releases of Exim, the user name is also placed in
27598 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27599 it can lead to confusion in string expansions that also use numeric variables
27600 for other things. For example:
27601 .code
27602 spa:
27603   driver = spa
27604   public_name = NTLM
27605   server_password = \
27606     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27607 .endd
27608 If the expansion is forced to fail, authentication fails. Any other expansion
27609 failure causes a temporary error code to be returned.
27610
27611
27612
27613
27614
27615 .section "Using spa as a client" "SECID180"
27616 .cindex "options" "&(spa)& authenticator (client)"
27617 The &(spa)& authenticator has the following client options:
27618
27619
27620
27621 .option client_domain spa string&!! unset
27622 This option specifies an optional domain for the authentication.
27623
27624
27625 .option client_password spa string&!! unset
27626 This option specifies the user's password, and must be set.
27627
27628
27629 .option client_username spa string&!! unset
27630 This option specifies the user name, and must be set. Here is an example of a
27631 configuration of this authenticator for use with the mail servers at
27632 &'msn.com'&:
27633 .code
27634 msn:
27635   driver = spa
27636   public_name = MSN
27637   client_username = msn/msn_username
27638   client_password = msn_plaintext_password
27639   client_domain = DOMAIN_OR_UNSET
27640 .endd
27641 .ecindex IIDspaauth1
27642 .ecindex IIDspaauth2
27643
27644
27645
27646
27647
27648 . ////////////////////////////////////////////////////////////////////////////
27649 . ////////////////////////////////////////////////////////////////////////////
27650
27651 .chapter "The external authenticator" "CHAPexternauth"
27652 .scindex IIDexternauth1 "&(external)& authenticator"
27653 .scindex IIDexternauth2 "authenticators" "&(external)&"
27654 .cindex "authentication" "Client Certificate"
27655 .cindex "authentication" "X509"
27656 .cindex "Certificate-based authentication"
27657 The &(external)& authenticator provides support for
27658 authentication based on non-SMTP information.
27659 The specification is in RFC 4422 Appendix A
27660 (&url(https://tools.ietf.org/html/rfc4422)).
27661 It is only a transport and negotiation mechanism;
27662 the process of authentication is entirely controlled
27663 by the server configuration.
27664
27665 The client presents an identity in-clear.
27666 It is probably wise for a server to only advertise,
27667 and for clients to only attempt,
27668 this authentication method on a secure (eg. under TLS) connection.
27669
27670 One possible use, compatible with the
27671 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27672 is for using X509 client certificates.
27673
27674 It thus overlaps in function with the TLS authenticator
27675 (see &<<CHAPtlsauth>>&)
27676 but is a full SMTP SASL authenticator
27677 rather than being implicit for TLS-connection carried
27678 client certificates only.
27679
27680 The examples and discussion in this chapter assume that
27681 client-certificate authentication is being done.
27682
27683 The client must present a certificate,
27684 for which it must have been requested via the
27685 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27686 (see &<<CHAPTLS>>&).
27687 For authentication to be effective the certificate should be
27688 verifiable against a trust-anchor certificate known to the server.
27689
27690 .section "External options" "SECTexternsoptions"
27691 .cindex "options" "&(external)& authenticator (server)"
27692 The &(external)& authenticator has two server options:
27693
27694 .option server_param2 external string&!! unset
27695 .option server_param3 external string&!! unset
27696 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27697 These options are expanded before the &%server_condition%& option
27698 and the result are placed in &$auth2$& and &$auth3$& resectively.
27699 If the expansion is forced to fail, authentication fails. Any other expansion
27700 failure causes a temporary error code to be returned.
27701
27702 They can be used to clarify the coding of a complex &%server_condition%&.
27703
27704 .section "Using external in a server" "SECTexternserver"
27705 .cindex "AUTH" "in &(external)& authenticator"
27706 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27707         "in &(external)& authenticator"
27708 .vindex "&$auth1$&, &$auth2$&, etc"
27709 .cindex "base64 encoding" "in &(external)& authenticator"
27710
27711 When running as a server, &(external)& performs the authentication test by
27712 expanding a string. The data sent by the client with the AUTH command, or in
27713 response to subsequent prompts, is base64 encoded, and so may contain any byte
27714 values when decoded. The decoded value is treated as
27715 an identity for authentication and
27716 placed in the expansion variable &$auth1$&.
27717
27718 For compatibility with previous releases of Exim, the value is also placed in
27719 the expansion variable &$1$&. However, the use of this
27720 variable for this purpose is now deprecated, as it can lead to confusion in
27721 string expansions that also use them for other things.
27722
27723 .vindex "&$authenticated_id$&"
27724 Once an identity has been received,
27725 &%server_condition%& is expanded. If the expansion is forced to fail,
27726 authentication fails. Any other expansion failure causes a temporary error code
27727 to be returned. If the result of a successful expansion is an empty string,
27728 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27729 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27730 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27731 For any other result, a temporary error code is returned, with the expanded
27732 string as the error text.
27733
27734 Example:
27735 .code
27736 ext_ccert_san_mail:
27737   driver =            external
27738   public_name =       EXTERNAL
27739
27740   server_advertise_condition = $tls_in_certificate_verified
27741   server_param2 =     ${certextract {subj_altname,mail,>:} \
27742                                     {$tls_in_peercert}}
27743   server_condition =  ${if forany {$auth2} \
27744                             {eq {$item}{$auth1}}}
27745   server_set_id =     $auth1
27746 .endd
27747 This accepts a client certificate that is verifiable against any
27748 of your configured trust-anchors
27749 (which usually means the full set of public CAs)
27750 and which has a mail-SAN matching the claimed identity sent by the client.
27751
27752 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27753 The account name is therefore guessable by an opponent.
27754 TLS 1.3 protects both server and client certificates, and is not vulnerable
27755 in this way.
27756 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27757
27758
27759 .section "Using external in a client" "SECTexternclient"
27760 .cindex "options" "&(external)& authenticator (client)"
27761 The &(external)& authenticator has one client option:
27762
27763 .option client_send external string&!! unset
27764 This option is expanded and sent with the AUTH command as the
27765 identity being asserted.
27766
27767 Example:
27768 .code
27769 ext_ccert:
27770   driver =      external
27771   public_name = EXTERNAL
27772
27773   client_condition = ${if !eq{$tls_out_cipher}{}}
27774   client_send = myaccount@smarthost.example.net
27775 .endd
27776
27777
27778 .ecindex IIDexternauth1
27779 .ecindex IIDexternauth2
27780
27781
27782
27783
27784
27785 . ////////////////////////////////////////////////////////////////////////////
27786 . ////////////////////////////////////////////////////////////////////////////
27787
27788 .chapter "The tls authenticator" "CHAPtlsauth"
27789 .scindex IIDtlsauth1 "&(tls)& authenticator"
27790 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27791 .cindex "authentication" "Client Certificate"
27792 .cindex "authentication" "X509"
27793 .cindex "Certificate-based authentication"
27794 The &(tls)& authenticator provides server support for
27795 authentication based on client certificates.
27796
27797 It is not an SMTP authentication mechanism and is not
27798 advertised by the server as part of the SMTP EHLO response.
27799 It is an Exim authenticator in the sense that it affects
27800 the protocol element of the log line, can be tested for
27801 by the &%authenticated%& ACL condition, and can set
27802 the &$authenticated_id$& variable.
27803
27804 The client must present a verifiable certificate,
27805 for which it must have been requested via the
27806 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27807 (see &<<CHAPTLS>>&).
27808
27809 If an authenticator of this type is configured it is
27810 run before any SMTP-level communication is done,
27811 and can authenticate the connection.
27812 If it does, SMTP authentication is not offered.
27813
27814 A maximum of one authenticator of this type may be present.
27815
27816
27817 .cindex "options" "&(tls)& authenticator (server)"
27818 The &(tls)& authenticator has three server options:
27819
27820 .option server_param1 tls string&!! unset
27821 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27822 This option is expanded after the TLS negotiation and
27823 the result is placed in &$auth1$&.
27824 If the expansion is forced to fail, authentication fails. Any other expansion
27825 failure causes a temporary error code to be returned.
27826
27827 .option server_param2 tls string&!! unset
27828 .option server_param3 tls string&!! unset
27829 As above, for &$auth2$& and &$auth3$&.
27830
27831 &%server_param1%& may also be spelled &%server_param%&.
27832
27833
27834 Example:
27835 .code
27836 tls:
27837   driver = tls
27838   server_param1 =     ${certextract {subj_altname,mail,>:} \
27839                                     {$tls_in_peercert}}
27840   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27841                                  {forany {$auth1} \
27842                             {!= {0} \
27843                                 {${lookup ldap{ldap:///\
27844                          mailname=${quote_ldap_dn:${lc:$item}},\
27845                          ou=users,LDAP_DC?mailid} {$value}{0} \
27846                        }    }  } }}}
27847   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27848 .endd
27849 This accepts a client certificate that is verifiable against any
27850 of your configured trust-anchors
27851 (which usually means the full set of public CAs)
27852 and which has a SAN with a good account name.
27853
27854 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27855 The account name is therefore guessable by an opponent.
27856 TLS 1.3 protects both server and client certificates, and is not vulnerable
27857 in this way.
27858 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27859
27860 . An alternative might use
27861 . .code
27862 .   server_param1 = ${sha256:$tls_in_peercert}
27863 . .endd
27864 . to require one of a set of specific certs that define a given account
27865 . (the verification is still required, but mostly irrelevant).
27866 . This would help for per-device use.
27867 .
27868 . However, for the future we really need support for checking a
27869 . user cert in LDAP - which probably wants a base-64 DER.
27870
27871 .ecindex IIDtlsauth1
27872 .ecindex IIDtlsauth2
27873
27874
27875 Note that because authentication is traditionally an SMTP operation,
27876 the &%authenticated%& ACL condition cannot be used in
27877 a connect- or helo-ACL.
27878
27879
27880
27881 . ////////////////////////////////////////////////////////////////////////////
27882 . ////////////////////////////////////////////////////////////////////////////
27883
27884 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27885          "Encrypted SMTP connections"
27886 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27887 .scindex IIDencsmtp2 "SMTP" "encryption"
27888 .cindex "TLS" "on SMTP connection"
27889 .cindex "OpenSSL"
27890 .cindex "GnuTLS"
27891 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27892 Sockets Layer), is implemented by making use of the OpenSSL library or the
27893 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27894 cryptographic code in the Exim distribution itself for implementing TLS. In
27895 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27896 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27897 You also need to understand the basic concepts of encryption at a managerial
27898 level, and in particular, the way that public keys, private keys, and
27899 certificates are used.
27900
27901 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27902 connection is established, the client issues a STARTTLS command. If the
27903 server accepts this, the client and the server negotiate an encryption
27904 mechanism. If the negotiation succeeds, the data that subsequently passes
27905 between them is encrypted.
27906
27907 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27908 and if so, what cipher suite is in use, whether the client supplied a
27909 certificate, and whether or not that certificate was verified. This makes it
27910 possible for an Exim server to deny or accept certain commands based on the
27911 encryption state.
27912
27913 &*Warning*&: Certain types of firewall and certain anti-virus products can
27914 disrupt TLS connections. You need to turn off SMTP scanning for these products
27915 in order to get TLS to work.
27916
27917
27918
27919 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27920          "SECID284"
27921 .cindex "submissions protocol"
27922 .cindex "ssmtp protocol"
27923 .cindex "smtps protocol"
27924 .cindex "SMTP" "submissions protocol"
27925 .cindex "SMTP" "ssmtp protocol"
27926 .cindex "SMTP" "smtps protocol"
27927 The history of port numbers for TLS in SMTP is a little messy and has been
27928 contentious.  As of RFC 8314, the common practice of using the historically
27929 allocated port 465 for "email submission but with TLS immediately upon connect
27930 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27931 by them in preference to STARTTLS.
27932
27933 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27934 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27935 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27936
27937 This approach was, for a while, officially abandoned when encrypted SMTP was
27938 standardized, but many clients kept using it, even as the TCP port number was
27939 reassigned for other use.
27940 Thus you may encounter guidance claiming that you shouldn't enable use of
27941 this port.
27942 In practice, a number of mail-clients have only ever supported submissions,
27943 not submission with STARTTLS upgrade.
27944 Ideally, offer both submission (587) and submissions (465) service.
27945
27946 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27947 global option. Its value must be a list of port numbers;
27948 the most common use is expected to be:
27949 .code
27950 tls_on_connect_ports = 465
27951 .endd
27952 The port numbers specified by this option apply to all SMTP connections, both
27953 via the daemon and via &'inetd'&. You still need to specify all the ports that
27954 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27955 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27956 an extra port &-- rather, it specifies different behaviour on a port that is
27957 defined elsewhere.
27958
27959 There is also a &%-tls-on-connect%& command line option. This overrides
27960 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27961
27962
27963
27964
27965
27966
27967 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27968 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27969 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27970 followed later, when the first versions of GnuTLS were released. To build Exim
27971 to use GnuTLS, you need to set
27972 .code
27973 USE_GNUTLS=yes
27974 .endd
27975 in Local/Makefile, in addition to
27976 .code
27977 SUPPORT_TLS=yes
27978 .endd
27979 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27980 include files and libraries for GnuTLS can be found.
27981
27982 There are some differences in usage when using GnuTLS instead of OpenSSL:
27983
27984 .ilist
27985 The &%tls_verify_certificates%& option
27986 cannot be the path of a directory
27987 for GnuTLS versions before 3.3.6
27988 (for later versions, or OpenSSL, it can be either).
27989 .next
27990 The default value for &%tls_dhparam%& differs for historical reasons.
27991 .next
27992 .vindex "&$tls_in_peerdn$&"
27993 .vindex "&$tls_out_peerdn$&"
27994 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27995 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27996 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27997 .next
27998 OpenSSL identifies cipher suites using hyphens as separators, for example:
27999 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28000 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28001 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28002 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28003 to handle its own older variants) when processing lists of cipher suites in the
28004 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28005 option).
28006 .next
28007 The &%tls_require_ciphers%& options operate differently, as described in the
28008 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28009 .next
28010 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28011 When using OpenSSL, this option is ignored.
28012 (If an API is found to let OpenSSL be configured in this way,
28013 let the Exim Maintainers know and we'll likely use it).
28014 .next
28015 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28016 main option, it must be ordered to match the &%tls_certificate%& list.
28017 .next
28018 Some other recently added features may only be available in one or the other.
28019 This should be documented with the feature.  If the documentation does not
28020 explicitly state that the feature is infeasible in the other TLS
28021 implementation, then patches are welcome.
28022 .endlist
28023
28024
28025 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28026 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28027 an explicit path; if the latter, then the text about generation still applies,
28028 but not the chosen filename.
28029 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28030 See the documentation of &%tls_dhparam%& for more information.
28031
28032 GnuTLS uses D-H parameters that may take a substantial amount of time
28033 to compute. It is unreasonable to re-compute them for every TLS session.
28034 Therefore, Exim keeps this data in a file in its spool directory, called
28035 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28036 of bits requested.
28037 The file is owned by the Exim user and is readable only by
28038 its owner. Every Exim process that start up GnuTLS reads the D-H
28039 parameters from this file. If the file does not exist, the first Exim process
28040 that needs it computes the data and writes it to a temporary file which is
28041 renamed once it is complete. It does not matter if several Exim processes do
28042 this simultaneously (apart from wasting a few resources). Once a file is in
28043 place, new Exim processes immediately start using it.
28044
28045 For maximum security, the parameters that are stored in this file should be
28046 recalculated periodically, the frequency depending on your paranoia level.
28047 If you are avoiding using the fixed D-H primes published in RFCs, then you
28048 are concerned about some advanced attacks and will wish to do this; if you do
28049 not regenerate then you might as well stick to the standard primes.
28050
28051 Arranging this is easy in principle; just delete the file when you want new
28052 values to be computed. However, there may be a problem. The calculation of new
28053 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28054 If the system is not very active, &_/dev/random_& may delay returning data
28055 until enough randomness (entropy) is available. This may cause Exim to hang for
28056 a substantial amount of time, causing timeouts on incoming connections.
28057
28058 The solution is to generate the parameters externally to Exim. They are stored
28059 in &_gnutls-params-N_& in PEM format, which means that they can be
28060 generated externally using the &(certtool)& command that is part of GnuTLS.
28061
28062 To replace the parameters with new ones, instead of deleting the file
28063 and letting Exim re-create it, you can generate new parameters using
28064 &(certtool)& and, when this has been done, replace Exim's cache file by
28065 renaming. The relevant commands are something like this:
28066 .code
28067 # ls
28068 [ look for file; assume gnutls-params-2236 is the most recent ]
28069 # rm -f new-params
28070 # touch new-params
28071 # chown exim:exim new-params
28072 # chmod 0600 new-params
28073 # certtool --generate-dh-params --bits 2236 >>new-params
28074 # openssl dhparam -noout -text -in new-params | head
28075 [ check the first line, make sure it's not more than 2236;
28076   if it is, then go back to the start ("rm") and repeat
28077   until the size generated is at most the size requested ]
28078 # chmod 0400 new-params
28079 # mv new-params gnutls-params-2236
28080 .endd
28081 If Exim never has to generate the parameters itself, the possibility of
28082 stalling is removed.
28083
28084 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28085 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28086 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28087 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28088 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28089 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28090 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28091 which applies to all D-H usage, client or server.  If the value returned by
28092 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28093 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28094 limit, which is still much higher than Exim historically used.
28095
28096 The filename and bits used will change as the GnuTLS maintainers change the
28097 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28098 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28099 2432 bits, while NSS is limited to 2236 bits.
28100
28101 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28102 increase the chance of the generated prime actually being within acceptable
28103 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28104 procedure above.  There is no sane procedure available to Exim to double-check
28105 the size of the generated prime, so it might still be too large.
28106
28107
28108 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28109 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28110 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28111 There is a function in the OpenSSL library that can be passed a list of cipher
28112 suites before the cipher negotiation takes place. This specifies which ciphers
28113 are acceptable for TLS versions prior to 1.3.
28114 The list is colon separated and may contain names like
28115 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28116 directly to this function call.
28117 Many systems will install the OpenSSL manual-pages, so you may have
28118 &'ciphers(1)'& available to you.
28119 The following quotation from the OpenSSL
28120 documentation specifies what forms of item are allowed in the cipher string:
28121
28122 .ilist
28123 It can consist of a single cipher suite such as RC4-SHA.
28124 .next
28125 It can represent a list of cipher suites containing a certain algorithm,
28126 or cipher suites of a certain type. For example SHA1 represents all
28127 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28128 SSL v3 algorithms.
28129 .next
28130 Lists of cipher suites can be combined in a single cipher string using
28131 the + character. This is used as a logical and operation. For example
28132 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28133 algorithms.
28134 .endlist
28135
28136 Each cipher string can be optionally preceded by one of the characters &`!`&,
28137 &`-`& or &`+`&.
28138 .ilist
28139 If &`!`& is used, the ciphers are permanently deleted from the list. The
28140 ciphers deleted can never reappear in the list even if they are explicitly
28141 stated.
28142 .next
28143 If &`-`& is used, the ciphers are deleted from the list, but some or all
28144 of the ciphers can be added again by later options.
28145 .next
28146 If &`+`& is used, the ciphers are moved to the end of the list. This
28147 option does not add any new ciphers; it just moves matching existing ones.
28148 .endlist
28149
28150 If none of these characters is present, the string is interpreted as
28151 a list of ciphers to be appended to the current preference list. If the list
28152 includes any ciphers already present they will be ignored: that is, they will
28153 not be moved to the end of the list.
28154 .endlist
28155
28156 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28157 string:
28158 .code
28159 # note single-quotes to get ! past any shell history expansion
28160 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28161 .endd
28162
28163 This example will let the library defaults be permitted on the MX port, where
28164 there's probably no identity verification anyway, but ups the ante on the
28165 submission ports where the administrator might have some influence on the
28166 choice of clients used:
28167 .code
28168 # OpenSSL variant; see man ciphers(1)
28169 tls_require_ciphers = ${if =={$received_port}{25}\
28170                            {DEFAULT}\
28171                            {HIGH:!MD5:!SHA1}}
28172 .endd
28173
28174 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28175 .code
28176 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28177 .endd
28178
28179 For TLS version 1.3 the control available is less fine-grained
28180 and Exim does not provide access to it at present.
28181 The value of the &%tls_require_ciphers%& option is ignored when
28182 TLS version 1.3 is negotiated.
28183
28184 As of writing the library default cipher suite list for TLSv1.3 is
28185 .code
28186 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28187 .endd
28188
28189
28190 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28191          "SECTreqciphgnu"
28192 .cindex "GnuTLS" "specifying parameters for"
28193 .cindex "TLS" "specifying ciphers (GnuTLS)"
28194 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28195 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28196 .cindex "TLS" "specifying protocols (GnuTLS)"
28197 .cindex "TLS" "specifying priority string (GnuTLS)"
28198 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28199 The GnuTLS library allows the caller to provide a "priority string", documented
28200 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28201 ciphersuite specification in OpenSSL.
28202
28203 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28204 and controls both protocols and ciphers.
28205
28206 The &%tls_require_ciphers%& option is available both as an global option,
28207 controlling how Exim behaves as a server, and also as an option of the
28208 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28209 the value is string expanded.  The resulting string is not an Exim list and
28210 the string is given to the GnuTLS library, so that Exim does not need to be
28211 aware of future feature enhancements of GnuTLS.
28212
28213 Documentation of the strings accepted may be found in the GnuTLS manual, under
28214 "Priority strings".  This is online as
28215 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28216 but beware that this relates to GnuTLS 3, which may be newer than the version
28217 installed on your system.  If you are using GnuTLS 3,
28218 then the example code
28219 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28220 on that site can be used to test a given string.
28221
28222 For example:
28223 .code
28224 # Disable older versions of protocols
28225 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28226 .endd
28227
28228 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28229 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28230 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28231
28232 This example will let the library defaults be permitted on the MX port, where
28233 there's probably no identity verification anyway, and lowers security further
28234 by increasing compatibility; but this ups the ante on the submission ports
28235 where the administrator might have some influence on the choice of clients
28236 used:
28237 .code
28238 # GnuTLS variant
28239 tls_require_ciphers = ${if =={$received_port}{25}\
28240                            {NORMAL:%COMPAT}\
28241                            {SECURE128}}
28242 .endd
28243
28244
28245 .section "Configuring an Exim server to use TLS" "SECID182"
28246 .cindex "TLS" "configuring an Exim server"
28247 When Exim has been built with TLS support, it advertises the availability of
28248 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28249 but not to any others. The default value of this option is *, which means
28250 that STARTTLS is always advertised.  Set it to blank to never advertise;
28251 this is reasonable for systems that want to use TLS only as a client.
28252
28253 If STARTTLS is to be used you
28254 need to set some other options in order to make TLS available.
28255
28256 If a client issues a STARTTLS command and there is some configuration
28257 problem in the server, the command is rejected with a 454 error. If the client
28258 persists in trying to issue SMTP commands, all except QUIT are rejected
28259 with the error
28260 .code
28261 554 Security failure
28262 .endd
28263 If a STARTTLS command is issued within an existing TLS session, it is
28264 rejected with a 554 error code.
28265
28266 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28267 must be set to match some hosts. The default is * which matches all hosts.
28268
28269 If this is all you do, TLS encryption will be enabled but not authentication -
28270 meaning that the peer has no assurance it is actually you he is talking to.
28271 You gain protection from a passive sniffer listening on the wire but not
28272 from someone able to intercept the communication.
28273
28274 Further protection requires some further configuration at the server end.
28275
28276 To make TLS work you need to set, in the server,
28277 .code
28278 tls_certificate = /some/file/name
28279 tls_privatekey = /some/file/name
28280 .endd
28281 These options are, in fact, expanded strings, so you can make them depend on
28282 the identity of the client that is connected if you wish. The first file
28283 contains the server's X509 certificate, and the second contains the private key
28284 that goes with it. These files need to be
28285 PEM format and readable by the Exim user, and must
28286 always be given as full path names.
28287 The key must not be password-protected.
28288 They can be the same file if both the
28289 certificate and the key are contained within it. If &%tls_privatekey%& is not
28290 set, or if its expansion is forced to fail or results in an empty string, this
28291 is assumed to be the case. The certificate file may also contain intermediate
28292 certificates that need to be sent to the client to enable it to authenticate
28293 the server's certificate.
28294
28295 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28296 colon-separated lists of file paths.  Ciphers using given authentication
28297 algorithms require the presence of a suitable certificate to supply the
28298 public-key.  The server selects among the certificates to present to the
28299 client depending on the selected cipher, hence the priority ordering for
28300 ciphers will affect which certificate is used.
28301
28302 If you do not understand about certificates and keys, please try to find a
28303 source of this background information, which is not Exim-specific. (There are a
28304 few comments below in section &<<SECTcerandall>>&.)
28305
28306 &*Note*&: These options do not apply when Exim is operating as a client &--
28307 they apply only in the case of a server. If you need to use a certificate in an
28308 Exim client, you must set the options of the same names in an &(smtp)&
28309 transport.
28310
28311 With just these options, an Exim server will be able to use TLS. It does not
28312 require the client to have a certificate (but see below for how to insist on
28313 this). There is one other option that may be needed in other situations. If
28314 .code
28315 tls_dhparam = /some/file/name
28316 .endd
28317 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28318 with the parameters contained in the file.
28319 Set this to &`none`& to disable use of DH entirely, by making no prime
28320 available:
28321 .code
28322 tls_dhparam = none
28323 .endd
28324 This may also be set to a string identifying a standard prime to be used for
28325 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28326 used is &`ike23`&.  There are a few standard primes available, see the
28327 documentation for &%tls_dhparam%& for the complete list.
28328
28329 See the command
28330 .code
28331 openssl dhparam
28332 .endd
28333 for a way of generating file data.
28334
28335 The strings supplied for these three options are expanded every time a client
28336 host connects. It is therefore possible to use different certificates and keys
28337 for different hosts, if you so wish, by making use of the client's IP address
28338 in &$sender_host_address$& to control the expansion. If a string expansion is
28339 forced to fail, Exim behaves as if the option is not set.
28340
28341 .cindex "cipher" "logging"
28342 .cindex "log" "TLS cipher"
28343 .vindex "&$tls_in_cipher$&"
28344 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28345 an incoming TLS connection. It is included in the &'Received:'& header of an
28346 incoming message (by default &-- you can, of course, change this), and it is
28347 also included in the log line that records a message's arrival, keyed by
28348 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28349 condition can be used to test for specific cipher suites in ACLs.
28350
28351 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28352 can check the name of the cipher suite and vary their actions accordingly. The
28353 cipher suite names vary, depending on which TLS library is being used. For
28354 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28355 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28356 documentation for more details.
28357
28358 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28359 (again depending on the &%tls_cipher%& log selector).
28360
28361
28362 .section "Requesting and verifying client certificates" "SECID183"
28363 .cindex "certificate" "verification of client"
28364 .cindex "TLS" "client certificate verification"
28365 If you want an Exim server to request a certificate when negotiating a TLS
28366 session with a client, you must set either &%tls_verify_hosts%& or
28367 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28368 apply to all TLS connections. For any host that matches one of these options,
28369 Exim requests a certificate as part of the setup of the TLS session. The
28370 contents of the certificate are verified by comparing it with a list of
28371 expected trust-anchors or certificates.
28372 These may be the system default set (depending on library version),
28373 an explicit file or,
28374 depending on library version, a directory, identified by
28375 &%tls_verify_certificates%&.
28376
28377 A file can contain multiple certificates, concatenated end to end. If a
28378 directory is used
28379 (OpenSSL only),
28380 each certificate must be in a separate file, with a name (or a symbolic link)
28381 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28382 certificate. You can compute the relevant hash by running the command
28383 .code
28384 openssl x509 -hash -noout -in /cert/file
28385 .endd
28386 where &_/cert/file_& contains a single certificate.
28387
28388 There is no checking of names of the client against the certificate
28389 Subject Name or Subject Alternate Names.
28390
28391 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28392 what happens if the client does not supply a certificate, or if the certificate
28393 does not match any of the certificates in the collection named by
28394 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28395 attempt to set up a TLS session is aborted, and the incoming connection is
28396 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28397 session continues. ACLs that run for subsequent SMTP commands can detect the
28398 fact that no certificate was verified, and vary their actions accordingly. For
28399 example, you can insist on a certificate before accepting a message for
28400 relaying, but not when the message is destined for local delivery.
28401
28402 .vindex "&$tls_in_peerdn$&"
28403 When a client supplies a certificate (whether it verifies or not), the value of
28404 the Distinguished Name of the certificate is made available in the variable
28405 &$tls_in_peerdn$& during subsequent processing of the message.
28406
28407 .cindex "log" "distinguished name"
28408 Because it is often a long text string, it is not included in the log line or
28409 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28410 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28411 &%received_header_text%& to change the &'Received:'& header. When no
28412 certificate is supplied, &$tls_in_peerdn$& is empty.
28413
28414
28415 .section "Revoked certificates" "SECID184"
28416 .cindex "TLS" "revoked certificates"
28417 .cindex "revocation list"
28418 .cindex "certificate" "revocation list"
28419 .cindex "OCSP" "stapling"
28420 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28421 certificates are revoked. If you have such a list, you can pass it to an Exim
28422 server using the global option called &%tls_crl%& and to an Exim client using
28423 an identically named option for the &(smtp)& transport. In each case, the value
28424 of the option is expanded and must then be the name of a file that contains a
28425 CRL in PEM format.
28426 The downside is that clients have to periodically re-download a potentially huge
28427 file from every certificate authority they know of.
28428
28429 The way with most moving parts at query time is Online Certificate
28430 Status Protocol (OCSP), where the client verifies the certificate
28431 against an OCSP server run by the CA.  This lets the CA track all
28432 usage of the certs.  It requires running software with access to the
28433 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28434 is based on HTTP and can be proxied accordingly.
28435
28436 The only widespread OCSP server implementation (known to this writer)
28437 comes as part of OpenSSL and aborts on an invalid request, such as
28438 connecting to the port and then disconnecting.  This requires
28439 re-entering the passphrase each time some random client does this.
28440
28441 The third way is OCSP Stapling; in this, the server using a certificate
28442 issued by the CA periodically requests an OCSP proof of validity from
28443 the OCSP server, then serves it up inline as part of the TLS
28444 negotiation.   This approach adds no extra round trips, does not let the
28445 CA track users, scales well with number of certs issued by the CA and is
28446 resilient to temporary OCSP server failures, as long as the server
28447 starts retrying to fetch an OCSP proof some time before its current
28448 proof expires.  The downside is that it requires server support.
28449
28450 Unless Exim is built with the support disabled,
28451 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28452 support for OCSP stapling is included.
28453
28454 There is a global option called &%tls_ocsp_file%&.
28455 The file specified therein is expected to be in DER format, and contain
28456 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28457 option will be re-expanded for SNI, if the &%tls_certificate%& option
28458 contains &`tls_in_sni`&, as per other TLS options.
28459
28460 Exim does not at this time implement any support for fetching a new OCSP
28461 proof.  The burden is on the administrator to handle this, outside of
28462 Exim.  The file specified should be replaced atomically, so that the
28463 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28464 on each connection, so a new file will be handled transparently on the
28465 next connection.
28466
28467 When built with OpenSSL Exim will check for a valid next update timestamp
28468 in the OCSP proof; if not present, or if the proof has expired, it will be
28469 ignored.
28470
28471 For the client to be able to verify the stapled OCSP the server must
28472 also supply, in its stapled information, any intermediate
28473 certificates for the chain leading to the OCSP proof from the signer
28474 of the server certificate.  There may be zero or one such. These
28475 intermediate certificates should be added to the server OCSP stapling
28476 file named by &%tls_ocsp_file%&.
28477
28478 Note that the proof only covers the terminal server certificate,
28479 not any of the chain from CA to it.
28480
28481 There is no current way to staple a proof for a client certificate.
28482
28483 .code
28484   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28485   OCSP server is supplied.  The server URL may be included in the
28486   server certificate, if the CA is helpful.
28487
28488   One failure mode seen was the OCSP Signer cert expiring before the end
28489   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28490   noted this as invalid overall, but the re-fetch script did not.
28491 .endd
28492
28493
28494
28495
28496 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28497 .cindex "cipher" "logging"
28498 .cindex "log" "TLS cipher"
28499 .cindex "log" "distinguished name"
28500 .cindex "TLS" "configuring an Exim client"
28501 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28502 deliveries as well as to incoming, the latter one causing logging of the
28503 server certificate's DN. The remaining client configuration for TLS is all
28504 within the &(smtp)& transport.
28505
28506 It is not necessary to set any options to have TLS work in the &(smtp)&
28507 transport. If Exim is built with TLS support, and TLS is advertised by a
28508 server, the &(smtp)& transport always tries to start a TLS session. However,
28509 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28510 transport) to a list of server hosts for which TLS should not be used.
28511
28512 If you do not want Exim to attempt to send messages unencrypted when an attempt
28513 to set up an encrypted connection fails in any way, you can set
28514 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28515 those hosts, delivery is always deferred if an encrypted connection cannot be
28516 set up. If there are any other hosts for the address, they are tried in the
28517 usual way.
28518
28519 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28520 the message unencrypted. It always does this if the response to STARTTLS is
28521 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28522 session after a success response code, what happens is controlled by the
28523 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28524 delivery to this host is deferred, and other hosts (if available) are tried. If
28525 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28526 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28527 negotiation fails, Exim closes the current connection (because it is in an
28528 unknown state), opens a new one to the same host, and then tries the delivery
28529 unencrypted.
28530
28531 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28532 transport provide the client with a certificate, which is passed to the server
28533 if it requests it. If the server is Exim, it will request a certificate only if
28534 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28535
28536 .new
28537 Do not use a certificate which has the OCSP-must-staple extension,
28538 for client use (they are usable for server use).
28539 As TLS has no means for the client to staple before TLS 1.3 it will result
28540 in failed connections.
28541 .wen
28542
28543 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28544 specifies a collection of expected server certificates.
28545 These may be
28546 the system default set (depending on library version),
28547 a file,
28548 or (depending on library version) a directory.
28549 The client verifies the server's certificate
28550 against this collection, taking into account any revoked certificates that are
28551 in the list defined by &%tls_crl%&.
28552 Failure to verify fails the TLS connection unless either of the
28553 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28554
28555 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28556 certificate verification to the listed servers.  Verification either must
28557 or need not succeed respectively.
28558
28559 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28560 checks are made: that the host name (the one in the DNS A record)
28561 is valid for the certificate.
28562 The option defaults to always checking.
28563
28564 The &(smtp)& transport has two OCSP-related options:
28565 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28566 is requested and required for the connection to proceed.  The default
28567 value is empty.
28568 &%hosts_request_ocsp%&; a host-list for which (additionally)
28569 a Certificate Status is requested (but not necessarily verified).  The default
28570 value is "*" meaning that requests are made unless configured
28571 otherwise.
28572
28573 The host(s) should also be in &%hosts_require_tls%&, and
28574 &%tls_verify_certificates%& configured for the transport,
28575 for OCSP to be relevant.
28576
28577 If
28578 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28579 list of permitted cipher suites. If either of these checks fails, delivery to
28580 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28581 alternative hosts, if any.
28582
28583  &*Note*&:
28584 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28585 is operating as a client. Exim does not assume that a server certificate (set
28586 by the global options of the same name) should also be used when operating as a
28587 client.
28588
28589 .vindex "&$host$&"
28590 .vindex "&$host_address$&"
28591 All the TLS options in the &(smtp)& transport are expanded before use, with
28592 &$host$& and &$host_address$& containing the name and address of the server to
28593 which the client is connected. Forced failure of an expansion causes Exim to
28594 behave as if the relevant option were unset.
28595
28596 .vindex &$tls_out_bits$&
28597 .vindex &$tls_out_cipher$&
28598 .vindex &$tls_out_peerdn$&
28599 .vindex &$tls_out_sni$&
28600 Before an SMTP connection is established, the
28601 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28602 variables are emptied. (Until the first connection, they contain the values
28603 that were set when the message was received.) If STARTTLS is subsequently
28604 successfully obeyed, these variables are set to the relevant values for the
28605 outgoing connection.
28606
28607
28608
28609 .section "Use of TLS Server Name Indication" "SECTtlssni"
28610 .cindex "TLS" "Server Name Indication"
28611 .vindex "&$tls_in_sni$&"
28612 .oindex "&%tls_in_sni%&"
28613 With TLS1.0 or above, there is an extension mechanism by which extra
28614 information can be included at various points in the protocol.  One of these
28615 extensions, documented in RFC 6066 (and before that RFC 4366) is
28616 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28617 client in the initial handshake, so that the server can examine the servername
28618 within and possibly choose to use different certificates and keys (and more)
28619 for this session.
28620
28621 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28622 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28623 address.
28624
28625 With SMTP to MX, there are the same problems here as in choosing the identity
28626 against which to validate a certificate: you can't rely on insecure DNS to
28627 provide the identity which you then cryptographically verify.  So this will
28628 be of limited use in that environment.
28629
28630 With SMTP to Submission, there is a well-defined hostname which clients are
28631 connecting to and can validate certificates against.  Thus clients &*can*&
28632 choose to include this information in the TLS negotiation.  If this becomes
28633 wide-spread, then hosters can choose to present different certificates to
28634 different clients.  Or even negotiate different cipher suites.
28635
28636 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28637 if not empty, will be sent on a TLS session as part of the handshake.  There's
28638 nothing more to it.  Choosing a sensible value not derived insecurely is the
28639 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28640 for the lifetime of the client connection (including during authentication).
28641
28642 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28643 received from a client.
28644 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28645
28646 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28647 option (prior to expansion) then the following options will be re-expanded
28648 during TLS session handshake, to permit alternative values to be chosen:
28649
28650 .ilist
28651 &%tls_certificate%&
28652 .next
28653 &%tls_crl%&
28654 .next
28655 &%tls_privatekey%&
28656 .next
28657 &%tls_verify_certificates%&
28658 .next
28659 &%tls_ocsp_file%&
28660 .endlist
28661
28662 Great care should be taken to deal with matters of case, various injection
28663 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28664 can always be referenced; it is important to remember that &$tls_in_sni$& is
28665 arbitrary unverified data provided prior to authentication.
28666 Further, the initial certificate is loaded before SNI has arrived, so
28667 an expansion for &%tls_certificate%& must have a default which is used
28668 when &$tls_in_sni$& is empty.
28669
28670 The Exim developers are proceeding cautiously and so far no other TLS options
28671 are re-expanded.
28672
28673 When Exim is built against OpenSSL, OpenSSL must have been built with support
28674 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28675 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28676 see &`-servername`& in the output, then OpenSSL has support.
28677
28678 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28679 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28680 built, then you have SNI support).
28681
28682
28683
28684 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28685          "SECTmulmessam"
28686 .cindex "multiple SMTP deliveries with TLS"
28687 .cindex "TLS" "multiple message deliveries"
28688 Exim sends multiple messages down the same TCP/IP connection by starting up
28689 an entirely new delivery process for each message, passing the socket from
28690 one process to the next. This implementation does not fit well with the use
28691 of TLS, because there is quite a lot of state information associated with a TLS
28692 connection, not just a socket identification. Passing all the state information
28693 to a new process is not feasible. Consequently, for sending using TLS Exim
28694 starts an additional proxy process for handling the encryption, piping the
28695 unencrypted data stream from and to the delivery processes.
28696
28697 An older mode of operation can be enabled on a per-host basis by the
28698 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28699 this list the proxy process described above is not used; instead Exim
28700 shuts down an existing TLS session being run by the delivery process
28701 before passing the socket to a new process. The new process may then
28702 try to start a new TLS session, and if successful, may try to re-authenticate
28703 if AUTH is in use, before sending the next message.
28704
28705 The RFC is not clear as to whether or not an SMTP session continues in clear
28706 after TLS has been shut down, or whether TLS may be restarted again later, as
28707 just described. However, if the server is Exim, this shutdown and
28708 reinitialization works. It is not known which (if any) other servers operate
28709 successfully if the client closes a TLS session and continues with unencrypted
28710 SMTP, but there are certainly some that do not work. For such servers, Exim
28711 should not pass the socket to another process, because the failure of the
28712 subsequent attempt to use it would cause Exim to record a temporary host error,
28713 and delay other deliveries to that host.
28714
28715 To test for this case, Exim sends an EHLO command to the server after
28716 closing down the TLS session. If this fails in any way, the connection is
28717 closed instead of being passed to a new delivery process, but no retry
28718 information is recorded.
28719
28720 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28721 &(smtp)& transport to match those hosts for which Exim should not pass
28722 connections to new processes if TLS has been used.
28723
28724
28725
28726
28727 .section "Certificates and all that" "SECTcerandall"
28728 .cindex "certificate" "references to discussion"
28729 In order to understand fully how TLS works, you need to know about
28730 certificates, certificate signing, and certificate authorities.
28731 This is a large topic and an introductory guide is unsuitable for the Exim
28732 reference manual, so instead we provide pointers to existing documentation.
28733
28734 The Apache web-server was for a long time the canonical guide, so their
28735 documentation is a good place to start; their SSL module's Introduction
28736 document is currently at
28737 .display
28738 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28739 .endd
28740 and their FAQ is at
28741 .display
28742 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28743 .endd
28744
28745 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28746 0-201-61598-3) in 2001, contains both introductory and more in-depth
28747 descriptions.
28748 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28749 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28750 Ivan is the author of the popular TLS testing tools at
28751 &url(https://www.ssllabs.com/).
28752
28753
28754 .section "Certificate chains" "SECID186"
28755 The file named by &%tls_certificate%& may contain more than one
28756 certificate. This is useful in the case where the certificate that is being
28757 sent is validated by an intermediate certificate which the other end does
28758 not have. Multiple certificates must be in the correct order in the file.
28759 First the host's certificate itself, then the first intermediate
28760 certificate to validate the issuer of the host certificate, then the next
28761 intermediate certificate to validate the issuer of the first intermediate
28762 certificate, and so on, until finally (optionally) the root certificate.
28763 The root certificate must already be trusted by the recipient for
28764 validation to succeed, of course, but if it's not preinstalled, sending the
28765 root certificate along with the rest makes it available for the user to
28766 install if the receiving end is a client MUA that can interact with a user.
28767
28768 Note that certificates using MD5 are unlikely to work on today's Internet;
28769 even if your libraries allow loading them for use in Exim when acting as a
28770 server, increasingly clients will not accept such certificates.  The error
28771 diagnostics in such a case can be frustratingly vague.
28772
28773
28774
28775 .section "Self-signed certificates" "SECID187"
28776 .cindex "certificate" "self-signed"
28777 You can create a self-signed certificate using the &'req'& command provided
28778 with OpenSSL, like this:
28779 . ==== Do not shorten the duration here without reading and considering
28780 . ==== the text below.  Please leave it at 9999 days.
28781 .code
28782 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28783             -days 9999 -nodes
28784 .endd
28785 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28786 delimited and so can be identified independently. The &%-days%& option
28787 specifies a period for which the certificate is valid. The &%-nodes%& option is
28788 important: if you do not set it, the key is encrypted with a passphrase
28789 that you are prompted for, and any use that is made of the key causes more
28790 prompting for the passphrase. This is not helpful if you are going to use
28791 this certificate and key in an MTA, where prompting is not possible.
28792
28793 . ==== I expect to still be working 26 years from now.  The less technical
28794 . ==== debt I create, in terms of storing up trouble for my later years, the
28795 . ==== happier I will be then.  We really have reached the point where we
28796 . ==== should start, at the very least, provoking thought and making folks
28797 . ==== pause before proceeding, instead of leaving all the fixes until two
28798 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28799 . ==== -pdp, 2012
28800 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28801 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28802 the above command might produce a date in the past.  Think carefully about
28803 the lifetime of the systems you're deploying, and either reduce the duration
28804 of the certificate or reconsider your platform deployment.  (At time of
28805 writing, reducing the duration is the most likely choice, but the inexorable
28806 progression of time takes us steadily towards an era where this will not
28807 be a sensible resolution).
28808
28809 A self-signed certificate made in this way is sufficient for testing, and
28810 may be adequate for all your requirements if you are mainly interested in
28811 encrypting transfers, and not in secure identification.
28812
28813 However, many clients require that the certificate presented by the server be a
28814 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28815 certificate. In this situation, the self-signed certificate described above
28816 must be installed on the client host as a trusted root &'certification
28817 authority'& (CA), and the certificate used by Exim must be a user certificate
28818 signed with that self-signed certificate.
28819
28820 For information on creating self-signed CA certificates and using them to sign
28821 user certificates, see the &'General implementation overview'& chapter of the
28822 Open-source PKI book, available online at
28823 &url(https://sourceforge.net/projects/ospkibook/).
28824 .ecindex IIDencsmtp1
28825 .ecindex IIDencsmtp2
28826
28827
28828
28829 .section DANE "SECDANE"
28830 .cindex DANE
28831 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28832 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28833 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28834 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28835 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28836 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28837
28838 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28839 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28840 by (a) is thought to be smaller than that of the set of root CAs.
28841
28842 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28843 fail to pass on a server's STARTTLS.
28844
28845 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28846 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28847 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28848
28849 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28850 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28851 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28852 DNSSEC.
28853 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28854 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28855
28856 There are no changes to Exim specific to server-side operation of DANE.
28857 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28858 in &_Local/Makefile_&.
28859 If it has been included, the macro "_HAVE_DANE" will be defined.
28860
28861 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28862 These are the "Trust Anchor" and "End Entity" variants.
28863 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28864 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28865 this is appropriate for a single system, using a self-signed certificate.
28866 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28867 well-known one.
28868 A private CA at simplest is just a self-signed certificate (with certain
28869 attributes) which is used to sign server certificates, but running one securely
28870 does require careful arrangement.
28871 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28872 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28873 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28874 all of which point to a single TLSA record.
28875 DANE-TA and DANE-EE can both be used together.
28876
28877 Our recommendation is to use DANE with a certificate from a public CA,
28878 because this enables a variety of strategies for remote clients to verify
28879 your certificate.
28880 You can then publish information both via DANE and another technology,
28881 "MTA-STS", described below.
28882
28883 When you use DANE-TA to publish trust anchor information, you ask entities
28884 outside your administrative control to trust the Certificate Authority for
28885 connections to you.
28886 If using a private CA then you should expect others to still apply the
28887 technical criteria they'd use for a public CA to your certificates.
28888 In particular, you should probably try to follow current best practices for CA
28889 operation around hash algorithms and key sizes.
28890 Do not expect other organizations to lower their security expectations just
28891 because a particular profile might be reasonable for your own internal use.
28892
28893 When this text was last updated, this in practice means to avoid use of SHA-1
28894 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28895 than 4096, for interoperability); to use keyUsage fields correctly; to use
28896 random serial numbers.
28897 The list of requirements is subject to change as best practices evolve.
28898 If you're not already using a private CA, or it doesn't meet these
28899 requirements, then we encourage you to avoid all these issues and use a public
28900 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28901
28902 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28903
28904 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28905 is useful for quickly generating TLSA records; and commands like
28906
28907 .code
28908   openssl x509 -in -pubkey -noout <certificate.pem \
28909   | openssl rsa -outform der -pubin 2>/dev/null \
28910   | openssl sha512 \
28911   | awk '{print $2}'
28912 .endd
28913
28914 are workable for 4th-field hashes.
28915
28916 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28917
28918 The Certificate issued by the CA published in the DANE-TA model should be
28919 issued using a strong hash algorithm.
28920 Exim, and importantly various other MTAs sending to you, will not
28921 re-enable hash algorithms which have been disabled by default in TLS
28922 libraries.
28923 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28924 interoperability (and probably the maximum too, in 2018).
28925
28926 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28927 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28928 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28929
28930 .code
28931   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28932                                  {= {4}{$tls_out_tlsa_usage}} } \
28933                          {*}{}}
28934 .endd
28935
28936 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28937 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28938 found. If the definition of &%hosts_request_ocsp%& includes the
28939 string "tls_out_tlsa_usage", they are re-expanded in time to
28940 control the OCSP request.
28941
28942 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28943 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28944
28945
28946 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28947 and &%dane_require_tls_ciphers%&.
28948 The require variant will result in failure if the target host is not DNSSEC-secured.
28949
28950 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28951
28952 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28953 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28954 will be required for the host.  If it does not, the host will not
28955 be used; there is no fallback to non-DANE or non-TLS.
28956
28957 If DANE is requested and usable, then the TLS cipher list configuration
28958 prefers to use the option &%dane_require_tls_ciphers%& and falls
28959 back to &%tls_require_ciphers%& only if that is unset.
28960 This lets you configure "decent crypto" for DANE and "better than nothing
28961 crypto" as the default.  Note though that while GnuTLS lets the string control
28962 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28963 limited to ciphersuite constraints.
28964
28965 If DANE is requested and useable (see above) the following transport options are ignored:
28966 .code
28967   hosts_require_tls
28968   tls_verify_hosts
28969   tls_try_verify_hosts
28970   tls_verify_certificates
28971   tls_crl
28972   tls_verify_cert_hostnames
28973 .endd
28974
28975 If DANE is not usable, whether requested or not, and CA-anchored
28976 verification evaluation is wanted, the above variables should be set appropriately.
28977
28978 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28979
28980 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28981
28982 There is a new variable &$tls_out_dane$& which will have "yes" if
28983 verification succeeded using DANE and "no" otherwise (only useful
28984 in combination with events; see &<<CHAPevents>>&),
28985 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28986
28987 .cindex DANE reporting
28988 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28989 to achieve DANE-verified connection, if one was either requested and offered, or
28990 required.  This is intended to support TLS-reporting as defined in
28991 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28992 The &$event_data$& will be one of the Result Types defined in
28993 Section 4.3 of that document.
28994
28995 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28996
28997 DANE is specified in published RFCs and decouples certificate authority trust
28998 selection from a "race to the bottom" of "you must trust everything for mail
28999 to get through".  There is an alternative technology called MTA-STS, which
29000 instead publishes MX trust anchor information on an HTTPS website.  At the
29001 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29002 Exim has no support for MTA-STS as a client, but Exim mail server operators
29003 can choose to publish information describing their TLS configuration using
29004 MTA-STS to let those clients who do use that protocol derive trust
29005 information.
29006
29007 The MTA-STS design requires a certificate from a public Certificate Authority
29008 which is recognized by clients sending to you.
29009 That selection of which CAs are trusted by others is outside your control.
29010
29011 The most interoperable course of action is probably to use
29012 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29013 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29014 records for DANE clients (such as Exim and Postfix) and to publish anchor
29015 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29016 domain itself (with caveats around occasionally broken MTA-STS because of
29017 incompatible specification changes prior to reaching RFC status).
29018
29019
29020
29021 . ////////////////////////////////////////////////////////////////////////////
29022 . ////////////////////////////////////////////////////////////////////////////
29023
29024 .chapter "Access control lists" "CHAPACL"
29025 .scindex IIDacl "&ACL;" "description"
29026 .cindex "control of incoming mail"
29027 .cindex "message" "controlling incoming"
29028 .cindex "policy control" "access control lists"
29029 Access Control Lists (ACLs) are defined in a separate section of the runtime
29030 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29031 name, terminated by a colon. Here is a complete ACL section that contains just
29032 one very small ACL:
29033 .code
29034 begin acl
29035 small_acl:
29036   accept   hosts = one.host.only
29037 .endd
29038 You can have as many lists as you like in the ACL section, and the order in
29039 which they appear does not matter. The lists are self-terminating.
29040
29041 The majority of ACLs are used to control Exim's behaviour when it receives
29042 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29043 when a local process submits a message using SMTP by specifying the &%-bs%&
29044 option. The most common use is for controlling which recipients are accepted
29045 in incoming messages. In addition, you can define an ACL that is used to check
29046 local non-SMTP messages. The default configuration file contains an example of
29047 a realistic ACL for checking RCPT commands. This is discussed in chapter
29048 &<<CHAPdefconfil>>&.
29049
29050
29051 .section "Testing ACLs" "SECID188"
29052 The &%-bh%& command line option provides a way of testing your ACL
29053 configuration locally by running a fake SMTP session with which you interact.
29054
29055
29056 .section "Specifying when ACLs are used" "SECID189"
29057 .cindex "&ACL;" "options for specifying"
29058 In order to cause an ACL to be used, you have to name it in one of the relevant
29059 options in the main part of the configuration. These options are:
29060 .cindex "AUTH" "ACL for"
29061 .cindex "DATA" "ACLs for"
29062 .cindex "ETRN" "ACL for"
29063 .cindex "EXPN" "ACL for"
29064 .cindex "HELO" "ACL for"
29065 .cindex "EHLO" "ACL for"
29066 .cindex "DKIM" "ACL for"
29067 .cindex "MAIL" "ACL for"
29068 .cindex "QUIT, ACL for"
29069 .cindex "RCPT" "ACL for"
29070 .cindex "STARTTLS, ACL for"
29071 .cindex "VRFY" "ACL for"
29072 .cindex "SMTP" "connection, ACL for"
29073 .cindex "non-SMTP messages" "ACLs for"
29074 .cindex "MIME content scanning" "ACL for"
29075 .cindex "PRDR" "ACL for"
29076
29077 .table2 140pt
29078 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29079 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29080 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29081 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29082 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29083 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29084 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29085 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29086 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29087 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29088 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29089 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29090 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29091 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29092 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29093 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29094 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29095 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29096 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29097 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29098 .endtable
29099
29100 For example, if you set
29101 .code
29102 acl_smtp_rcpt = small_acl
29103 .endd
29104 the little ACL defined above is used whenever Exim receives a RCPT command
29105 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29106 done when RCPT commands arrive. A rejection of RCPT should cause the
29107 sending MTA to give up on the recipient address contained in the RCPT
29108 command, whereas rejection at other times may cause the client MTA to keep on
29109 trying to deliver the message. It is therefore recommended that you do as much
29110 testing as possible at RCPT time.
29111
29112
29113 .section "The non-SMTP ACLs" "SECID190"
29114 .cindex "non-SMTP messages" "ACLs for"
29115 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29116 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29117 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29118 the state of the SMTP connection such as encryption and authentication) are not
29119 relevant and are forbidden in these ACLs. However, the sender and recipients
29120 are known, so the &%senders%& and &%sender_domains%& conditions and the
29121 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29122 &$authenticated_sender$& are also available. You can specify added header lines
29123 in any of these ACLs.
29124
29125 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29126 non-SMTP message, before any of the message has been read. (This is the
29127 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29128 batched SMTP input, it runs after the DATA command has been reached. The
29129 result of this ACL is ignored; it cannot be used to reject a message. If you
29130 really need to, you could set a value in an ACL variable here and reject based
29131 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29132 controls, and in particular, it can be used to set
29133 .code
29134 control = suppress_local_fixups
29135 .endd
29136 This cannot be used in the other non-SMTP ACLs because by the time they are
29137 run, it is too late.
29138
29139 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29140 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29141
29142 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29143 kind of rejection is treated as permanent, because there is no way of sending a
29144 temporary error for these kinds of message.
29145
29146
29147 .section "The SMTP connect ACL" "SECID191"
29148 .cindex "SMTP" "connection, ACL for"
29149 .oindex &%smtp_banner%&
29150 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29151 session, after the test specified by &%host_reject_connection%& (which is now
29152 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29153 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29154 the message override the banner message that is otherwise specified by the
29155 &%smtp_banner%& option.
29156
29157
29158 .section "The EHLO/HELO ACL" "SECID192"
29159 .cindex "EHLO" "ACL for"
29160 .cindex "HELO" "ACL for"
29161 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29162 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29163 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29164 Note that a client may issue more than one EHLO or HELO command in an SMTP
29165 session, and indeed is required to issue a new EHLO or HELO after successfully
29166 setting up encryption following a STARTTLS command.
29167
29168 Note also that a deny neither forces the client to go away nor means that
29169 mail will be refused on the connection.  Consider checking for
29170 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29171
29172 If the command is accepted by an &%accept%& verb that has a &%message%&
29173 modifier, the message may not contain more than one line (it will be truncated
29174 at the first newline and a panic logged if it does). Such a message cannot
29175 affect the EHLO options that are listed on the second and subsequent lines of
29176 an EHLO response.
29177
29178
29179 .section "The DATA ACLs" "SECID193"
29180 .cindex "DATA" "ACLs for"
29181 Two ACLs are associated with the DATA command, because it is two-stage
29182 command, with two responses being sent to the client.
29183 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29184 is obeyed. This gives you control after all the RCPT commands, but before
29185 the message itself is received. It offers the opportunity to give a negative
29186 response to the DATA command before the data is transmitted. Header lines
29187 added by MAIL or RCPT ACLs are not visible at this time, but any that
29188 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29189
29190 You cannot test the contents of the message, for example, to verify addresses
29191 in the headers, at RCPT time or when the DATA command is received. Such
29192 tests have to appear in the ACL that is run after the message itself has been
29193 received, before the final response to the DATA command is sent. This is
29194 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29195 associated with the DATA command.
29196
29197 .cindex CHUNKING "BDAT command"
29198 .cindex BDAT "SMTP command"
29199 .cindex "RFC 3030" CHUNKING
29200 If CHUNKING was advertised and a BDAT command sequence is received,
29201 the &%acl_smtp_predata%& ACL is not run.
29202 . XXX why not?  It should be possible, for the first BDAT.
29203 The &%acl_smtp_data%& is run after the last BDAT command and all of
29204 the data specified is received.
29205
29206 For both of these ACLs, it is not possible to reject individual recipients. An
29207 error response rejects the entire message. Unfortunately, it is known that some
29208 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29209 before or after the data) correctly &-- they keep the message on their queues
29210 and try again later, but that is their problem, though it does waste some of
29211 your resources.
29212
29213 The &%acl_smtp_data%& ACL is run after
29214 the &%acl_smtp_data_prdr%&,
29215 the &%acl_smtp_dkim%&
29216 and the &%acl_smtp_mime%& ACLs.
29217
29218 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29219 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29220 enabled (which is the default).
29221
29222 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29223 received, and is executed for each DKIM signature found in a message.  If not
29224 otherwise specified, the default action is to accept.
29225
29226 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29227
29228 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29229
29230
29231 .section "The SMTP MIME ACL" "SECID194"
29232 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29233 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29234
29235 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29236
29237
29238 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29239 .cindex "PRDR" "ACL for"
29240 .oindex "&%prdr_enable%&"
29241 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29242 with PRDR support enabled (which is the default).
29243 It becomes active only when the PRDR feature is negotiated between
29244 client and server for a message, and more than one recipient
29245 has been accepted.
29246
29247 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29248 has been received, and is executed once for each recipient of the message
29249 with &$local_part$& and &$domain$& valid.
29250 The test may accept, defer or deny for individual recipients.
29251 The &%acl_smtp_data%& will still be called after this ACL and
29252 can reject the message overall, even if this ACL has accepted it
29253 for some or all recipients.
29254
29255 PRDR may be used to support per-user content filtering.  Without it
29256 one must defer any recipient after the first that has a different
29257 content-filter configuration.  With PRDR, the RCPT-time check
29258 .cindex "PRDR" "variable for"
29259 for this can be disabled when the variable &$prdr_requested$&
29260 is &"yes"&.
29261 Any required difference in behaviour of the main DATA-time
29262 ACL should however depend on the PRDR-time ACL having run, as Exim
29263 will avoid doing so in some situations (e.g. single-recipient mails).
29264
29265 See also the &%prdr_enable%& global option
29266 and the &%hosts_try_prdr%& smtp transport option.
29267
29268 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29269 If the ACL is not defined, processing completes as if
29270 the feature was not requested by the client.
29271
29272 .section "The QUIT ACL" "SECTQUITACL"
29273 .cindex "QUIT, ACL for"
29274 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29275 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29276 does not in fact control any access.
29277 For this reason, it may only accept
29278 or warn as its final result.
29279
29280 This ACL can be used for tasks such as custom logging at the end of an SMTP
29281 session. For example, you can use ACL variables in other ACLs to count
29282 messages, recipients, etc., and log the totals at QUIT time using one or
29283 more &%logwrite%& modifiers on a &%warn%& verb.
29284
29285 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29286 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29287
29288 You do not need to have a final &%accept%&, but if you do, you can use a
29289 &%message%& modifier to specify custom text that is sent as part of the 221
29290 response to QUIT.
29291
29292 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29293 failure (for example, failure to open a log file, or when Exim is bombing out
29294 because it has detected an unrecoverable error), all SMTP commands from the
29295 client are given temporary error responses until QUIT is received or the
29296 connection is closed. In these special cases, the QUIT ACL does not run.
29297
29298
29299 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29300 .vindex &$acl_smtp_notquit$&
29301 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29302 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29303 trouble, such as being unable to write to its log files, this ACL is not run,
29304 because it might try to do things (such as write to log files) that make the
29305 situation even worse.
29306
29307 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29308 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29309 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29310 and &%warn%&.
29311
29312 .vindex &$smtp_notquit_reason$&
29313 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29314 to a string that indicates the reason for the termination of the SMTP
29315 connection. The possible values are:
29316 .table2
29317 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29318 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29319 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29320 .irow &`connection-lost`&          "The SMTP connection has been lost"
29321 .irow &`data-timeout`&             "Timeout while reading message data"
29322 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29323 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29324 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29325 .irow &`synchronization-error`&    "SMTP synchronization error"
29326 .irow &`tls-failed`&               "TLS failed to start"
29327 .endtable
29328 In most cases when an SMTP connection is closed without having received QUIT,
29329 Exim sends an SMTP response message before actually closing the connection.
29330 With the exception of the &`acl-drop`& case, the default message can be
29331 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29332 &%drop%& verb in another ACL, it is the message from the other ACL that is
29333 used.
29334
29335
29336 .section "Finding an ACL to use" "SECID195"
29337 .cindex "&ACL;" "finding which to use"
29338 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29339 you can use different ACLs in different circumstances. For example,
29340 .code
29341 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29342                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29343 .endd
29344 In the default configuration file there are some example settings for
29345 providing an RFC 4409 message &"submission"& service on port 587 and
29346 an RFC 8314 &"submissions"& service on port 465. You can use a string
29347 expansion like this to choose an ACL for MUAs on these ports which is
29348 more appropriate for this purpose than the default ACL on port 25.
29349
29350 The expanded string does not have to be the name of an ACL in the
29351 configuration file; there are other possibilities. Having expanded the
29352 string, Exim searches for an ACL as follows:
29353
29354 .ilist
29355 If the string begins with a slash, Exim uses it as a filename, and reads its
29356 contents as an ACL. The lines are processed in the same way as lines in the
29357 Exim configuration file. In particular, continuation lines are supported, blank
29358 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29359 If the file does not exist or cannot be read, an error occurs (typically
29360 causing a temporary failure of whatever caused the ACL to be run). For example:
29361 .code
29362 acl_smtp_data = /etc/acls/\
29363   ${lookup{$sender_host_address}lsearch\
29364   {/etc/acllist}{$value}{default}}
29365 .endd
29366 This looks up an ACL file to use on the basis of the host's IP address, falling
29367 back to a default if the lookup fails. If an ACL is successfully read from a
29368 file, it is retained in memory for the duration of the Exim process, so that it
29369 can be re-used without having to re-read the file.
29370 .next
29371 If the string does not start with a slash, and does not contain any spaces,
29372 Exim searches the ACL section of the configuration for an ACL whose name
29373 matches the string.
29374 .next
29375 If no named ACL is found, or if the string contains spaces, Exim parses
29376 the string as an inline ACL. This can save typing in cases where you just
29377 want to have something like
29378 .code
29379 acl_smtp_vrfy = accept
29380 .endd
29381 in order to allow free use of the VRFY command. Such a string may contain
29382 newlines; it is processed in the same way as an ACL that is read from a file.
29383 .endlist
29384
29385
29386
29387
29388 .section "ACL return codes" "SECID196"
29389 .cindex "&ACL;" "return codes"
29390 Except for the QUIT ACL, which does not affect the SMTP return code (see
29391 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29392 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29393 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29394 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29395 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29396 This also causes a 4&'xx'& return code.
29397
29398 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29399 &"deny"&, because there is no mechanism for passing temporary errors to the
29400 submitters of non-SMTP messages.
29401
29402
29403 ACLs that are relevant to message reception may also return &"discard"&. This
29404 has the effect of &"accept"&, but causes either the entire message or an
29405 individual recipient address to be discarded. In other words, it is a
29406 blackholing facility. Use it with care.
29407
29408 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29409 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29410 RCPT ACL is to discard just the one recipient address. If there are no
29411 recipients left when the message's data is received, the DATA ACL is not
29412 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29413 remaining recipients. The &"discard"& return is not permitted for the
29414 &%acl_smtp_predata%& ACL.
29415
29416 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29417 is done on the address and the result determines the SMTP response.
29418
29419
29420 .cindex "&[local_scan()]& function" "when all recipients discarded"
29421 The &[local_scan()]& function is always run, even if there are no remaining
29422 recipients; it may create new recipients.
29423
29424
29425
29426 .section "Unset ACL options" "SECID197"
29427 .cindex "&ACL;" "unset options"
29428 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29429 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29430 not defined at all. For any defined ACL, the default action when control
29431 reaches the end of the ACL statements is &"deny"&.
29432
29433 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29434 these two are ACLs that are used only for their side effects. They cannot be
29435 used to accept or reject anything.
29436
29437 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29438 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29439 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29440 when the ACL is not defined is &"accept"&.
29441
29442 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29443 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29444 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29445 messages over an SMTP connection. For an example, see the ACL in the default
29446 configuration file.
29447
29448
29449
29450
29451 .section "Data for message ACLs" "SECID198"
29452 .cindex "&ACL;" "data for message ACL"
29453 .vindex &$domain$&
29454 .vindex &$local_part$&
29455 .vindex &$sender_address$&
29456 .vindex &$sender_host_address$&
29457 .vindex &$smtp_command$&
29458 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29459 that contain information about the host and the message's sender (for example,
29460 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29461 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29462 &$local_part$& are set from the argument address. The entire SMTP command
29463 is available in &$smtp_command$&.
29464
29465 When an ACL for the AUTH parameter of MAIL is running, the variables that
29466 contain information about the host are set, but &$sender_address$& is not yet
29467 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29468 how it is used.
29469
29470 .vindex "&$message_size$&"
29471 The &$message_size$& variable is set to the value of the SIZE parameter on
29472 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29473 that parameter is not given. The value is updated to the true message size by
29474 the time the final DATA ACL is run (after the message data has been
29475 received).
29476
29477 .vindex "&$rcpt_count$&"
29478 .vindex "&$recipients_count$&"
29479 The &$rcpt_count$& variable increases by one for each RCPT command received.
29480 The &$recipients_count$& variable increases by one each time a RCPT command is
29481 accepted, so while an ACL for RCPT is being processed, it contains the number
29482 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29483 &$rcpt_count$& contains the total number of RCPT commands, and
29484 &$recipients_count$& contains the total number of accepted recipients.
29485
29486
29487
29488
29489
29490 .section "Data for non-message ACLs" "SECTdatfornon"
29491 .cindex "&ACL;" "data for non-message ACL"
29492 .vindex &$smtp_command_argument$&
29493 .vindex &$smtp_command$&
29494 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29495 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29496 and the entire SMTP command is available in &$smtp_command$&.
29497 These variables can be tested using a &%condition%& condition. For example,
29498 here is an ACL for use with AUTH, which insists that either the session is
29499 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29500 does not permit authentication methods that use cleartext passwords on
29501 unencrypted connections.
29502 .code
29503 acl_check_auth:
29504   accept encrypted = *
29505   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29506                      {CRAM-MD5}}
29507   deny   message   = TLS encryption or CRAM-MD5 required
29508 .endd
29509 (Another way of applying this restriction is to arrange for the authenticators
29510 that use cleartext passwords not to be advertised when the connection is not
29511 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29512 option to do this.)
29513
29514
29515
29516 .section "Format of an ACL" "SECID199"
29517 .cindex "&ACL;" "format of"
29518 .cindex "&ACL;" "verbs, definition of"
29519 An individual ACL consists of a number of statements. Each statement starts
29520 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29521 Modifiers can change the way the verb operates, define error and log messages,
29522 set variables, insert delays, and vary the processing of accepted messages.
29523
29524 If all the conditions are met, the verb is obeyed. The same condition may be
29525 used (with different arguments) more than once in the same statement. This
29526 provides a means of specifying an &"and"& conjunction between conditions. For
29527 example:
29528 .code
29529 deny  dnslists = list1.example
29530       dnslists = list2.example
29531 .endd
29532 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29533 the conditions and modifiers when it reaches a condition that fails. What
29534 happens then depends on the verb (and in one case, on a special modifier). Not
29535 all the conditions make sense at every testing point. For example, you cannot
29536 test a sender address in the ACL that is run for a VRFY command.
29537
29538
29539 .section "ACL verbs" "SECID200"
29540 The ACL verbs are as follows:
29541
29542 .ilist
29543 .cindex "&%accept%& ACL verb"
29544 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29545 of the conditions are not met, what happens depends on whether &%endpass%&
29546 appears among the conditions (for syntax see below). If the failing condition
29547 is before &%endpass%&, control is passed to the next ACL statement; if it is
29548 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29549 check a RCPT command:
29550 .code
29551 accept domains = +local_domains
29552        endpass
29553        verify = recipient
29554 .endd
29555 If the recipient domain does not match the &%domains%& condition, control
29556 passes to the next statement. If it does match, the recipient is verified, and
29557 the command is accepted if verification succeeds. However, if verification
29558 fails, the ACL yields &"deny"&, because the failing condition is after
29559 &%endpass%&.
29560
29561 The &%endpass%& feature has turned out to be confusing to many people, so its
29562 use is not recommended nowadays. It is always possible to rewrite an ACL so
29563 that &%endpass%& is not needed, and it is no longer used in the default
29564 configuration.
29565
29566 .cindex "&%message%& ACL modifier" "with &%accept%&"
29567 If a &%message%& modifier appears on an &%accept%& statement, its action
29568 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29569 (when an &%accept%& verb either accepts or passes control to the next
29570 statement), &%message%& can be used to vary the message that is sent when an
29571 SMTP command is accepted. For example, in a RCPT ACL you could have:
29572 .display
29573 &`accept  `&<&'some conditions'&>
29574 &`        message = OK, I will allow you through today`&
29575 .endd
29576 You can specify an SMTP response code, optionally followed by an &"extended
29577 response code"& at the start of the message, but the first digit must be the
29578 same as would be sent by default, which is 2 for an &%accept%& verb.
29579
29580 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29581 an error message that is used when access is denied. This behaviour is retained
29582 for backward compatibility, but current &"best practice"& is to avoid the use
29583 of &%endpass%&.
29584
29585
29586 .next
29587 .cindex "&%defer%& ACL verb"
29588 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29589 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29590 &%defer%& is the same as &%deny%&, because there is no way of sending a
29591 temporary error. For a RCPT command, &%defer%& is much the same as using a
29592 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29593 be used in any ACL, and even for a recipient it might be a simpler approach.
29594
29595
29596 .next
29597 .cindex "&%deny%& ACL verb"
29598 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29599 the conditions are not met, control is passed to the next ACL statement. For
29600 example,
29601 .code
29602 deny dnslists = blackholes.mail-abuse.org
29603 .endd
29604 rejects commands from hosts that are on a DNS black list.
29605
29606
29607 .next
29608 .cindex "&%discard%& ACL verb"
29609 &%discard%&: This verb behaves like &%accept%&, except that it returns
29610 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29611 that are concerned with receiving messages. When all the conditions are true,
29612 the sending entity receives a &"success"& response. However, &%discard%& causes
29613 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29614 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29615 message's recipients are discarded. Recipients that are discarded before DATA
29616 do not appear in the log line when the &%received_recipients%& log selector is set.
29617
29618 If the &%log_message%& modifier is set when &%discard%& operates,
29619 its contents are added to the line that is automatically written to the log.
29620 The &%message%& modifier operates exactly as it does for &%accept%&.
29621
29622
29623 .next
29624 .cindex "&%drop%& ACL verb"
29625 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29626 forcibly closed after the 5&'xx'& error message has been sent. For example:
29627 .code
29628 drop   message   = I don't take more than 20 RCPTs
29629        condition = ${if > {$rcpt_count}{20}}
29630 .endd
29631 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29632 The connection is always dropped after sending a 550 response.
29633
29634 .next
29635 .cindex "&%require%& ACL verb"
29636 &%require%&: If all the conditions are met, control is passed to the next ACL
29637 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29638 example, when checking a RCPT command,
29639 .code
29640 require message = Sender did not verify
29641         verify  = sender
29642 .endd
29643 passes control to subsequent statements only if the message's sender can be
29644 verified. Otherwise, it rejects the command. Note the positioning of the
29645 &%message%& modifier, before the &%verify%& condition. The reason for this is
29646 discussed in section &<<SECTcondmodproc>>&.
29647
29648 .next
29649 .cindex "&%warn%& ACL verb"
29650 &%warn%&: If all the conditions are true, a line specified by the
29651 &%log_message%& modifier is written to Exim's main log. Control always passes
29652 to the next ACL statement. If any condition is false, the log line is not
29653 written. If an identical log line is requested several times in the same
29654 message, only one copy is actually written to the log. If you want to force
29655 duplicates to be written, use the &%logwrite%& modifier instead.
29656
29657 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29658 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29659 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29660 first failing condition. There is more about adding header lines in section
29661 &<<SECTaddheadacl>>&.
29662
29663 If any condition on a &%warn%& statement cannot be completed (that is, there is
29664 some sort of defer), the log line specified by &%log_message%& is not written.
29665 This does not include the case of a forced failure from a lookup, which
29666 is considered to be a successful completion. After a defer, no further
29667 conditions or modifiers in the &%warn%& statement are processed. The incident
29668 is logged, and the ACL continues to be processed, from the next statement
29669 onwards.
29670
29671
29672 .vindex "&$acl_verify_message$&"
29673 When one of the &%warn%& conditions is an address verification that fails, the
29674 text of the verification failure message is in &$acl_verify_message$&. If you
29675 want this logged, you must set it up explicitly. For example:
29676 .code
29677 warn   !verify = sender
29678        log_message = sender verify failed: $acl_verify_message
29679 .endd
29680 .endlist
29681
29682 At the end of each ACL there is an implicit unconditional &%deny%&.
29683
29684 As you can see from the examples above, the conditions and modifiers are
29685 written one to a line, with the first one on the same line as the verb, and
29686 subsequent ones on following lines. If you have a very long condition, you can
29687 continue it onto several physical lines by the usual backslash continuation
29688 mechanism. It is conventional to align the conditions vertically.
29689
29690
29691
29692 .section "ACL variables" "SECTaclvariables"
29693 .cindex "&ACL;" "variables"
29694 There are some special variables that can be set during ACL processing. They
29695 can be used to pass information between different ACLs, different invocations
29696 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29697 transports, and filters that are used to deliver a message. The names of these
29698 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29699 an underscore, but the remainder of the name can be any sequence of
29700 alphanumeric characters and underscores that you choose. There is no limit on
29701 the number of ACL variables. The two sets act as follows:
29702 .ilist
29703 The values of those variables whose names begin with &$acl_c$& persist
29704 throughout an SMTP connection. They are never reset. Thus, a value that is set
29705 while receiving one message is still available when receiving the next message
29706 on the same SMTP connection.
29707 .next
29708 The values of those variables whose names begin with &$acl_m$& persist only
29709 while a message is being received. They are reset afterwards. They are also
29710 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29711 .endlist
29712
29713 When a message is accepted, the current values of all the ACL variables are
29714 preserved with the message and are subsequently made available at delivery
29715 time. The ACL variables are set by a modifier called &%set%&. For example:
29716 .code
29717 accept hosts = whatever
29718        set acl_m4 = some value
29719 accept authenticated = *
29720        set acl_c_auth = yes
29721 .endd
29722 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29723 be set. If you want to set a variable without taking any action, you can use a
29724 &%warn%& verb without any other modifiers or conditions.
29725
29726 .oindex &%strict_acl_vars%&
29727 What happens if a syntactically valid but undefined ACL variable is
29728 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29729 false (the default), an empty string is substituted; if it is true, an
29730 error is generated.
29731
29732 Versions of Exim before 4.64 have a limited set of numbered variables, but
29733 their names are compatible, so there is no problem with upgrading.
29734
29735
29736 .section "Condition and modifier processing" "SECTcondmodproc"
29737 .cindex "&ACL;" "conditions; processing"
29738 .cindex "&ACL;" "modifiers; processing"
29739 An exclamation mark preceding a condition negates its result. For example:
29740 .code
29741 deny   domains = *.dom.example
29742       !verify  = recipient
29743 .endd
29744 causes the ACL to return &"deny"& if the recipient domain ends in
29745 &'dom.example'& and the recipient address cannot be verified. Sometimes
29746 negation can be used on the right-hand side of a condition. For example, these
29747 two statements are equivalent:
29748 .code
29749 deny  hosts = !192.168.3.4
29750 deny !hosts =  192.168.3.4
29751 .endd
29752 However, for many conditions (&%verify%& being a good example), only left-hand
29753 side negation of the whole condition is possible.
29754
29755 The arguments of conditions and modifiers are expanded. A forced failure
29756 of an expansion causes a condition to be ignored, that is, it behaves as if the
29757 condition is true. Consider these two statements:
29758 .code
29759 accept  senders = ${lookup{$host_name}lsearch\
29760                   {/some/file}{$value}fail}
29761 accept  senders = ${lookup{$host_name}lsearch\
29762                   {/some/file}{$value}{}}
29763 .endd
29764 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29765 the returned list is searched, but if the lookup fails the behaviour is
29766 different in the two cases. The &%fail%& in the first statement causes the
29767 condition to be ignored, leaving no further conditions. The &%accept%& verb
29768 therefore succeeds. The second statement, however, generates an empty list when
29769 the lookup fails. No sender can match an empty list, so the condition fails,
29770 and therefore the &%accept%& also fails.
29771
29772 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29773 specify actions that are taken as the conditions for a statement are checked;
29774 others specify text for messages that are used when access is denied or a
29775 warning is generated. The &%control%& modifier affects the way an incoming
29776 message is handled.
29777
29778 The positioning of the modifiers in an ACL statement is important, because the
29779 processing of a verb ceases as soon as its outcome is known. Only those
29780 modifiers that have already been encountered will take effect. For example,
29781 consider this use of the &%message%& modifier:
29782 .code
29783 require message = Can't verify sender
29784         verify  = sender
29785         message = Can't verify recipient
29786         verify  = recipient
29787         message = This message cannot be used
29788 .endd
29789 If sender verification fails, Exim knows that the result of the statement is
29790 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29791 so its text is used as the error message. If sender verification succeeds, but
29792 recipient verification fails, the second message is used. If recipient
29793 verification succeeds, the third message becomes &"current"&, but is never used
29794 because there are no more conditions to cause failure.
29795
29796 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29797 modifier that is used, because all the conditions must be true for rejection to
29798 happen. Specifying more than one &%message%& modifier does not make sense, and
29799 the message can even be specified after all the conditions. For example:
29800 .code
29801 deny   hosts = ...
29802       !senders = *@my.domain.example
29803        message = Invalid sender from client host
29804 .endd
29805 The &"deny"& result does not happen until the end of the statement is reached,
29806 by which time Exim has set up the message.
29807
29808
29809
29810 .section "ACL modifiers" "SECTACLmodi"
29811 .cindex "&ACL;" "modifiers; list of"
29812 The ACL modifiers are as follows:
29813
29814 .vlist
29815 .vitem &*add_header*&&~=&~<&'text'&>
29816 This modifier specifies one or more header lines that are to be added to an
29817 incoming message, assuming, of course, that the message is ultimately
29818 accepted. For details, see section &<<SECTaddheadacl>>&.
29819
29820 .vitem &*continue*&&~=&~<&'text'&>
29821 .cindex "&%continue%& ACL modifier"
29822 .cindex "database" "updating in ACL"
29823 This modifier does nothing of itself, and processing of the ACL always
29824 continues with the next condition or modifier. The value of &%continue%& is in
29825 the side effects of expanding its argument. Typically this could be used to
29826 update a database. It is really just a syntactic tidiness, to avoid having to
29827 write rather ugly lines like this:
29828 .display
29829 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29830 .endd
29831 Instead, all you need is
29832 .display
29833 &`continue = `&<&'some expansion'&>
29834 .endd
29835
29836 .vitem &*control*&&~=&~<&'text'&>
29837 .cindex "&%control%& ACL modifier"
29838 This modifier affects the subsequent processing of the SMTP connection or of an
29839 incoming message that is accepted. The effect of the first type of control
29840 lasts for the duration of the connection, whereas the effect of the second type
29841 lasts only until the current message has been received. The message-specific
29842 controls always apply to the whole message, not to individual recipients,
29843 even if the &%control%& modifier appears in a RCPT ACL.
29844
29845 As there are now quite a few controls that can be applied, they are described
29846 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29847 in several different ways. For example:
29848
29849 . ==== As this is a nested list, any displays it contains must be indented
29850 . ==== as otherwise they are too far to the left. That comment applies only
29851 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29852 . ==== way.
29853
29854 .ilist
29855 It can be at the end of an &%accept%& statement:
29856 .code
29857     accept  ...some conditions
29858             control = queue_only
29859 .endd
29860 In this case, the control is applied when this statement yields &"accept"&, in
29861 other words, when the conditions are all true.
29862
29863 .next
29864 It can be in the middle of an &%accept%& statement:
29865 .code
29866     accept  ...some conditions...
29867             control = queue_only
29868             ...some more conditions...
29869 .endd
29870 If the first set of conditions are true, the control is applied, even if the
29871 statement does not accept because one of the second set of conditions is false.
29872 In this case, some subsequent statement must yield &"accept"& for the control
29873 to be relevant.
29874
29875 .next
29876 It can be used with &%warn%& to apply the control, leaving the
29877 decision about accepting or denying to a subsequent verb. For
29878 example:
29879 .code
29880     warn    ...some conditions...
29881             control = freeze
29882     accept  ...
29883 .endd
29884 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29885 &%logwrite%&, so it does not add anything to the message and does not write a
29886 log entry.
29887
29888 .next
29889 If you want to apply a control unconditionally, you can use it with a
29890 &%require%& verb. For example:
29891 .code
29892     require  control = no_multiline_responses
29893 .endd
29894 .endlist
29895
29896 .vitem &*delay*&&~=&~<&'time'&>
29897 .cindex "&%delay%& ACL modifier"
29898 .oindex "&%-bh%&"
29899 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29900 the time interval before proceeding. However, when testing Exim using the
29901 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29902 output instead). The time is given in the usual Exim notation, and the delay
29903 happens as soon as the modifier is processed. In an SMTP session, pending
29904 output is flushed before the delay is imposed.
29905
29906 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29907 example:
29908 .code
29909 deny    ...some conditions...
29910         delay = 30s
29911 .endd
29912 The delay happens if all the conditions are true, before the statement returns
29913 &"deny"&. Compare this with:
29914 .code
29915 deny    delay = 30s
29916         ...some conditions...
29917 .endd
29918 which waits for 30s before processing the conditions. The &%delay%& modifier
29919 can also be used with &%warn%& and together with &%control%&:
29920 .code
29921 warn    ...some conditions...
29922         delay = 2m
29923         control = freeze
29924 accept  ...
29925 .endd
29926
29927 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29928 responses to several commands are no longer buffered and sent in one packet (as
29929 they would normally be) because all output is flushed before imposing the
29930 delay. This optimization is disabled so that a number of small delays do not
29931 appear to the client as one large aggregated delay that might provoke an
29932 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29933 using a &%control%& modifier to set &%no_delay_flush%&.
29934
29935
29936 .vitem &*endpass*&
29937 .cindex "&%endpass%& ACL modifier"
29938 This modifier, which has no argument, is recognized only in &%accept%& and
29939 &%discard%& statements. It marks the boundary between the conditions whose
29940 failure causes control to pass to the next statement, and the conditions whose
29941 failure causes the ACL to return &"deny"&. This concept has proved to be
29942 confusing to some people, so the use of &%endpass%& is no longer recommended as
29943 &"best practice"&. See the description of &%accept%& above for more details.
29944
29945
29946 .vitem &*log_message*&&~=&~<&'text'&>
29947 .cindex "&%log_message%& ACL modifier"
29948 This modifier sets up a message that is used as part of the log message if the
29949 ACL denies access or a &%warn%& statement's conditions are true. For example:
29950 .code
29951 require log_message = wrong cipher suite $tls_in_cipher
29952         encrypted   = DES-CBC3-SHA
29953 .endd
29954 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29955 example:
29956 .display
29957 &`discard `&<&'some conditions'&>
29958 &`        log_message = Discarded $local_part@$domain because...`&
29959 .endd
29960 When access is denied, &%log_message%& adds to any underlying error message
29961 that may exist because of a condition failure. For example, while verifying a
29962 recipient address, a &':fail:'& redirection might have already set up a
29963 message.
29964
29965 The message may be defined before the conditions to which it applies, because
29966 the string expansion does not happen until Exim decides that access is to be
29967 denied. This means that any variables that are set by the condition are
29968 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29969 variables are set after a DNS black list lookup succeeds. If the expansion of
29970 &%log_message%& fails, or if the result is an empty string, the modifier is
29971 ignored.
29972
29973 .vindex "&$acl_verify_message$&"
29974 If you want to use a &%warn%& statement to log the result of an address
29975 verification, you can use &$acl_verify_message$& to include the verification
29976 error message.
29977
29978 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29979 the start of the logged message. If the same warning log message is requested
29980 more than once while receiving  a single email message, only one copy is
29981 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29982 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29983 is logged for a successful &%warn%& statement.
29984
29985 If &%log_message%& is not present and there is no underlying error message (for
29986 example, from the failure of address verification), but &%message%& is present,
29987 the &%message%& text is used for logging rejections. However, if any text for
29988 logging contains newlines, only the first line is logged. In the absence of
29989 both &%log_message%& and &%message%&, a default built-in message is used for
29990 logging rejections.
29991
29992
29993 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29994 .cindex "&%log_reject_target%& ACL modifier"
29995 .cindex "logging in ACL" "specifying which log"
29996 This modifier makes it possible to specify which logs are used for messages
29997 about ACL rejections. Its argument is a colon-separated list of words that can
29998 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29999 may be empty, in which case a rejection is not logged at all. For example, this
30000 ACL fragment writes no logging information when access is denied:
30001 .display
30002 &`deny `&<&'some conditions'&>
30003 &`     log_reject_target =`&
30004 .endd
30005 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30006 permanent and temporary rejections. Its effect lasts for the rest of the
30007 current ACL.
30008
30009
30010 .vitem &*logwrite*&&~=&~<&'text'&>
30011 .cindex "&%logwrite%& ACL modifier"
30012 .cindex "logging in ACL" "immediate"
30013 This modifier writes a message to a log file as soon as it is encountered when
30014 processing an ACL. (Compare &%log_message%&, which, except in the case of
30015 &%warn%& and &%discard%&, is used only if the ACL statement denies
30016 access.) The &%logwrite%& modifier can be used to log special incidents in
30017 ACLs. For example:
30018 .display
30019 &`accept `&<&'some special conditions'&>
30020 &`       control  = freeze`&
30021 &`       logwrite = froze message because ...`&
30022 .endd
30023 By default, the message is written to the main log. However, it may begin
30024 with a colon, followed by a comma-separated list of log names, and then
30025 another colon, to specify exactly which logs are to be written. For
30026 example:
30027 .code
30028 logwrite = :main,reject: text for main and reject logs
30029 logwrite = :panic: text for panic log only
30030 .endd
30031
30032
30033 .vitem &*message*&&~=&~<&'text'&>
30034 .cindex "&%message%& ACL modifier"
30035 This modifier sets up a text string that is expanded and used as a response
30036 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30037 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30038 there is some complication if &%endpass%& is involved; see the description of
30039 &%accept%& for details.)
30040
30041 The expansion of the message happens at the time Exim decides that the ACL is
30042 to end, not at the time it processes &%message%&. If the expansion fails, or
30043 generates an empty string, the modifier is ignored. Here is an example where
30044 &%message%& must be specified first, because the ACL ends with a rejection if
30045 the &%hosts%& condition fails:
30046 .code
30047 require  message = Host not recognized
30048          hosts = 10.0.0.0/8
30049 .endd
30050 (Once a condition has failed, no further conditions or modifiers are
30051 processed.)
30052
30053 .cindex "SMTP" "error codes"
30054 .oindex "&%smtp_banner%&
30055 For ACLs that are triggered by SMTP commands, the message is returned as part
30056 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30057 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30058 is accepted. In the case of the connect ACL, accepting with a message modifier
30059 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30060 accept message may not contain more than one line (otherwise it will be
30061 truncated at the first newline and a panic logged), and it cannot affect the
30062 EHLO options.
30063
30064 When SMTP is involved, the message may begin with an overriding response code,
30065 consisting of three digits optionally followed by an &"extended response code"&
30066 of the form &'n.n.n'&, each code being followed by a space. For example:
30067 .code
30068 deny  message = 599 1.2.3 Host not welcome
30069       hosts = 192.168.34.0/24
30070 .endd
30071 The first digit of the supplied response code must be the same as would be sent
30072 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30073 access, but for the predata ACL, note that the default success code is 354, not
30074 2&'xx'&.
30075
30076 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30077 the message modifier cannot override the 221 response code.
30078
30079 The text in a &%message%& modifier is literal; any quotes are taken as
30080 literals, but because the string is expanded, backslash escapes are processed
30081 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30082 response.
30083
30084 .vindex "&$acl_verify_message$&"
30085 For ACLs that are called by an &%acl =%& ACL condition, the message is
30086 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30087
30088 If &%message%& is used on a statement that verifies an address, the message
30089 specified overrides any message that is generated by the verification process.
30090 However, the original message is available in the variable
30091 &$acl_verify_message$&, so you can incorporate it into your message if you
30092 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30093 routers to be passed back as part of the SMTP response, you should either not
30094 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30095
30096 For compatibility with previous releases of Exim, a &%message%& modifier that
30097 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30098 modifier, but this usage is now deprecated. However, &%message%& acts only when
30099 all the conditions are true, wherever it appears in an ACL command, whereas
30100 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30101 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30102 effect.
30103
30104
30105 .vitem &*queue*&&~=&~<&'text'&>
30106 .cindex "&%queue%& ACL modifier"
30107 .cindex "named queues" "selecting in ACL"
30108 This modifier specifies the use of a named queue for spool files
30109 for the message.
30110 It can only be used before the message is received (i.e. not in
30111 the DATA ACL).
30112 This could be used, for example, for known high-volume burst sources
30113 of traffic, or for quarantine of messages.
30114 Separate queue-runner processes will be needed for named queues.
30115 If the text after expansion is empty, the default queue is used.
30116
30117
30118 .vitem &*remove_header*&&~=&~<&'text'&>
30119 This modifier specifies one or more header names in a colon-separated list
30120  that are to be removed from an incoming message, assuming, of course, that
30121 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30122
30123
30124 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30125 .cindex "&%set%& ACL modifier"
30126 This modifier puts a value into one of the ACL variables (see section
30127 &<<SECTaclvariables>>&).
30128
30129
30130 .vitem &*udpsend*&&~=&~<&'parameters'&>
30131 .cindex "UDP communications"
30132 This modifier sends a UDP packet, for purposes such as statistics
30133 collection or behaviour monitoring. The parameters are expanded, and
30134 the result of the expansion must be a colon-separated list consisting
30135 of a destination server, port number, and the packet contents. The
30136 server can be specified as a host name or IPv4 or IPv6 address. The
30137 separator can be changed with the usual angle bracket syntax. For
30138 example, you might want to collect information on which hosts connect
30139 when:
30140 .code
30141 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30142              $tod_zulu $sender_host_address
30143 .endd
30144 .endlist
30145
30146
30147
30148
30149 .section "Use of the control modifier" "SECTcontrols"
30150 .cindex "&%control%& ACL modifier"
30151 The &%control%& modifier supports the following settings:
30152
30153 .vlist
30154 .vitem &*control&~=&~allow_auth_unadvertised*&
30155 This modifier allows a client host to use the SMTP AUTH command even when it
30156 has not been advertised in response to EHLO. Furthermore, because there are
30157 apparently some really broken clients that do this, Exim will accept AUTH after
30158 HELO (rather than EHLO) when this control is set. It should be used only if you
30159 really need it, and you should limit its use to those broken clients that do
30160 not work without it. For example:
30161 .code
30162 warn hosts   = 192.168.34.25
30163      control = allow_auth_unadvertised
30164 .endd
30165 Normally, when an Exim server receives an AUTH command, it checks the name of
30166 the authentication mechanism that is given in the command to ensure that it
30167 matches an advertised mechanism. When this control is set, the check that a
30168 mechanism has been advertised is bypassed. Any configured mechanism can be used
30169 by the client. This control is permitted only in the connection and HELO ACLs.
30170
30171
30172 .vitem &*control&~=&~caseful_local_part*& &&&
30173        &*control&~=&~caselower_local_part*&
30174 .cindex "&ACL;" "case of local part in"
30175 .cindex "case of local parts"
30176 .vindex "&$local_part$&"
30177 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30178 (that is, during RCPT processing). By default, the contents of &$local_part$&
30179 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30180 any uppercase letters in the original local part are restored in &$local_part$&
30181 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30182 is encountered.
30183
30184 These controls affect only the current recipient. Moreover, they apply only to
30185 local part handling that takes place directly in the ACL (for example, as a key
30186 in lookups). If a test to verify the recipient is obeyed, the case-related
30187 handling of the local part during the verification is controlled by the router
30188 configuration (see the &%caseful_local_part%& generic router option).
30189
30190 This facility could be used, for example, to add a spam score to local parts
30191 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30192 spam score:
30193 .code
30194 warn  control = caseful_local_part
30195       set acl_m4 = ${eval:\
30196                      $acl_m4 + \
30197                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30198                     }
30199       control = caselower_local_part
30200 .endd
30201 Notice that we put back the lower cased version afterwards, assuming that
30202 is what is wanted for subsequent tests.
30203
30204
30205 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30206 .cindex "&ACL;" "cutthrough routing"
30207 .cindex "cutthrough" "requesting"
30208 This option requests delivery be attempted while the item is being received.
30209
30210 The option is usable in the RCPT ACL.
30211 If enabled for a message received via smtp and routed to an smtp transport,
30212 and only one transport, interface, destination host and port combination
30213 is used for all recipients of the message,
30214 then the delivery connection is made while the receiving connection is open
30215 and data is copied from one to the other.
30216
30217 An attempt to set this option for any recipient but the first
30218 for a mail will be quietly ignored.
30219 If a recipient-verify callout
30220 (with use_sender)
30221 connection is subsequently
30222 requested in the same ACL it is held open and used for
30223 any subsequent recipients and the data,
30224 otherwise one is made after the initial RCPT ACL completes.
30225
30226 Note that routers are used in verify mode,
30227 and cannot depend on content of received headers.
30228 Note also that headers cannot be
30229 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30230 Headers may be modified by routers (subject to the above) and transports.
30231 The &'Received-By:'& header is generated as soon as the body reception starts,
30232 rather than the traditional time after the full message is received;
30233 this will affect the timestamp.
30234
30235 All the usual ACLs are called; if one results in the message being
30236 rejected, all effort spent in delivery (including the costs on
30237 the ultimate destination) will be wasted.
30238 Note that in the case of data-time ACLs this includes the entire
30239 message body.
30240
30241 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30242 of outgoing messages is done, because it sends data to the ultimate destination
30243 before the entire message has been received from the source.
30244 It is not supported for messages received with the SMTP PRDR
30245 or CHUNKING
30246 options in use.
30247
30248 Should the ultimate destination system positively accept or reject the mail,
30249 a corresponding indication is given to the source system and nothing is queued.
30250 If the item is successfully delivered in cutthrough mode
30251 the delivery log lines are tagged with ">>" rather than "=>" and appear
30252 before the acceptance "<=" line.
30253
30254 If there is a temporary error the item is queued for later delivery in the
30255 usual fashion.
30256 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30257 to the control; the default value is &"spool"& and the alternate value
30258 &"pass"& copies an SMTP defer response from the target back to the initiator
30259 and does not queue the message.
30260 Note that this is independent of any recipient verify conditions in the ACL.
30261
30262 Delivery in this mode avoids the generation of a bounce mail to a
30263 (possibly faked)
30264 sender when the destination system is doing content-scan based rejection.
30265
30266
30267 .vitem &*control&~=&~debug/*&<&'options'&>
30268 .cindex "&ACL;" "enabling debug logging"
30269 .cindex "debugging" "enabling from an ACL"
30270 This control turns on debug logging, almost as though Exim had been invoked
30271 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30272 by default called &'debuglog'&.
30273 The filename can be adjusted with the &'tag'& option, which
30274 may access any variables already defined.  The logging may be adjusted with
30275 the &'opts'& option, which takes the same values as the &`-d`& command-line
30276 option.
30277 Logging started this way may be stopped, and the file removed,
30278 with the &'kill'& option.
30279 Some examples (which depend on variables that don't exist in all
30280 contexts):
30281 .code
30282       control = debug
30283       control = debug/tag=.$sender_host_address
30284       control = debug/opts=+expand+acl
30285       control = debug/tag=.$message_exim_id/opts=+expand
30286       control = debug/kill
30287 .endd
30288
30289
30290 .vitem &*control&~=&~dkim_disable_verify*&
30291 .cindex "disable DKIM verify"
30292 .cindex "DKIM" "disable verify"
30293 This control turns off DKIM verification processing entirely.  For details on
30294 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30295
30296
30297 .vitem &*control&~=&~dscp/*&<&'value'&>
30298 .cindex "&ACL;" "setting DSCP value"
30299 .cindex "DSCP" "inbound"
30300 This option causes the DSCP value associated with the socket for the inbound
30301 connection to be adjusted to a given value, given as one of a number of fixed
30302 strings or to numeric value.
30303 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30304 Common values include &`throughput`&, &`mincost`&, and on newer systems
30305 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30306
30307 The outbound packets from Exim will be marked with this value in the header
30308 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30309 that these values will have any effect, not be stripped by networking
30310 equipment, or do much of anything without cooperation with your Network
30311 Engineer and those of all network operators between the source and destination.
30312
30313
30314 .vitem &*control&~=&~enforce_sync*& &&&
30315        &*control&~=&~no_enforce_sync*&
30316 .cindex "SMTP" "synchronization checking"
30317 .cindex "synchronization checking in SMTP"
30318 These controls make it possible to be selective about when SMTP synchronization
30319 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30320 state of the switch (it is true by default). See the description of this option
30321 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30322
30323 The effect of these two controls lasts for the remainder of the SMTP
30324 connection. They can appear in any ACL except the one for the non-SMTP
30325 messages. The most straightforward place to put them is in the ACL defined by
30326 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30327 before the first synchronization check. The expected use is to turn off the
30328 synchronization checks for badly-behaved hosts that you nevertheless need to
30329 work with.
30330
30331
30332 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30333 .cindex "fake defer"
30334 .cindex "defer, fake"
30335 This control works in exactly the same way as &%fakereject%& (described below)
30336 except that it causes an SMTP 450 response after the message data instead of a
30337 550 response. You must take care when using &%fakedefer%& because it causes the
30338 messages to be duplicated when the sender retries. Therefore, you should not
30339 use &%fakedefer%& if the message is to be delivered normally.
30340
30341 .vitem &*control&~=&~fakereject/*&<&'message'&>
30342 .cindex "fake rejection"
30343 .cindex "rejection, fake"
30344 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30345 words, only when an SMTP message is being received. If Exim accepts the
30346 message, instead the final 250 response, a 550 rejection message is sent.
30347 However, Exim proceeds to deliver the message as normal. The control applies
30348 only to the current message, not to any subsequent ones that may be received in
30349 the same SMTP connection.
30350
30351 The text for the 550 response is taken from the &%control%& modifier. If no
30352 message is supplied, the following is used:
30353 .code
30354 550-Your message has been rejected but is being
30355 550-kept for evaluation.
30356 550-If it was a legitimate message, it may still be
30357 550 delivered to the target recipient(s).
30358 .endd
30359 This facility should be used with extreme caution.
30360
30361 .vitem &*control&~=&~freeze*&
30362 .cindex "frozen messages" "forcing in ACL"
30363 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30364 other words, only when a message is being received. If the message is accepted,
30365 it is placed on Exim's queue and frozen. The control applies only to the
30366 current message, not to any subsequent ones that may be received in the same
30367 SMTP connection.
30368
30369 This modifier can optionally be followed by &`/no_tell`&. If the global option
30370 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30371 is told about the freezing), provided all the &*control=freeze*& modifiers that
30372 are obeyed for the current message have the &`/no_tell`& option.
30373
30374 .vitem &*control&~=&~no_delay_flush*&
30375 .cindex "SMTP" "output flushing, disabling for delay"
30376 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30377 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30378 use. This control, as long as it is encountered before the &%delay%& modifier,
30379 disables such output flushing.
30380
30381 .vitem &*control&~=&~no_callout_flush*&
30382 .cindex "SMTP" "output flushing, disabling for callout"
30383 Exim normally flushes SMTP output before performing a callout in an ACL, to
30384 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30385 use. This control, as long as it is encountered before the &%verify%& condition
30386 that causes the callout, disables such output flushing.
30387
30388 .vitem &*control&~=&~no_mbox_unspool*&
30389 This control is available when Exim is compiled with the content scanning
30390 extension. Content scanning may require a copy of the current message, or parts
30391 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30392 or spam scanner. Normally, such copies are deleted when they are no longer
30393 needed. If this control is set, the copies are not deleted. The control applies
30394 only to the current message, not to any subsequent ones that may be received in
30395 the same SMTP connection. It is provided for debugging purposes and is unlikely
30396 to be useful in production.
30397
30398 .vitem &*control&~=&~no_multiline_responses*&
30399 .cindex "multiline responses, suppressing"
30400 This control is permitted for any ACL except the one for non-SMTP messages.
30401 It seems that there are broken clients in use that cannot handle multiline
30402 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30403
30404 If this control is set, multiline SMTP responses from ACL rejections are
30405 suppressed. One way of doing this would have been to put out these responses as
30406 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30407 (&"use multiline responses for more"& it says &-- ha!), and some of the
30408 responses might get close to that. So this facility, which is after all only a
30409 sop to broken clients, is implemented by doing two very easy things:
30410
30411 .ilist
30412 Extra information that is normally output as part of a rejection caused by
30413 sender verification failure is omitted. Only the final line (typically &"sender
30414 verification failed"&) is sent.
30415 .next
30416 If a &%message%& modifier supplies a multiline response, only the first
30417 line is output.
30418 .endlist
30419
30420 The setting of the switch can, of course, be made conditional on the
30421 calling host. Its effect lasts until the end of the SMTP connection.
30422
30423 .vitem &*control&~=&~no_pipelining*&
30424 .cindex "PIPELINING" "suppressing advertising"
30425 This control turns off the advertising of the PIPELINING extension to SMTP in
30426 the current session. To be useful, it must be obeyed before Exim sends its
30427 response to an EHLO command. Therefore, it should normally appear in an ACL
30428 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30429 &%pipelining_advertise_hosts%&.
30430
30431 .vitem &*control&~=&~queue_only*&
30432 .oindex "&%queue_only%&"
30433 .cindex "queueing incoming messages"
30434 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30435 other words, only when a message is being received. If the message is accepted,
30436 it is placed on Exim's queue and left there for delivery by a subsequent queue
30437 runner. No immediate delivery process is started. In other words, it has the
30438 effect as the &%queue_only%& global option. However, the control applies only
30439 to the current message, not to any subsequent ones that may be received in the
30440 same SMTP connection.
30441
30442 .vitem &*control&~=&~submission/*&<&'options'&>
30443 .cindex "message" "submission"
30444 .cindex "submission mode"
30445 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30446 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30447 the current message is a submission from a local MUA. In this case, Exim
30448 operates in &"submission mode"&, and applies certain fixups to the message if
30449 necessary. For example, it adds a &'Date:'& header line if one is not present.
30450 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30451 late (the message has already been created).
30452
30453 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30454 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30455 submission mode; the available options for this control are described there.
30456 The control applies only to the current message, not to any subsequent ones
30457 that may be received in the same SMTP connection.
30458
30459 .vitem &*control&~=&~suppress_local_fixups*&
30460 .cindex "submission fixups, suppressing"
30461 This control applies to locally submitted (non TCP/IP) messages, and is the
30462 complement of &`control = submission`&. It disables the fixups that are
30463 normally applied to locally-submitted messages. Specifically:
30464
30465 .ilist
30466 Any &'Sender:'& header line is left alone (in this respect, it is a
30467 dynamic version of &%local_sender_retain%&).
30468 .next
30469 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30470 .next
30471 There is no check that &'From:'& corresponds to the actual sender.
30472 .endlist ilist
30473
30474 This control may be useful when a remotely-originated message is accepted,
30475 passed to some scanning program, and then re-submitted for delivery. It can be
30476 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30477 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30478 data is read.
30479
30480 &*Note:*& This control applies only to the current message, not to any others
30481 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30482
30483 .vitem &*control&~=&~utf8_downconvert*&
30484 This control enables conversion of UTF-8 in message addresses
30485 to a-label form.
30486 For details see section &<<SECTi18nMTA>>&.
30487 .endlist vlist
30488
30489
30490 .section "Summary of message fixup control" "SECTsummesfix"
30491 All four possibilities for message fixups can be specified:
30492
30493 .ilist
30494 Locally submitted, fixups applied: the default.
30495 .next
30496 Locally submitted, no fixups applied: use
30497 &`control = suppress_local_fixups`&.
30498 .next
30499 Remotely submitted, no fixups applied: the default.
30500 .next
30501 Remotely submitted, fixups applied: use &`control = submission`&.
30502 .endlist
30503
30504
30505
30506 .section "Adding header lines in ACLs" "SECTaddheadacl"
30507 .cindex "header lines" "adding in an ACL"
30508 .cindex "header lines" "position of added lines"
30509 .cindex "&%add_header%& ACL modifier"
30510 The &%add_header%& modifier can be used to add one or more extra header lines
30511 to an incoming message, as in this example:
30512 .code
30513 warn dnslists = sbl.spamhaus.org : \
30514                 dialup.mail-abuse.org
30515      add_header = X-blacklisted-at: $dnslist_domain
30516 .endd
30517 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30518 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30519 receiving a message). The message must ultimately be accepted for
30520 &%add_header%& to have any significant effect. You can use &%add_header%& with
30521 any ACL verb, including &%deny%& (though this is potentially useful only in a
30522 RCPT ACL).
30523
30524 Headers will not be added to the message if the modifier is used in
30525 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30526
30527 Leading and trailing newlines are removed from
30528 the data for the &%add_header%& modifier; if it then
30529 contains one or more newlines that
30530 are not followed by a space or a tab, it is assumed to contain multiple header
30531 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30532 front of any line that is not a valid header line.
30533
30534 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30535 They are added to the message before processing the DATA and MIME ACLs.
30536 However, if an identical header line is requested more than once, only one copy
30537 is actually added to the message. Further header lines may be accumulated
30538 during the DATA and MIME ACLs, after which they are added to the message, again
30539 with duplicates suppressed. Thus, it is possible to add two identical header
30540 lines to an SMTP message, but only if one is added before DATA and one after.
30541 In the case of non-SMTP messages, new headers are accumulated during the
30542 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30543 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30544 are included in the entry that is written to the reject log.
30545
30546 .cindex "header lines" "added; visibility of"
30547 Header lines are not visible in string expansions
30548 of message headers
30549 until they are added to the
30550 message. It follows that header lines defined in the MAIL, RCPT, and predata
30551 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30552 header lines that are added by the DATA or MIME ACLs are not visible in those
30553 ACLs. Because of this restriction, you cannot use header lines as a way of
30554 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30555 this, you can use ACL variables, as described in section
30556 &<<SECTaclvariables>>&.
30557
30558 The list of headers yet to be added is given by the &%$headers_added%& variable.
30559
30560 The &%add_header%& modifier acts immediately as it is encountered during the
30561 processing of an ACL. Notice the difference between these two cases:
30562 .display
30563 &`accept add_header = ADDED: some text`&
30564 &`       `&<&'some condition'&>
30565
30566 &`accept `&<&'some condition'&>
30567 &`       add_header = ADDED: some text`&
30568 .endd
30569 In the first case, the header line is always added, whether or not the
30570 condition is true. In the second case, the header line is added only if the
30571 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30572 ACL statement. All those that are encountered before a condition fails are
30573 honoured.
30574
30575 .cindex "&%warn%& ACL verb"
30576 For compatibility with previous versions of Exim, a &%message%& modifier for a
30577 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30578 effect only if all the conditions are true, even if it appears before some of
30579 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30580 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30581 are present on a &%warn%& verb, both are processed according to their
30582 specifications.
30583
30584 By default, new header lines are added to a message at the end of the existing
30585 header lines. However, you can specify that any particular header line should
30586 be added right at the start (before all the &'Received:'& lines), immediately
30587 after the first block of &'Received:'& lines, or immediately before any line
30588 that is not a &'Received:'& or &'Resent-something:'& header.
30589
30590 This is done by specifying &":at_start:"&, &":after_received:"&, or
30591 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30592 header line, respectively. (Header text cannot start with a colon, as there has
30593 to be a header name first.) For example:
30594 .code
30595 warn add_header = \
30596        :after_received:X-My-Header: something or other...
30597 .endd
30598 If more than one header line is supplied in a single &%add_header%& modifier,
30599 each one is treated independently and can therefore be placed differently. If
30600 you add more than one line at the start, or after the Received: block, they end
30601 up in reverse order.
30602
30603 &*Warning*&: This facility currently applies only to header lines that are
30604 added in an ACL. It does NOT work for header lines that are added in a
30605 system filter or in a router or transport.
30606
30607
30608
30609 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30610 .cindex "header lines" "removing in an ACL"
30611 .cindex "header lines" "position of removed lines"
30612 .cindex "&%remove_header%& ACL modifier"
30613 The &%remove_header%& modifier can be used to remove one or more header lines
30614 from an incoming message, as in this example:
30615 .code
30616 warn   message        = Remove internal headers
30617        remove_header  = x-route-mail1 : x-route-mail2
30618 .endd
30619 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30620 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30621 receiving a message). The message must ultimately be accepted for
30622 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30623 with any ACL verb, including &%deny%&, though this is really not useful for
30624 any verb that doesn't result in a delivered message.
30625
30626 Headers will not be removed from the message if the modifier is used in
30627 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30628
30629 More than one header can be removed at the same time by using a colon separated
30630 list of header names. The header matching is case insensitive. Wildcards are
30631 not permitted, nor is list expansion performed, so you cannot use hostlists to
30632 create a list of headers, however both connection and message variable expansion
30633 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30634 .code
30635 warn   hosts           = +internal_hosts
30636        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30637 warn   message         = Remove internal headers
30638        remove_header   = $acl_c_ihdrs
30639 .endd
30640 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30641 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30642 If multiple header lines match, all are removed.
30643 There is no harm in attempting to remove the same header twice nor in removing
30644 a non-existent header. Further header lines to be removed may be accumulated
30645 during the DATA and MIME ACLs, after which they are removed from the message,
30646 if present. In the case of non-SMTP messages, headers to be removed are
30647 accumulated during the non-SMTP ACLs, and are removed from the message after
30648 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30649 ACL, there really is no effect because there is no logging of what headers
30650 would have been removed.
30651
30652 .cindex "header lines" "removed; visibility of"
30653 Header lines are not visible in string expansions until the DATA phase when it
30654 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30655 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30656 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30657 this restriction, you cannot use header lines as a way of controlling data
30658 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30659 you should instead use ACL variables, as described in section
30660 &<<SECTaclvariables>>&.
30661
30662 The &%remove_header%& modifier acts immediately as it is encountered during the
30663 processing of an ACL. Notice the difference between these two cases:
30664 .display
30665 &`accept remove_header = X-Internal`&
30666 &`       `&<&'some condition'&>
30667
30668 &`accept `&<&'some condition'&>
30669 &`       remove_header = X-Internal`&
30670 .endd
30671 In the first case, the header line is always removed, whether or not the
30672 condition is true. In the second case, the header line is removed only if the
30673 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30674 same ACL statement. All those that are encountered before a condition fails
30675 are honoured.
30676
30677 &*Warning*&: This facility currently applies only to header lines that are
30678 present during ACL processing. It does NOT remove header lines that are added
30679 in a system filter or in a router or transport.
30680
30681
30682
30683
30684 .section "ACL conditions" "SECTaclconditions"
30685 .cindex "&ACL;" "conditions; list of"
30686 Some of the conditions listed in this section are available only when Exim is
30687 compiled with the content-scanning extension. They are included here briefly
30688 for completeness. More detailed descriptions can be found in the discussion on
30689 content scanning in chapter &<<CHAPexiscan>>&.
30690
30691 Not all conditions are relevant in all circumstances. For example, testing
30692 senders and recipients does not make sense in an ACL that is being run as the
30693 result of the arrival of an ETRN command, and checks on message headers can be
30694 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30695 can use the same condition (with different parameters) more than once in the
30696 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30697 The conditions are as follows:
30698
30699
30700 .vlist
30701 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30702 .cindex "&ACL;" "nested"
30703 .cindex "&ACL;" "indirect"
30704 .cindex "&ACL;" "arguments"
30705 .cindex "&%acl%& ACL condition"
30706 The possible values of the argument are the same as for the
30707 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30708 &"accept"& the condition is true; if it returns &"deny"& the condition is
30709 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30710 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30711 condition false. This means that further processing of the &%warn%& verb
30712 ceases, but processing of the ACL continues.
30713
30714 If the argument is a named ACL, up to nine space-separated optional values
30715 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30716 and $acl_narg is set to the count of values.
30717 Previous values of these variables are restored after the call returns.
30718 The name and values are expanded separately.
30719 Note that spaces in complex expansions which are used as arguments
30720 will act as argument separators.
30721
30722 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30723 the connection is dropped. If it returns &"discard"&, the verb must be
30724 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30725 conditions are tested.
30726
30727 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30728 loops. This condition allows you to use different ACLs in different
30729 circumstances. For example, different ACLs can be used to handle RCPT commands
30730 for different local users or different local domains.
30731
30732 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30733 .cindex "&%authenticated%& ACL condition"
30734 .cindex "authentication" "ACL checking"
30735 .cindex "&ACL;" "testing for authentication"
30736 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30737 the name of the authenticator is tested against the list. To test for
30738 authentication by any authenticator, you can set
30739 .code
30740 authenticated = *
30741 .endd
30742
30743 .vitem &*condition&~=&~*&<&'string'&>
30744 .cindex "&%condition%& ACL condition"
30745 .cindex "customizing" "ACL condition"
30746 .cindex "&ACL;" "customized test"
30747 .cindex "&ACL;" "testing, customized"
30748 This feature allows you to make up custom conditions. If the result of
30749 expanding the string is an empty string, the number zero, or one of the strings
30750 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30751 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30752 any other value, some error is assumed to have occurred, and the ACL returns
30753 &"defer"&. However, if the expansion is forced to fail, the condition is
30754 ignored. The effect is to treat it as true, whether it is positive or
30755 negative.
30756
30757 .vitem &*decode&~=&~*&<&'location'&>
30758 .cindex "&%decode%& ACL condition"
30759 This condition is available only when Exim is compiled with the
30760 content-scanning extension, and it is allowed only in the ACL defined by
30761 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30762 If all goes well, the condition is true. It is false only if there are
30763 problems such as a syntax error or a memory shortage. For more details, see
30764 chapter &<<CHAPexiscan>>&.
30765
30766 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30767 .cindex "&%dnslists%& ACL condition"
30768 .cindex "DNS list" "in ACL"
30769 .cindex "black list (DNS)"
30770 .cindex "&ACL;" "testing a DNS list"
30771 This condition checks for entries in DNS black lists. These are also known as
30772 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30773 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30774 different variants of this condition to describe briefly here. See sections
30775 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30776
30777 .vitem &*domains&~=&~*&<&'domain&~list'&>
30778 .cindex "&%domains%& ACL condition"
30779 .cindex "domain" "ACL checking"
30780 .cindex "&ACL;" "testing a recipient domain"
30781 .vindex "&$domain_data$&"
30782 This condition is relevant only after a RCPT command. It checks that the domain
30783 of the recipient address is in the domain list. If percent-hack processing is
30784 enabled, it is done before this test is done. If the check succeeds with a
30785 lookup, the result of the lookup is placed in &$domain_data$& until the next
30786 &%domains%& test.
30787
30788 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30789 use &%domains%& in a DATA ACL.
30790
30791
30792 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30793 .cindex "&%encrypted%& ACL condition"
30794 .cindex "encryption" "checking in an ACL"
30795 .cindex "&ACL;" "testing for encryption"
30796 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30797 name of the cipher suite in use is tested against the list. To test for
30798 encryption without testing for any specific cipher suite(s), set
30799 .code
30800 encrypted = *
30801 .endd
30802
30803
30804 .vitem &*hosts&~=&~*&<&'host&~list'&>
30805 .cindex "&%hosts%& ACL condition"
30806 .cindex "host" "ACL checking"
30807 .cindex "&ACL;" "testing the client host"
30808 This condition tests that the calling host matches the host list. If you have
30809 name lookups or wildcarded host names and IP addresses in the same host list,
30810 you should normally put the IP addresses first. For example, you could have:
30811 .code
30812 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30813 .endd
30814 The lookup in this example uses the host name for its key. This is implied by
30815 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30816 and it wouldn't matter which way round you had these two items.)
30817
30818 The reason for the problem with host names lies in the left-to-right way that
30819 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30820 but when it reaches an item that requires a host name, it fails if it cannot
30821 find a host name to compare with the pattern. If the above list is given in the
30822 opposite order, the &%accept%& statement fails for a host whose name cannot be
30823 found, even if its IP address is 10.9.8.7.
30824
30825 If you really do want to do the name check first, and still recognize the IP
30826 address even if the name lookup fails, you can rewrite the ACL like this:
30827 .code
30828 accept hosts = dbm;/etc/friendly/hosts
30829 accept hosts = 10.9.8.7
30830 .endd
30831 The default action on failing to find the host name is to assume that the host
30832 is not in the list, so the first &%accept%& statement fails. The second
30833 statement can then check the IP address.
30834
30835 .vindex "&$host_data$&"
30836 If a &%hosts%& condition is satisfied by means of a lookup, the result
30837 of the lookup is made available in the &$host_data$& variable. This
30838 allows you, for example, to set up a statement like this:
30839 .code
30840 deny  hosts = net-lsearch;/some/file
30841 message = $host_data
30842 .endd
30843 which gives a custom error message for each denied host.
30844
30845 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30846 .cindex "&%local_parts%& ACL condition"
30847 .cindex "local part" "ACL checking"
30848 .cindex "&ACL;" "testing a local part"
30849 .vindex "&$local_part_data$&"
30850 This condition is relevant only after a RCPT command. It checks that the local
30851 part of the recipient address is in the list. If percent-hack processing is
30852 enabled, it is done before this test. If the check succeeds with a lookup, the
30853 result of the lookup is placed in &$local_part_data$&, which remains set until
30854 the next &%local_parts%& test.
30855
30856 .vitem &*malware&~=&~*&<&'option'&>
30857 .cindex "&%malware%& ACL condition"
30858 .cindex "&ACL;" "virus scanning"
30859 .cindex "&ACL;" "scanning for viruses"
30860 This condition is available only when Exim is compiled with the
30861 content-scanning extension. It causes the incoming message to be scanned for
30862 viruses. For details, see chapter &<<CHAPexiscan>>&.
30863
30864 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30865 .cindex "&%mime_regex%& ACL condition"
30866 .cindex "&ACL;" "testing by regex matching"
30867 This condition is available only when Exim is compiled with the
30868 content-scanning extension, and it is allowed only in the ACL defined by
30869 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30870 with any of the regular expressions. For details, see chapter
30871 &<<CHAPexiscan>>&.
30872
30873 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30874 .cindex "rate limiting"
30875 This condition can be used to limit the rate at which a user or host submits
30876 messages. Details are given in section &<<SECTratelimiting>>&.
30877
30878 .vitem &*recipients&~=&~*&<&'address&~list'&>
30879 .cindex "&%recipients%& ACL condition"
30880 .cindex "recipient" "ACL checking"
30881 .cindex "&ACL;" "testing a recipient"
30882 This condition is relevant only after a RCPT command. It checks the entire
30883 recipient address against a list of recipients.
30884
30885 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30886 .cindex "&%regex%& ACL condition"
30887 .cindex "&ACL;" "testing by regex matching"
30888 This condition is available only when Exim is compiled with the
30889 content-scanning extension, and is available only in the DATA, MIME, and
30890 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30891 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30892
30893 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30894 .cindex "&%sender_domains%& ACL condition"
30895 .cindex "sender" "ACL checking"
30896 .cindex "&ACL;" "testing a sender domain"
30897 .vindex "&$domain$&"
30898 .vindex "&$sender_address_domain$&"
30899 This condition tests the domain of the sender of the message against the given
30900 domain list. &*Note*&: The domain of the sender address is in
30901 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30902 of this condition. This is an exception to the general rule for testing domain
30903 lists. It is done this way so that, if this condition is used in an ACL for a
30904 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30905 influence the sender checking.
30906
30907 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30908 relaying, because sender addresses are easily, and commonly, forged.
30909
30910 .vitem &*senders&~=&~*&<&'address&~list'&>
30911 .cindex "&%senders%& ACL condition"
30912 .cindex "sender" "ACL checking"
30913 .cindex "&ACL;" "testing a sender"
30914 This condition tests the sender of the message against the given list. To test
30915 for a bounce message, which has an empty sender, set
30916 .code
30917 senders = :
30918 .endd
30919 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30920 relaying, because sender addresses are easily, and commonly, forged.
30921
30922 .vitem &*spam&~=&~*&<&'username'&>
30923 .cindex "&%spam%& ACL condition"
30924 .cindex "&ACL;" "scanning for spam"
30925 This condition is available only when Exim is compiled with the
30926 content-scanning extension. It causes the incoming message to be scanned by
30927 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30928
30929 .vitem &*verify&~=&~certificate*&
30930 .cindex "&%verify%& ACL condition"
30931 .cindex "TLS" "client certificate verification"
30932 .cindex "certificate" "verification of client"
30933 .cindex "&ACL;" "certificate verification"
30934 .cindex "&ACL;" "testing a TLS certificate"
30935 This condition is true in an SMTP session if the session is encrypted, and a
30936 certificate was received from the client, and the certificate was verified. The
30937 server requests a certificate only if the client matches &%tls_verify_hosts%&
30938 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30939
30940 .vitem &*verify&~=&~csa*&
30941 .cindex "CSA verification"
30942 This condition checks whether the sending host (the client) is authorized to
30943 send email. Details of how this works are given in section
30944 &<<SECTverifyCSA>>&.
30945
30946 .vitem &*verify&~=&~header_names_ascii*&
30947 .cindex "&%verify%& ACL condition"
30948 .cindex "&ACL;" "verifying header names only ASCII"
30949 .cindex "header lines" "verifying header names only ASCII"
30950 .cindex "verifying" "header names only ASCII"
30951 This condition is relevant only in an ACL that is run after a message has been
30952 received, that is, in an ACL specified by &%acl_smtp_data%& or
30953 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30954 there are no non-ASCII characters, also excluding control characters.  The
30955 allowable characters are decimal ASCII values 33 through 126.
30956
30957 Exim itself will handle headers with non-ASCII characters, but it can cause
30958 problems for downstream applications, so this option will allow their
30959 detection and rejection in the DATA ACL's.
30960
30961 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30962 .cindex "&%verify%& ACL condition"
30963 .cindex "&ACL;" "verifying sender in the header"
30964 .cindex "header lines" "verifying the sender in"
30965 .cindex "sender" "verifying in header"
30966 .cindex "verifying" "sender in header"
30967 This condition is relevant only in an ACL that is run after a message has been
30968 received, that is, in an ACL specified by &%acl_smtp_data%& or
30969 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30970 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30971 is loosely thought of as a &"sender"& address (hence the name of the test).
30972 However, an address that appears in one of these headers need not be an address
30973 that accepts bounce messages; only sender addresses in envelopes are required
30974 to accept bounces. Therefore, if you use the callout option on this check, you
30975 might want to arrange for a non-empty address in the MAIL command.
30976
30977 Details of address verification and the options are given later, starting at
30978 section &<<SECTaddressverification>>& (callouts are described in section
30979 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30980 condition to restrict it to bounce messages only:
30981 .code
30982 deny    senders = :
30983         message = A valid sender header is required for bounces
30984        !verify  = header_sender
30985 .endd
30986
30987 .vitem &*verify&~=&~header_syntax*&
30988 .cindex "&%verify%& ACL condition"
30989 .cindex "&ACL;" "verifying header syntax"
30990 .cindex "header lines" "verifying syntax"
30991 .cindex "verifying" "header syntax"
30992 This condition is relevant only in an ACL that is run after a message has been
30993 received, that is, in an ACL specified by &%acl_smtp_data%& or
30994 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30995 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30996 and &'Bcc:'&), returning true if there are no problems.
30997 Unqualified addresses (local parts without domains) are
30998 permitted only in locally generated messages and from hosts that match
30999 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31000 appropriate.
31001
31002 Note that this condition is a syntax check only. However, a common spamming
31003 ploy used to be to send syntactically invalid headers such as
31004 .code
31005 To: @
31006 .endd
31007 and this condition can be used to reject such messages, though they are not as
31008 common as they used to be.
31009
31010 .vitem &*verify&~=&~helo*&
31011 .cindex "&%verify%& ACL condition"
31012 .cindex "&ACL;" "verifying HELO/EHLO"
31013 .cindex "HELO" "verifying"
31014 .cindex "EHLO" "verifying"
31015 .cindex "verifying" "EHLO"
31016 .cindex "verifying" "HELO"
31017 This condition is true if a HELO or EHLO command has been received from the
31018 client host, and its contents have been verified. If there has been no previous
31019 attempt to verify the HELO/EHLO contents, it is carried out when this
31020 condition is encountered. See the description of the &%helo_verify_hosts%& and
31021 &%helo_try_verify_hosts%& options for details of how to request verification
31022 independently of this condition, and for detail of the verification.
31023
31024 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31025 option), this condition is always true.
31026
31027
31028 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31029 .cindex "verifying" "not blind"
31030 .cindex "bcc recipients, verifying none"
31031 This condition checks that there are no blind (bcc) recipients in the message.
31032 Every envelope recipient must appear either in a &'To:'& header line or in a
31033 &'Cc:'& header line for this condition to be true. Local parts are checked
31034 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31035 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31036 used only in a DATA or non-SMTP ACL.
31037
31038 .new
31039 There is one possible option, &`case_insensitive`&.  If this is present then
31040 local parts are checked case-insensitively.
31041 .wen
31042
31043 There are, of course, many legitimate messages that make use of blind (bcc)
31044 recipients. This check should not be used on its own for blocking messages.
31045
31046
31047 .vitem &*verify&~=&~recipient/*&<&'options'&>
31048 .cindex "&%verify%& ACL condition"
31049 .cindex "&ACL;" "verifying recipient"
31050 .cindex "recipient" "verifying"
31051 .cindex "verifying" "recipient"
31052 .vindex "&$address_data$&"
31053 This condition is relevant only after a RCPT command. It verifies the current
31054 recipient. Details of address verification are given later, starting at section
31055 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31056 of &$address_data$& is the last value that was set while routing the address.
31057 This applies even if the verification fails. When an address that is being
31058 verified is redirected to a single address, verification continues with the new
31059 address, and in that case, the subsequent value of &$address_data$& is the
31060 value for the child address.
31061
31062 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31063 .cindex "&%verify%& ACL condition"
31064 .cindex "&ACL;" "verifying host reverse lookup"
31065 .cindex "host" "verifying reverse lookup"
31066 This condition ensures that a verified host name has been looked up from the IP
31067 address of the client host. (This may have happened already if the host name
31068 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31069 Verification ensures that the host name obtained from a reverse DNS lookup, or
31070 one of its aliases, does, when it is itself looked up in the DNS, yield the
31071 original IP address.
31072
31073 There is one possible option, &`defer_ok`&.  If this is present and a
31074 DNS operation returns a temporary error, the verify condition succeeds.
31075
31076 If this condition is used for a locally generated message (that is, when there
31077 is no client host involved), it always succeeds.
31078
31079 .vitem &*verify&~=&~sender/*&<&'options'&>
31080 .cindex "&%verify%& ACL condition"
31081 .cindex "&ACL;" "verifying sender"
31082 .cindex "sender" "verifying"
31083 .cindex "verifying" "sender"
31084 This condition is relevant only after a MAIL or RCPT command, or after a
31085 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31086 the message's sender is empty (that is, this is a bounce message), the
31087 condition is true. Otherwise, the sender address is verified.
31088
31089 .vindex "&$address_data$&"
31090 .vindex "&$sender_address_data$&"
31091 If there is data in the &$address_data$& variable at the end of routing, its
31092 value is placed in &$sender_address_data$& at the end of verification. This
31093 value can be used in subsequent conditions and modifiers in the same ACL
31094 statement. It does not persist after the end of the current statement. If you
31095 want to preserve the value for longer, you can save it in an ACL variable.
31096
31097 Details of verification are given later, starting at section
31098 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31099 to avoid doing it more than once per message.
31100
31101 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31102 .cindex "&%verify%& ACL condition"
31103 This is a variation of the previous option, in which a modified address is
31104 verified as a sender.
31105
31106 Note that '/' is legal in local-parts; if the address may have such
31107 (eg. is generated from the received message)
31108 they must be protected from the options parsing by doubling:
31109 .code
31110 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31111 .endd
31112 .endlist
31113
31114
31115
31116 .section "Using DNS lists" "SECTmorednslists"
31117 .cindex "DNS list" "in ACL"
31118 .cindex "black list (DNS)"
31119 .cindex "&ACL;" "testing a DNS list"
31120 In its simplest form, the &%dnslists%& condition tests whether the calling host
31121 is on at least one of a number of DNS lists by looking up the inverted IP
31122 address in one or more DNS domains. (Note that DNS list domains are not mail
31123 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31124 special options instead.) For example, if the calling host's IP
31125 address is 192.168.62.43, and the ACL statement is
31126 .code
31127 deny dnslists = blackholes.mail-abuse.org : \
31128                 dialups.mail-abuse.org
31129 .endd
31130 the following records are looked up:
31131 .code
31132 43.62.168.192.blackholes.mail-abuse.org
31133 43.62.168.192.dialups.mail-abuse.org
31134 .endd
31135 As soon as Exim finds an existing DNS record, processing of the list stops.
31136 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31137 to test that a host is on more than one list (an &"and"& conjunction), you can
31138 use two separate conditions:
31139 .code
31140 deny dnslists = blackholes.mail-abuse.org
31141      dnslists = dialups.mail-abuse.org
31142 .endd
31143 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31144 behaves as if the host does not match the list item, that is, as if the DNS
31145 record does not exist. If there are further items in the DNS list, they are
31146 processed.
31147
31148 This is usually the required action when &%dnslists%& is used with &%deny%&
31149 (which is the most common usage), because it prevents a DNS failure from
31150 blocking mail. However, you can change this behaviour by putting one of the
31151 following special items in the list:
31152 .display
31153 &`+include_unknown `&   behave as if the item is on the list
31154 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31155 &`+defer_unknown   `&   give a temporary error
31156 .endd
31157 .cindex "&`+include_unknown`&"
31158 .cindex "&`+exclude_unknown`&"
31159 .cindex "&`+defer_unknown`&"
31160 Each of these applies to any subsequent items on the list. For example:
31161 .code
31162 deny dnslists = +defer_unknown : foo.bar.example
31163 .endd
31164 Testing the list of domains stops as soon as a match is found. If you want to
31165 warn for one list and block for another, you can use two different statements:
31166 .code
31167 deny  dnslists = blackholes.mail-abuse.org
31168 warn  message  = X-Warn: sending host is on dialups list
31169       dnslists = dialups.mail-abuse.org
31170 .endd
31171 .cindex caching "of dns lookup"
31172 .cindex DNS TTL
31173 DNS list lookups are cached by Exim for the duration of the SMTP session
31174 (but limited by the DNS return TTL value),
31175 so a lookup based on the IP address is done at most once for any incoming
31176 connection (assuming long-enough TTL).
31177 Exim does not share information between multiple incoming
31178 connections (but your local name server cache should be active).
31179
31180 There are a number of DNS lists to choose from, some commercial, some free,
31181 or free for small deployments.  An overview can be found at
31182 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31183
31184
31185
31186 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31187 .cindex "DNS list" "keyed by explicit IP address"
31188 By default, the IP address that is used in a DNS list lookup is the IP address
31189 of the calling host. However, you can specify another IP address by listing it
31190 after the domain name, introduced by a slash. For example:
31191 .code
31192 deny dnslists = black.list.tld/192.168.1.2
31193 .endd
31194 This feature is not very helpful with explicit IP addresses; it is intended for
31195 use with IP addresses that are looked up, for example, the IP addresses of the
31196 MX hosts or nameservers of an email sender address. For an example, see section
31197 &<<SECTmulkeyfor>>& below.
31198
31199
31200
31201
31202 .section "DNS lists keyed on domain names" "SECID202"
31203 .cindex "DNS list" "keyed by domain name"
31204 There are some lists that are keyed on domain names rather than inverted IP
31205 addresses (see, e.g., the &'domain based zones'& link at
31206 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31207 with these lists. You can change the name that is looked up in a DNS list by
31208 listing it after the domain name, introduced by a slash. For example,
31209 .code
31210 deny  message  = Sender's domain is listed at $dnslist_domain
31211       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31212 .endd
31213 This particular example is useful only in ACLs that are obeyed after the
31214 RCPT or DATA commands, when a sender address is available. If (for
31215 example) the message's sender is &'user@tld.example'& the name that is looked
31216 up by this example is
31217 .code
31218 tld.example.dsn.rfc-ignorant.org
31219 .endd
31220 A single &%dnslists%& condition can contain entries for both names and IP
31221 addresses. For example:
31222 .code
31223 deny dnslists = sbl.spamhaus.org : \
31224                 dsn.rfc-ignorant.org/$sender_address_domain
31225 .endd
31226 The first item checks the sending host's IP address; the second checks a domain
31227 name. The whole condition is true if either of the DNS lookups succeeds.
31228
31229
31230
31231
31232 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31233 .cindex "DNS list" "multiple keys for"
31234 The syntax described above for looking up explicitly-defined values (either
31235 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31236 name for the DNS list, what follows the slash can in fact be a list of items.
31237 As with all lists in Exim, the default separator is a colon. However, because
31238 this is a sublist within the list of DNS blacklist domains, it is necessary
31239 either to double the separators like this:
31240 .code
31241 dnslists = black.list.tld/name.1::name.2
31242 .endd
31243 or to change the separator character, like this:
31244 .code
31245 dnslists = black.list.tld/<;name.1;name.2
31246 .endd
31247 If an item in the list is an IP address, it is inverted before the DNS
31248 blacklist domain is appended. If it is not an IP address, no inversion
31249 occurs. Consider this condition:
31250 .code
31251 dnslists = black.list.tld/<;192.168.1.2;a.domain
31252 .endd
31253 The DNS lookups that occur are:
31254 .code
31255 2.1.168.192.black.list.tld
31256 a.domain.black.list.tld
31257 .endd
31258 Once a DNS record has been found (that matches a specific IP return
31259 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31260 are done. If there is a temporary DNS error, the rest of the sublist of domains
31261 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31262 only if no other DNS lookup in this sublist succeeds. In other words, a
31263 successful lookup for any of the items in the sublist overrides a temporary
31264 error for a previous item.
31265
31266 The ability to supply a list of items after the slash is in some sense just a
31267 syntactic convenience. These two examples have the same effect:
31268 .code
31269 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31270 dnslists = black.list.tld/a.domain::b.domain
31271 .endd
31272 However, when the data for the list is obtained from a lookup, the second form
31273 is usually much more convenient. Consider this example:
31274 .code
31275 deny message  = The mail servers for the domain \
31276                 $sender_address_domain \
31277                 are listed at $dnslist_domain ($dnslist_value); \
31278                 see $dnslist_text.
31279      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31280                                    ${lookup dnsdb {>|mxh=\
31281                                    $sender_address_domain} }} }
31282 .endd
31283 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31284 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31285 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31286 of expanding the condition might be something like this:
31287 .code
31288 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31289 .endd
31290 Thus, this example checks whether or not the IP addresses of the sender
31291 domain's mail servers are on the Spamhaus black list.
31292
31293 The key that was used for a successful DNS list lookup is put into the variable
31294 &$dnslist_matched$& (see section &<<SECID204>>&).
31295
31296
31297
31298
31299 .section "Data returned by DNS lists" "SECID203"
31300 .cindex "DNS list" "data returned from"
31301 DNS lists are constructed using address records in the DNS. The original RBL
31302 just used the address 127.0.0.1 on the right hand side of each record, but the
31303 RBL+ list and some other lists use a number of values with different meanings.
31304 The values used on the RBL+ list are:
31305 .display
31306 127.1.0.1  RBL
31307 127.1.0.2  DUL
31308 127.1.0.3  DUL and RBL
31309 127.1.0.4  RSS
31310 127.1.0.5  RSS and RBL
31311 127.1.0.6  RSS and DUL
31312 127.1.0.7  RSS and DUL and RBL
31313 .endd
31314 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31315 different values. Some DNS lists may return more than one address record;
31316 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31317
31318
31319 .section "Variables set from DNS lists" "SECID204"
31320 .cindex "expansion" "variables, set from DNS list"
31321 .cindex "DNS list" "variables set from"
31322 .vindex "&$dnslist_domain$&"
31323 .vindex "&$dnslist_matched$&"
31324 .vindex "&$dnslist_text$&"
31325 .vindex "&$dnslist_value$&"
31326 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31327 the name of the overall domain that matched (for example,
31328 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31329 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31330 the DNS record. When the key is an IP address, it is not reversed in
31331 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31332 cases, for example:
31333 .code
31334 deny dnslists = spamhaus.example
31335 .endd
31336 the key is also available in another variable (in this case,
31337 &$sender_host_address$&). In more complicated cases, however, this is not true.
31338 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31339 might generate a dnslists lookup like this:
31340 .code
31341 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31342 .endd
31343 If this condition succeeds, the value in &$dnslist_matched$& might be
31344 &`192.168.6.7`& (for example).
31345
31346 If more than one address record is returned by the DNS lookup, all the IP
31347 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31348 The variable &$dnslist_text$& contains the contents of any associated TXT
31349 record. For lists such as RBL+ the TXT record for a merged entry is often not
31350 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31351 information.
31352
31353 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31354 &-- although these appear before the condition in the ACL, they are not
31355 expanded until after it has failed. For example:
31356 .code
31357 deny    hosts = !+local_networks
31358         message = $sender_host_address is listed \
31359                   at $dnslist_domain
31360         dnslists = rbl-plus.mail-abuse.example
31361 .endd
31362
31363
31364
31365 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31366 .cindex "DNS list" "matching specific returned data"
31367 You can add an equals sign and an IP address after a &%dnslists%& domain name
31368 in order to restrict its action to DNS records with a matching right hand side.
31369 For example,
31370 .code
31371 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31372 .endd
31373 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31374 any address record is considered to be a match. For the moment, we assume
31375 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31376 describes how multiple records are handled.
31377
31378 More than one IP address may be given for checking, using a comma as a
31379 separator. These are alternatives &-- if any one of them matches, the
31380 &%dnslists%& condition is true. For example:
31381 .code
31382 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31383 .endd
31384 If you want to specify a constraining address list and also specify names or IP
31385 addresses to be looked up, the constraining address list must be specified
31386 first. For example:
31387 .code
31388 deny dnslists = dsn.rfc-ignorant.org\
31389                 =127.0.0.2/$sender_address_domain
31390 .endd
31391
31392 If the character &`&&`& is used instead of &`=`&, the comparison for each
31393 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31394 In other words, the listed addresses are used as bit masks. The comparison is
31395 true if all the bits in the mask are present in the address that is being
31396 tested. For example:
31397 .code
31398 dnslists = a.b.c&0.0.0.3
31399 .endd
31400 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31401 want to test whether one bit or another bit is present (as opposed to both
31402 being present), you must use multiple values. For example:
31403 .code
31404 dnslists = a.b.c&0.0.0.1,0.0.0.2
31405 .endd
31406 matches if the final component of the address is an odd number or two times
31407 an odd number.
31408
31409
31410
31411 .section "Negated DNS matching conditions" "SECID205"
31412 You can supply a negative list of IP addresses as part of a &%dnslists%&
31413 condition. Whereas
31414 .code
31415 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31416 .endd
31417 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31418 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31419 .code
31420 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31421 .endd
31422 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31423 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31424 words, the result of the test is inverted if an exclamation mark appears before
31425 the &`=`& (or the &`&&`&) sign.
31426
31427 &*Note*&: This kind of negation is not the same as negation in a domain,
31428 host, or address list (which is why the syntax is different).
31429
31430 If you are using just one list, the negation syntax does not gain you much. The
31431 previous example is precisely equivalent to
31432 .code
31433 deny  dnslists = a.b.c
31434      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31435 .endd
31436 However, if you are using multiple lists, the negation syntax is clearer.
31437 Consider this example:
31438 .code
31439 deny  dnslists = sbl.spamhaus.org : \
31440                  list.dsbl.org : \
31441                  dnsbl.njabl.org!=127.0.0.3 : \
31442                  relays.ordb.org
31443 .endd
31444 Using only positive lists, this would have to be:
31445 .code
31446 deny  dnslists = sbl.spamhaus.org : \
31447                  list.dsbl.org
31448 deny  dnslists = dnsbl.njabl.org
31449      !dnslists = dnsbl.njabl.org=127.0.0.3
31450 deny  dnslists = relays.ordb.org
31451 .endd
31452 which is less clear, and harder to maintain.
31453
31454
31455
31456
31457 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31458 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31459 thereby providing more than one IP address. When an item in a &%dnslists%& list
31460 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31461 the match to specific results from the DNS lookup, there are two ways in which
31462 the checking can be handled. For example, consider the condition:
31463 .code
31464 dnslists = a.b.c=127.0.0.1
31465 .endd
31466 What happens if the DNS lookup for the incoming IP address yields both
31467 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31468 condition true because at least one given value was found, or is it false
31469 because at least one of the found values was not listed? And how does this
31470 affect negated conditions? Both possibilities are provided for with the help of
31471 additional separators &`==`& and &`=&&`&.
31472
31473 .ilist
31474 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31475 IP addresses matches one of the listed addresses. For the example above, the
31476 condition is true because 127.0.0.1 matches.
31477 .next
31478 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31479 looked up IP addresses matches one of the listed addresses. If the condition is
31480 changed to:
31481 .code
31482 dnslists = a.b.c==127.0.0.1
31483 .endd
31484 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31485 false because 127.0.0.2 is not listed. You would need to have:
31486 .code
31487 dnslists = a.b.c==127.0.0.1,127.0.0.2
31488 .endd
31489 for the condition to be true.
31490 .endlist
31491
31492 When &`!`& is used to negate IP address matching, it inverts the result, giving
31493 the precise opposite of the behaviour above. Thus:
31494 .ilist
31495 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31496 addresses matches one of the listed addresses. Consider:
31497 .code
31498 dnslists = a.b.c!&0.0.0.1
31499 .endd
31500 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31501 false because 127.0.0.1 matches.
31502 .next
31503 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31504 looked up IP address that does not match. Consider:
31505 .code
31506 dnslists = a.b.c!=&0.0.0.1
31507 .endd
31508 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31509 true, because 127.0.0.2 does not match. You would need to have:
31510 .code
31511 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31512 .endd
31513 for the condition to be false.
31514 .endlist
31515 When the DNS lookup yields only a single IP address, there is no difference
31516 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31517
31518
31519
31520
31521 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31522 .cindex "DNS list" "information from merged"
31523 When the facility for restricting the matching IP values in a DNS list is used,
31524 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31525 the true reason for rejection. This happens when lists are merged and the IP
31526 address in the A record is used to distinguish them; unfortunately there is
31527 only one TXT record. One way round this is not to use merged lists, but that
31528 can be inefficient because it requires multiple DNS lookups where one would do
31529 in the vast majority of cases when the host of interest is not on any of the
31530 lists.
31531
31532 A less inefficient way of solving this problem is available. If
31533 two domain names, comma-separated, are given, the second is used first to
31534 do an initial check, making use of any IP value restrictions that are set.
31535 If there is a match, the first domain is used, without any IP value
31536 restrictions, to get the TXT record. As a byproduct of this, there is also
31537 a check that the IP being tested is indeed on the first list. The first
31538 domain is the one that is put in &$dnslist_domain$&. For example:
31539 .code
31540 deny message  = \
31541          rejected because $sender_host_address is blacklisted \
31542          at $dnslist_domain\n$dnslist_text
31543        dnslists = \
31544          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31545          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31546 .endd
31547 For the first blacklist item, this starts by doing a lookup in
31548 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31549 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31550 value, and as long as something is found, it looks for the corresponding TXT
31551 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31552 The second blacklist item is processed similarly.
31553
31554 If you are interested in more than one merged list, the same list must be
31555 given several times, but because the results of the DNS lookups are cached,
31556 the DNS calls themselves are not repeated. For example:
31557 .code
31558 deny dnslists = \
31559          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31560          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31561          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31562          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31563 .endd
31564 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31565 values matches (or if no record is found), this is the only lookup that is
31566 done. Only if there is a match is one of the more specific lists consulted.
31567
31568
31569
31570 .section "DNS lists and IPv6" "SECTmorednslistslast"
31571 .cindex "IPv6" "DNS black lists"
31572 .cindex "DNS list" "IPv6 usage"
31573 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31574 nibble by nibble. For example, if the calling host's IP address is
31575 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31576 .code
31577 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31578   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31579 .endd
31580 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31581 lists contain wildcard records, intended for IPv4, that interact badly with
31582 IPv6. For example, the DNS entry
31583 .code
31584 *.3.some.list.example.    A    127.0.0.1
31585 .endd
31586 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31587 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31588
31589 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31590 &%condition%& condition, as in this example:
31591 .code
31592 deny   condition = ${if isip4{$sender_host_address}}
31593        dnslists  = some.list.example
31594 .endd
31595
31596 If an explicit key is being used for a DNS lookup and it may be an IPv6
31597 address you should specify alternate list separators for both the outer
31598 (DNS list name) list and inner (lookup keys) list:
31599 .code
31600        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31601 .endd
31602
31603 .section "Rate limiting incoming messages" "SECTratelimiting"
31604 .cindex "rate limiting" "client sending"
31605 .cindex "limiting client sending rates"
31606 .oindex "&%smtp_ratelimit_*%&"
31607 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31608 which clients can send email. This is more powerful than the
31609 &%smtp_ratelimit_*%& options, because those options control the rate of
31610 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31611 works across all connections (concurrent and sequential) from the same client
31612 host. The syntax of the &%ratelimit%& condition is:
31613 .display
31614 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31615 .endd
31616 If the average client sending rate is less than &'m'& messages per time
31617 period &'p'& then the condition is false; otherwise it is true.
31618
31619 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31620 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31621 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31622 of &'p'&.
31623
31624 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31625 time interval, for example, &`8h`& for eight hours. A larger time constant
31626 means that it takes Exim longer to forget a client's past behaviour. The
31627 parameter &'m'& is the maximum number of messages that a client is permitted to
31628 send in each time interval. It also specifies the number of messages permitted
31629 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31630 constant, you can allow a client to send more messages in a burst without
31631 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31632 both small, messages must be sent at an even rate.
31633
31634 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31635 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31636 when deploying the &%ratelimit%& ACL condition. The script prints usage
31637 instructions when it is run with no arguments.
31638
31639 The key is used to look up the data for calculating the client's average
31640 sending rate. This data is stored in Exim's spool directory, alongside the
31641 retry and other hints databases. The default key is &$sender_host_address$&,
31642 which means Exim computes the sending rate of each client host IP address.
31643 By changing the key you can change how Exim identifies clients for the purpose
31644 of ratelimiting. For example, to limit the sending rate of each authenticated
31645 user, independent of the computer they are sending from, set the key to
31646 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31647 example, &$authenticated_id$& is only meaningful if the client has
31648 authenticated (which you can check with the &%authenticated%& ACL condition).
31649
31650 The lookup key does not have to identify clients: If you want to limit the
31651 rate at which a recipient receives messages, you can use the key
31652 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31653 ACL.
31654
31655 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31656 specifies what Exim measures the rate of, for example, messages or recipients
31657 or bytes. You can adjust the measurement using the &%unique=%& and/or
31658 &%count=%& options. You can also control when Exim updates the recorded rate
31659 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31660 separated by a slash, like the other parameters. They may appear in any order.
31661
31662 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31663 any options that alter the meaning of the stored data. The limit &'m'& is not
31664 stored, so you can alter the configured maximum rate and Exim will still
31665 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31666 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31667 behaviour. The lookup key is not affected by changes to the update mode and
31668 the &%count=%& option.
31669
31670
31671 .section "Ratelimit options for what is being measured" "ratoptmea"
31672 .cindex "rate limiting" "per_* options"
31673 The &%per_conn%& option limits the client's connection rate. It is not
31674 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31675 &%acl_not_smtp_start%& ACLs.
31676
31677 The &%per_mail%& option limits the client's rate of sending messages. This is
31678 the default if none of the &%per_*%& options is specified. It can be used in
31679 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31680 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31681
31682 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31683 the same ACLs as the &%per_mail%& option, though it is best to use this option
31684 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31685 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31686 in its MAIL command, which may be inaccurate or completely missing. You can
31687 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31688 in kilobytes, megabytes, or gigabytes, respectively.
31689
31690 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31691 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31692 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31693 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31694 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31695 in either case the rate limiting engine will see a message with many
31696 recipients as a large high-speed burst.
31697
31698 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31699 number of different recipients that the client has sent messages to in the
31700 last time period. That is, if the client repeatedly sends messages to the same
31701 recipient, its measured rate is not increased. This option can only be used in
31702 &%acl_smtp_rcpt%&.
31703
31704 The &%per_cmd%& option causes Exim to recompute the rate every time the
31705 condition is processed. This can be used to limit the rate of any SMTP
31706 command. If it is used in multiple ACLs it can limit the aggregate rate of
31707 multiple different commands.
31708
31709 The &%count=%& option can be used to alter how much Exim adds to the client's
31710 measured rate. For example, the &%per_byte%& option is equivalent to
31711 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31712 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31713 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31714
31715 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31716
31717
31718 .section "Ratelimit update modes" "ratoptupd"
31719 .cindex "rate limiting" "reading data without updating"
31720 You can specify one of three options with the &%ratelimit%& condition to
31721 control when its database is updated. This section describes the &%readonly%&
31722 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31723
31724 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31725 previously-computed rate to check against the limit.
31726
31727 For example, you can test the client's sending rate and deny it access (when
31728 it is too fast) in the connect ACL. If the client passes this check then it
31729 can go on to send a message, in which case its recorded rate will be updated
31730 in the MAIL ACL. Subsequent connections from the same client will check this
31731 new rate.
31732 .code
31733 acl_check_connect:
31734  deny ratelimit = 100 / 5m / readonly
31735     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31736                   (max $sender_rate_limit)
31737 # ...
31738 acl_check_mail:
31739  warn ratelimit = 100 / 5m / strict
31740     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31741                   (max $sender_rate_limit)
31742 .endd
31743
31744 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31745 processing a message then it may increase the client's measured rate more than
31746 it should. For example, this will happen if you check the &%per_rcpt%& option
31747 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31748 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31749 multiple update problems by using the &%readonly%& option on later ratelimit
31750 checks.
31751
31752 The &%per_*%& options described above do not make sense in some ACLs. If you
31753 use a &%per_*%& option in an ACL where it is not normally permitted then the
31754 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31755 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31756 next section) so you must specify the &%readonly%& option explicitly.
31757
31758
31759 .section "Ratelimit options for handling fast clients" "ratoptfast"
31760 .cindex "rate limiting" "strict and leaky modes"
31761 If a client's average rate is greater than the maximum, the rate limiting
31762 engine can react in two possible ways, depending on the presence of the
31763 &%strict%& or &%leaky%& update modes. This is independent of the other
31764 counter-measures (such as rejecting the message) that may be specified by the
31765 rest of the ACL.
31766
31767 The &%leaky%& (default) option means that the client's recorded rate is not
31768 updated if it is above the limit. The effect of this is that Exim measures the
31769 client's average rate of successfully sent email,
31770 up to the given limit.
31771 This is appropriate if the countermeasure when the condition is true
31772 consists of refusing the message, and
31773 is generally the better choice if you have clients that retry automatically.
31774 If the action when true is anything more complex then this option is
31775 likely not what is wanted.
31776
31777 The &%strict%& option means that the client's recorded rate is always
31778 updated. The effect of this is that Exim measures the client's average rate
31779 of attempts to send email, which can be much higher than the maximum it is
31780 actually allowed. If the client is over the limit it may be subjected to
31781 counter-measures by the ACL. It must slow down and allow sufficient time to
31782 pass that its computed rate falls below the maximum before it can send email
31783 again. The time (the number of smoothing periods) it must wait and not
31784 attempt to send mail can be calculated with this formula:
31785 .code
31786         ln(peakrate/maxrate)
31787 .endd
31788
31789
31790 .section "Limiting the rate of different events" "ratoptuniq"
31791 .cindex "rate limiting" "counting unique events"
31792 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31793 rate of different events. For example, the &%per_addr%& option uses this
31794 mechanism to count the number of different recipients that the client has
31795 sent messages to in the last time period; it is equivalent to
31796 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31797 measure the rate that a client uses different sender addresses with the
31798 options &`per_mail/unique=$sender_address`&.
31799
31800 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31801 has seen for that key. The whole set is thrown away when it is older than the
31802 rate smoothing period &'p'&, so each different event is counted at most once
31803 per period. In the &%leaky%& update mode, an event that causes the client to
31804 go over the limit is not added to the set, in the same way that the client's
31805 recorded rate is not updated in the same situation.
31806
31807 When you combine the &%unique=%& and &%readonly%& options, the specific
31808 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31809 rate.
31810
31811 The &%unique=%& mechanism needs more space in the ratelimit database than the
31812 other &%ratelimit%& options in order to store the event set. The number of
31813 unique values is potentially as large as the rate limit, so the extra space
31814 required increases with larger limits.
31815
31816 The uniqueification is not perfect: there is a small probability that Exim
31817 will think a new event has happened before. If the sender's rate is less than
31818 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31819 the measured rate can go above the limit, in which case Exim may under-count
31820 events by a significant margin. Fortunately, if the rate is high enough (2.7
31821 times the limit) that the false positive rate goes above 9%, then Exim will
31822 throw away the over-full event set before the measured rate falls below the
31823 limit. Therefore the only harm should be that exceptionally high sending rates
31824 are logged incorrectly; any countermeasures you configure will be as effective
31825 as intended.
31826
31827
31828 .section "Using rate limiting" "useratlim"
31829 Exim's other ACL facilities are used to define what counter-measures are taken
31830 when the rate limit is exceeded. This might be anything from logging a warning
31831 (for example, while measuring existing sending rates in order to define
31832 policy), through time delays to slow down fast senders, up to rejecting the
31833 message. For example:
31834 .code
31835 # Log all senders' rates
31836 warn ratelimit = 0 / 1h / strict
31837      log_message = Sender rate $sender_rate / $sender_rate_period
31838
31839 # Slow down fast senders; note the need to truncate $sender_rate
31840 # at the decimal point.
31841 warn ratelimit = 100 / 1h / per_rcpt / strict
31842      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31843                    $sender_rate_limit }s
31844
31845 # Keep authenticated users under control
31846 deny authenticated = *
31847      ratelimit = 100 / 1d / strict / $authenticated_id
31848
31849 # System-wide rate limit
31850 defer message = Sorry, too busy. Try again later.
31851      ratelimit = 10 / 1s / $primary_hostname
31852
31853 # Restrict incoming rate from each host, with a default
31854 # set using a macro and special cases looked up in a table.
31855 defer message = Sender rate exceeds $sender_rate_limit \
31856                messages per $sender_rate_period
31857      ratelimit = ${lookup {$sender_host_address} \
31858                    cdb {DB/ratelimits.cdb} \
31859                    {$value} {RATELIMIT} }
31860 .endd
31861 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31862 especially with the &%per_rcpt%& option, you may suffer from a performance
31863 bottleneck caused by locking on the ratelimit hints database. Apart from
31864 making your ACLs less complicated, you can reduce the problem by using a
31865 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31866 this means that Exim will lose its hints data after a reboot (including retry
31867 hints, the callout cache, and ratelimit data).
31868
31869
31870
31871 .section "Address verification" "SECTaddressverification"
31872 .cindex "verifying address" "options for"
31873 .cindex "policy control" "address verification"
31874 Several of the &%verify%& conditions described in section
31875 &<<SECTaclconditions>>& cause addresses to be verified. Section
31876 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31877 The verification conditions can be followed by options that modify the
31878 verification process. The options are separated from the keyword and from each
31879 other by slashes, and some of them contain parameters. For example:
31880 .code
31881 verify = sender/callout
31882 verify = recipient/defer_ok/callout=10s,defer_ok
31883 .endd
31884 The first stage of address verification, which always happens, is to run the
31885 address through the routers, in &"verify mode"&. Routers can detect the
31886 difference between verification and routing for delivery, and their actions can
31887 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31888 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31889 The available options are as follows:
31890
31891 .ilist
31892 If the &%callout%& option is specified, successful routing to one or more
31893 remote hosts is followed by a &"callout"& to those hosts as an additional
31894 check. Callouts and their sub-options are discussed in the next section.
31895 .next
31896 If there is a defer error while doing verification routing, the ACL
31897 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31898 options, the condition is forced to be true instead. Note that this is a main
31899 verification option as well as a suboption for callouts.
31900 .next
31901 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31902 discusses the reporting of sender address verification failures.
31903 .next
31904 The &%success_on_redirect%& option causes verification always to succeed
31905 immediately after a successful redirection. By default, if a redirection
31906 generates just one address, that address is also verified. See further
31907 discussion in section &<<SECTredirwhilveri>>&.
31908 .endlist
31909
31910 .cindex "verifying address" "differentiating failures"
31911 .vindex "&$recipient_verify_failure$&"
31912 .vindex "&$sender_verify_failure$&"
31913 .vindex "&$acl_verify_message$&"
31914 After an address verification failure, &$acl_verify_message$& contains the
31915 error message that is associated with the failure. It can be preserved by
31916 coding like this:
31917 .code
31918 warn  !verify = sender
31919        set acl_m0 = $acl_verify_message
31920 .endd
31921 If you are writing your own custom rejection message or log message when
31922 denying access, you can use this variable to include information about the
31923 verification failure.
31924
31925 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31926 appropriate) contains one of the following words:
31927
31928 .ilist
31929 &%qualify%&: The address was unqualified (no domain), and the message
31930 was neither local nor came from an exempted host.
31931 .next
31932 &%route%&: Routing failed.
31933 .next
31934 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31935 occurred at or before the MAIL command (that is, on initial
31936 connection, HELO, or MAIL).
31937 .next
31938 &%recipient%&: The RCPT command in a callout was rejected.
31939 .next
31940 &%postmaster%&: The postmaster check in a callout was rejected.
31941 .endlist
31942
31943 The main use of these variables is expected to be to distinguish between
31944 rejections of MAIL and rejections of RCPT in callouts.
31945
31946 The above variables may also be set after a &*successful*&
31947 address verification to:
31948
31949 .ilist
31950 &%random%&: A random local-part callout succeeded
31951 .endlist
31952
31953
31954
31955
31956 .section "Callout verification" "SECTcallver"
31957 .cindex "verifying address" "by callout"
31958 .cindex "callout" "verification"
31959 .cindex "SMTP" "callout verification"
31960 For non-local addresses, routing verifies the domain, but is unable to do any
31961 checking of the local part. There are situations where some means of verifying
31962 the local part is desirable. One way this can be done is to make an SMTP
31963 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31964 a subsequent host for a recipient address, to see if the host accepts the
31965 address. We use the term &'callout'& to cover both cases. Note that for a
31966 sender address, the callback is not to the client host that is trying to
31967 deliver the message, but to one of the hosts that accepts incoming mail for the
31968 sender's domain.
31969
31970 Exim does not do callouts by default. If you want them to happen, you must
31971 request them by setting appropriate options on the &%verify%& condition, as
31972 described below. This facility should be used with care, because it can add a
31973 lot of resource usage to the cost of verifying an address. However, Exim does
31974 cache the results of callouts, which helps to reduce the cost. Details of
31975 caching are in section &<<SECTcallvercache>>&.
31976
31977 Recipient callouts are usually used only between hosts that are controlled by
31978 the same administration. For example, a corporate gateway host could use
31979 callouts to check for valid recipients on an internal mailserver. A successful
31980 callout does not guarantee that a real delivery to the address would succeed;
31981 on the other hand, a failing callout does guarantee that a delivery would fail.
31982
31983 If the &%callout%& option is present on a condition that verifies an address, a
31984 second stage of verification occurs if the address is successfully routed to
31985 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31986 &(manualroute)& router, where the router specifies the hosts. However, if a
31987 router that does not set up hosts routes to an &(smtp)& transport with a
31988 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31989 &%hosts_override%& set, its hosts are always used, whether or not the router
31990 supplies a host list.
31991 Callouts are only supported on &(smtp)& transports.
31992
31993 The port that is used is taken from the transport, if it is specified and is a
31994 remote transport. (For routers that do verification only, no transport need be
31995 specified.) Otherwise, the default SMTP port is used. If a remote transport
31996 specifies an outgoing interface, this is used; otherwise the interface is not
31997 specified. Likewise, the text that is used for the HELO command is taken from
31998 the transport's &%helo_data%& option; if there is no transport, the value of
31999 &$smtp_active_hostname$& is used.
32000
32001 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32002 test whether a bounce message could be delivered to the sender address. The
32003 following SMTP commands are sent:
32004 .display
32005 &`HELO `&<&'local host name'&>
32006 &`MAIL FROM:<>`&
32007 &`RCPT TO:`&<&'the address to be tested'&>
32008 &`QUIT`&
32009 .endd
32010 LHLO is used instead of HELO if the transport's &%protocol%& option is
32011 set to &"lmtp"&.
32012
32013 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32014 settings.
32015
32016 A recipient callout check is similar. By default, it also uses an empty address
32017 for the sender. This default is chosen because most hosts do not make use of
32018 the sender address when verifying a recipient. Using the same address means
32019 that a single cache entry can be used for each recipient. Some sites, however,
32020 do make use of the sender address when verifying. These are catered for by the
32021 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32022
32023 If the response to the RCPT command is a 2&'xx'& code, the verification
32024 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32025 Exim tries the next host, if any. If there is a problem with all the remote
32026 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32027 &%callout%& option is given, in which case the condition is forced to succeed.
32028
32029 .cindex "SMTP" "output flushing, disabling for callout"
32030 A callout may take a little time. For this reason, Exim normally flushes SMTP
32031 output before performing a callout in an ACL, to avoid unexpected timeouts in
32032 clients when the SMTP PIPELINING extension is in use. The flushing can be
32033 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32034
32035
32036
32037
32038 .section "Additional parameters for callouts" "CALLaddparcall"
32039 .cindex "callout" "additional parameters for"
32040 The &%callout%& option can be followed by an equals sign and a number of
32041 optional parameters, separated by commas. For example:
32042 .code
32043 verify = recipient/callout=10s,defer_ok
32044 .endd
32045 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32046 separate verify options, is retained for backwards compatibility, but is now
32047 deprecated. The additional parameters for &%callout%& are as follows:
32048
32049
32050 .vlist
32051 .vitem <&'a&~time&~interval'&>
32052 .cindex "callout" "timeout, specifying"
32053 This specifies the timeout that applies for the callout attempt to each host.
32054 For example:
32055 .code
32056 verify = sender/callout=5s
32057 .endd
32058 The default is 30 seconds. The timeout is used for each response from the
32059 remote host. It is also used for the initial connection, unless overridden by
32060 the &%connect%& parameter.
32061
32062
32063 .vitem &*connect&~=&~*&<&'time&~interval'&>
32064 .cindex "callout" "connection timeout, specifying"
32065 This parameter makes it possible to set a different (usually smaller) timeout
32066 for making the SMTP connection. For example:
32067 .code
32068 verify = sender/callout=5s,connect=1s
32069 .endd
32070 If not specified, this timeout defaults to the general timeout value.
32071
32072 .vitem &*defer_ok*&
32073 .cindex "callout" "defer, action on"
32074 When this parameter is present, failure to contact any host, or any other kind
32075 of temporary error, is treated as success by the ACL. However, the cache is not
32076 updated in this circumstance.
32077
32078 .vitem &*fullpostmaster*&
32079 .cindex "callout" "full postmaster check"
32080 This operates like the &%postmaster%& option (see below), but if the check for
32081 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32082 accordance with the specification in RFC 2821. The RFC states that the
32083 unqualified address &'postmaster'& should be accepted.
32084
32085
32086 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32087 .cindex "callout" "sender when verifying header"
32088 When verifying addresses in header lines using the &%header_sender%&
32089 verification option, Exim behaves by default as if the addresses are envelope
32090 sender addresses from a message. Callout verification therefore tests to see
32091 whether a bounce message could be delivered, by using an empty address in the
32092 MAIL command. However, it is arguable that these addresses might never be used
32093 as envelope senders, and could therefore justifiably reject bounce messages
32094 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32095 address to use in the MAIL command. For example:
32096 .code
32097 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32098 .endd
32099 This parameter is available only for the &%header_sender%& verification option.
32100
32101
32102 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32103 .cindex "callout" "overall timeout, specifying"
32104 This parameter sets an overall timeout for performing a callout verification.
32105 For example:
32106 .code
32107 verify = sender/callout=5s,maxwait=30s
32108 .endd
32109 This timeout defaults to four times the callout timeout for individual SMTP
32110 commands. The overall timeout applies when there is more than one host that can
32111 be tried. The timeout is checked before trying the next host. This prevents
32112 very long delays if there are a large number of hosts and all are timing out
32113 (for example, when network connections are timing out).
32114
32115
32116 .vitem &*no_cache*&
32117 .cindex "callout" "cache, suppressing"
32118 .cindex "caching callout, suppressing"
32119 When this parameter is given, the callout cache is neither read nor updated.
32120
32121 .vitem &*postmaster*&
32122 .cindex "callout" "postmaster; checking"
32123 When this parameter is set, a successful callout check is followed by a similar
32124 check for the local part &'postmaster'& at the same domain. If this address is
32125 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32126 the postmaster check is recorded in a cache record; if it is a failure, this is
32127 used to fail subsequent callouts for the domain without a connection being
32128 made, until the cache record expires.
32129
32130 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32131 The postmaster check uses an empty sender in the MAIL command by default.
32132 You can use this parameter to do a postmaster check using a different address.
32133 For example:
32134 .code
32135 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32136 .endd
32137 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32138 one overrides. The &%postmaster%& parameter is equivalent to this example:
32139 .code
32140 require  verify = sender/callout=postmaster_mailfrom=
32141 .endd
32142 &*Warning*&: The caching arrangements for postmaster checking do not take
32143 account of the sender address. It is assumed that either the empty address or
32144 a fixed non-empty address will be used. All that Exim remembers is that the
32145 postmaster check for the domain succeeded or failed.
32146
32147
32148 .vitem &*random*&
32149 .cindex "callout" "&""random""& check"
32150 When this parameter is set, before doing the normal callout check, Exim does a
32151 check for a &"random"& local part at the same domain. The local part is not
32152 really random &-- it is defined by the expansion of the option
32153 &%callout_random_local_part%&, which defaults to
32154 .code
32155 $primary_hostname-$tod_epoch-testing
32156 .endd
32157 The idea here is to try to determine whether the remote host accepts all local
32158 parts without checking. If it does, there is no point in doing callouts for
32159 specific local parts. If the &"random"& check succeeds, the result is saved in
32160 a cache record, and used to force the current and subsequent callout checks to
32161 succeed without a connection being made, until the cache record expires.
32162
32163 .vitem &*use_postmaster*&
32164 .cindex "callout" "sender for recipient check"
32165 This parameter applies to recipient callouts only. For example:
32166 .code
32167 deny  !verify = recipient/callout=use_postmaster
32168 .endd
32169 .vindex "&$qualify_domain$&"
32170 It causes a non-empty postmaster address to be used in the MAIL command when
32171 performing the callout for the recipient, and also for a &"random"& check if
32172 that is configured. The local part of the address is &`postmaster`& and the
32173 domain is the contents of &$qualify_domain$&.
32174
32175 .vitem &*use_sender*&
32176 This option applies to recipient callouts only. For example:
32177 .code
32178 require  verify = recipient/callout=use_sender
32179 .endd
32180 It causes the message's actual sender address to be used in the MAIL
32181 command when performing the callout, instead of an empty address. There is no
32182 need to use this option unless you know that the called hosts make use of the
32183 sender when checking recipients. If used indiscriminately, it reduces the
32184 usefulness of callout caching.
32185
32186 .vitem &*hold*&
32187 This option applies to recipient callouts only. For example:
32188 .code
32189 require  verify = recipient/callout=use_sender,hold
32190 .endd
32191 It causes the connection to be held open and used for any further recipients
32192 and for eventual delivery (should that be done quickly).
32193 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32194 when that is used for the connections.
32195 The advantage is only gained if there are no callout cache hits
32196 (which could be enforced by the no_cache option),
32197 if the use_sender option is used,
32198 if neither the random nor the use_postmaster option is used,
32199 and if no other callouts intervene.
32200 .endlist
32201
32202 If you use any of the parameters that set a non-empty sender for the MAIL
32203 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32204 &%use_sender%&), you should think about possible loops. Recipient checking is
32205 usually done between two hosts that are under the same management, and the host
32206 that receives the callouts is not normally configured to do callouts itself.
32207 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32208 these circumstances.
32209
32210 However, if you use a non-empty sender address for a callout to an arbitrary
32211 host, there is the likelihood that the remote host will itself initiate a
32212 callout check back to your host. As it is checking what appears to be a message
32213 sender, it is likely to use an empty address in MAIL, thus avoiding a
32214 callout loop. However, to be on the safe side it would be best to set up your
32215 own ACLs so that they do not do sender verification checks when the recipient
32216 is the address you use for header sender or postmaster callout checking.
32217
32218 Another issue to think about when using non-empty senders for callouts is
32219 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32220 by the sender/recipient combination; thus, for any given recipient, many more
32221 actual callouts are performed than when an empty sender or postmaster is used.
32222
32223
32224
32225
32226 .section "Callout caching" "SECTcallvercache"
32227 .cindex "hints database" "callout cache"
32228 .cindex "callout" "cache, description of"
32229 .cindex "caching" "callout"
32230 Exim caches the results of callouts in order to reduce the amount of resources
32231 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32232 option. A hints database called &"callout"& is used for the cache. Two
32233 different record types are used: one records the result of a callout check for
32234 a specific address, and the other records information that applies to the
32235 entire domain (for example, that it accepts the local part &'postmaster'&).
32236
32237 When an original callout fails, a detailed SMTP error message is given about
32238 the failure. However, for subsequent failures use the cache data, this message
32239 is not available.
32240
32241 The expiry times for negative and positive address cache records are
32242 independent, and can be set by the global options &%callout_negative_expire%&
32243 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32244
32245 If a host gives a negative response to an SMTP connection, or rejects any
32246 commands up to and including
32247 .code
32248 MAIL FROM:<>
32249 .endd
32250 (but not including the MAIL command with a non-empty address),
32251 any callout attempt is bound to fail. Exim remembers such failures in a
32252 domain cache record, which it uses to fail callouts for the domain without
32253 making new connections, until the domain record times out. There are two
32254 separate expiry times for domain cache records:
32255 &%callout_domain_negative_expire%& (default 3h) and
32256 &%callout_domain_positive_expire%& (default 7d).
32257
32258 Domain records expire when the negative expiry time is reached if callouts
32259 cannot be made for the domain, or if the postmaster check failed.
32260 Otherwise, they expire when the positive expiry time is reached. This
32261 ensures that, for example, a host that stops accepting &"random"& local parts
32262 will eventually be noticed.
32263
32264 The callout caching mechanism is based on the domain of the address that is
32265 being tested. If the domain routes to several hosts, it is assumed that their
32266 behaviour will be the same.
32267
32268
32269
32270 .section "Sender address verification reporting" "SECTsenaddver"
32271 .cindex "verifying" "suppressing error details"
32272 See section &<<SECTaddressverification>>& for a general discussion of
32273 verification. When sender verification fails in an ACL, the details of the
32274 failure are given as additional output lines before the 550 response to the
32275 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32276 you might see:
32277 .code
32278 MAIL FROM:<xyz@abc.example>
32279 250 OK
32280 RCPT TO:<pqr@def.example>
32281 550-Verification failed for <xyz@abc.example>
32282 550-Called:   192.168.34.43
32283 550-Sent:     RCPT TO:<xyz@abc.example>
32284 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32285 550 Sender verification failed
32286 .endd
32287 If more than one RCPT command fails in the same way, the details are given
32288 only for the first of them. However, some administrators do not want to send
32289 out this much information. You can suppress the details by adding
32290 &`/no_details`& to the ACL statement that requests sender verification. For
32291 example:
32292 .code
32293 verify = sender/no_details
32294 .endd
32295
32296 .section "Redirection while verifying" "SECTredirwhilveri"
32297 .cindex "verifying" "redirection while"
32298 .cindex "address redirection" "while verifying"
32299 A dilemma arises when a local address is redirected by aliasing or forwarding
32300 during verification: should the generated addresses themselves be verified,
32301 or should the successful expansion of the original address be enough to verify
32302 it? By default, Exim takes the following pragmatic approach:
32303
32304 .ilist
32305 When an incoming address is redirected to just one child address, verification
32306 continues with the child address, and if that fails to verify, the original
32307 verification also fails.
32308 .next
32309 When an incoming address is redirected to more than one child address,
32310 verification does not continue. A success result is returned.
32311 .endlist
32312
32313 This seems the most reasonable behaviour for the common use of aliasing as a
32314 way of redirecting different local parts to the same mailbox. It means, for
32315 example, that a pair of alias entries of the form
32316 .code
32317 A.Wol:   aw123
32318 aw123:   :fail: Gone away, no forwarding address
32319 .endd
32320 work as expected, with both local parts causing verification failure. When a
32321 redirection generates more than one address, the behaviour is more like a
32322 mailing list, where the existence of the alias itself is sufficient for
32323 verification to succeed.
32324
32325 It is possible, however, to change the default behaviour so that all successful
32326 redirections count as successful verifications, however many new addresses are
32327 generated. This is specified by the &%success_on_redirect%& verification
32328 option. For example:
32329 .code
32330 require verify = recipient/success_on_redirect/callout=10s
32331 .endd
32332 In this example, verification succeeds if a router generates a new address, and
32333 the callout does not occur, because no address was routed to a remote host.
32334
32335 When verification is being tested via the &%-bv%& option, the treatment of
32336 redirections is as just described, unless the &%-v%& or any debugging option is
32337 also specified. In that case, full verification is done for every generated
32338 address and a report is output for each of them.
32339
32340
32341
32342 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32343 .cindex "CSA" "verifying"
32344 Client SMTP Authorization is a system that allows a site to advertise
32345 which machines are and are not permitted to send email. This is done by placing
32346 special SRV records in the DNS; these are looked up using the client's HELO
32347 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32348 Authorization checks in Exim are performed by the ACL condition:
32349 .code
32350 verify = csa
32351 .endd
32352 This fails if the client is not authorized. If there is a DNS problem, or if no
32353 valid CSA SRV record is found, or if the client is authorized, the condition
32354 succeeds. These three cases can be distinguished using the expansion variable
32355 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32356 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32357 be likely to cause problems for legitimate email.
32358
32359 The error messages produced by the CSA code include slightly more
32360 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32361 looking up the CSA SRV record, or problems looking up the CSA target
32362 address record. There are four reasons for &$csa_status$& being &"fail"&:
32363
32364 .ilist
32365 The client's host name is explicitly not authorized.
32366 .next
32367 The client's IP address does not match any of the CSA target IP addresses.
32368 .next
32369 The client's host name is authorized but it has no valid target IP addresses
32370 (for example, the target's addresses are IPv6 and the client is using IPv4).
32371 .next
32372 The client's host name has no CSA SRV record but a parent domain has asserted
32373 that all subdomains must be explicitly authorized.
32374 .endlist
32375
32376 The &%csa%& verification condition can take an argument which is the domain to
32377 use for the DNS query. The default is:
32378 .code
32379 verify = csa/$sender_helo_name
32380 .endd
32381 This implementation includes an extension to CSA. If the query domain
32382 is an address literal such as [192.0.2.95], or if it is a bare IP
32383 address, Exim searches for CSA SRV records in the reverse DNS as if
32384 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32385 meaningful to say:
32386 .code
32387 verify = csa/$sender_host_address
32388 .endd
32389 In fact, this is the check that Exim performs if the client does not say HELO.
32390 This extension can be turned off by setting the main configuration option
32391 &%dns_csa_use_reverse%& to be false.
32392
32393 If a CSA SRV record is not found for the domain itself, a search
32394 is performed through its parent domains for a record which might be
32395 making assertions about subdomains. The maximum depth of this search is limited
32396 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32397 default. Exim does not look for CSA SRV records in a top level domain, so the
32398 default settings handle HELO domains as long as seven
32399 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32400 of legitimate HELO domains.
32401
32402 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32403 direct SRV lookups, this is not sufficient because of the extra parent domain
32404 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32405 addresses into lookups in the reverse DNS space. The result of a successful
32406 lookup such as:
32407 .code
32408 ${lookup dnsdb {csa=$sender_helo_name}}
32409 .endd
32410 has two space-separated fields: an authorization code and a target host name.
32411 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32412 authorization required but absent, or &"?"& for unknown.
32413
32414
32415
32416
32417 .section "Bounce address tag validation" "SECTverifyPRVS"
32418 .cindex "BATV, verifying"
32419 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32420 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32421 Genuine incoming bounce messages should therefore always be addressed to
32422 recipients that have a valid tag. This scheme is a way of detecting unwanted
32423 bounce messages caused by sender address forgeries (often called &"collateral
32424 spam"&), because the recipients of such messages do not include valid tags.
32425
32426 There are two expansion items to help with the implementation of the BATV
32427 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32428 the original envelope sender address by using a simple key to add a hash of the
32429 address and some time-based randomizing information. The &%prvs%& expansion
32430 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32431 The syntax of these expansion items is described in section
32432 &<<SECTexpansionitems>>&.
32433 The validity period on signed addresses is seven days.
32434
32435 As an example, suppose the secret per-address keys are stored in an MySQL
32436 database. A query to look up the key for an address could be defined as a macro
32437 like this:
32438 .code
32439 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32440                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32441                 }{$value}}
32442 .endd
32443 Suppose also that the senders who make use of BATV are defined by an address
32444 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32445 use this:
32446 .code
32447 # Bounces: drop unsigned addresses for BATV senders
32448 deny message = This address does not send an unsigned reverse path
32449      senders = :
32450      recipients = +batv_senders
32451
32452 # Bounces: In case of prvs-signed address, check signature.
32453 deny message = Invalid reverse path signature.
32454      senders = :
32455      condition  = ${prvscheck {$local_part@$domain}\
32456                   {PRVSCHECK_SQL}{1}}
32457      !condition = $prvscheck_result
32458 .endd
32459 The first statement rejects recipients for bounce messages that are addressed
32460 to plain BATV sender addresses, because it is known that BATV senders do not
32461 send out messages with plain sender addresses. The second statement rejects
32462 recipients that are prvs-signed, but with invalid signatures (either because
32463 the key is wrong, or the signature has timed out).
32464
32465 A non-prvs-signed address is not rejected by the second statement, because the
32466 &%prvscheck%& expansion yields an empty string if its first argument is not a
32467 prvs-signed address, thus causing the &%condition%& condition to be false. If
32468 the first argument is a syntactically valid prvs-signed address, the yield is
32469 the third string (in this case &"1"&), whether or not the cryptographic and
32470 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32471 of the checks (empty for failure, &"1"& for success).
32472
32473 There is one more issue you must consider when implementing prvs-signing:
32474 you have to ensure that the routers accept prvs-signed addresses and
32475 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32476 router to remove the signature with a configuration along these lines:
32477 .code
32478 batv_redirect:
32479   driver = redirect
32480   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32481 .endd
32482 This works because, if the third argument of &%prvscheck%& is empty, the result
32483 of the expansion of a prvs-signed address is the decoded value of the original
32484 address. This router should probably be the first of your routers that handles
32485 local addresses.
32486
32487 To create BATV-signed addresses in the first place, a transport of this form
32488 can be used:
32489 .code
32490 external_smtp_batv:
32491   driver = smtp
32492   return_path = ${prvs {$return_path} \
32493                        {${lookup mysql{SELECT \
32494                        secret FROM batv_prvs WHERE \
32495                        sender='${quote_mysql:$sender_address}'} \
32496                        {$value}fail}}}
32497 .endd
32498 If no key can be found for the existing return path, no signing takes place.
32499
32500
32501
32502 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32503 .cindex "&ACL;" "relay control"
32504 .cindex "relaying" "control by ACL"
32505 .cindex "policy control" "relay control"
32506 An MTA is said to &'relay'& a message if it receives it from some host and
32507 delivers it directly to another host as a result of a remote address contained
32508 within it. Redirecting a local address via an alias or forward file and then
32509 passing the message on to another host is not relaying,
32510 .cindex "&""percent hack""&"
32511 but a redirection as a result of the &"percent hack"& is.
32512
32513 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32514 A host which is acting as a gateway or an MX backup is concerned with incoming
32515 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32516 a host which is acting as a smart host for a number of clients is concerned
32517 with outgoing relaying from those clients to the Internet at large. Often the
32518 same host is fulfilling both functions,
32519 . ///
32520 . as illustrated in the diagram below,
32521 . ///
32522 but in principle these two kinds of relaying are entirely independent. What is
32523 not wanted is the transmission of mail from arbitrary remote hosts through your
32524 system to arbitrary domains.
32525
32526
32527 You can implement relay control by means of suitable statements in the ACL that
32528 runs for each RCPT command. For convenience, it is often easiest to use
32529 Exim's named list facility to define the domains and hosts involved. For
32530 example, suppose you want to do the following:
32531
32532 .ilist
32533 Deliver a number of domains to mailboxes on the local host (or process them
32534 locally in some other way). Let's say these are &'my.dom1.example'& and
32535 &'my.dom2.example'&.
32536 .next
32537 Relay mail for a number of other domains for which you are the secondary MX.
32538 These might be &'friend1.example'& and &'friend2.example'&.
32539 .next
32540 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32541 Suppose your LAN is 192.168.45.0/24.
32542 .endlist
32543
32544
32545 In the main part of the configuration, you put the following definitions:
32546 .code
32547 domainlist local_domains    = my.dom1.example : my.dom2.example
32548 domainlist relay_to_domains = friend1.example : friend2.example
32549 hostlist   relay_from_hosts = 192.168.45.0/24
32550 .endd
32551 Now you can use these definitions in the ACL that is run for every RCPT
32552 command:
32553 .code
32554 acl_check_rcpt:
32555   accept domains = +local_domains : +relay_to_domains
32556   accept hosts   = +relay_from_hosts
32557 .endd
32558 The first statement accepts any RCPT command that contains an address in
32559 the local or relay domains. For any other domain, control passes to the second
32560 statement, which accepts the command only if it comes from one of the relay
32561 hosts. In practice, you will probably want to make your ACL more sophisticated
32562 than this, for example, by including sender and recipient verification. The
32563 default configuration includes a more comprehensive example, which is described
32564 in chapter &<<CHAPdefconfil>>&.
32565
32566
32567
32568 .section "Checking a relay configuration" "SECTcheralcon"
32569 .cindex "relaying" "checking control of"
32570 You can check the relay characteristics of your configuration in the same way
32571 that you can test any ACL behaviour for an incoming SMTP connection, by using
32572 the &%-bh%& option to run a fake SMTP session with which you interact.
32573 .ecindex IIDacl
32574
32575
32576
32577 . ////////////////////////////////////////////////////////////////////////////
32578 . ////////////////////////////////////////////////////////////////////////////
32579
32580 .chapter "Content scanning at ACL time" "CHAPexiscan"
32581 .scindex IIDcosca "content scanning" "at ACL time"
32582 The extension of Exim to include content scanning at ACL time, formerly known
32583 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32584 was integrated into the main source for Exim release 4.50, and Tom continues to
32585 maintain it. Most of the wording of this chapter is taken from Tom's
32586 specification.
32587
32588 It is also possible to scan the content of messages at other times. The
32589 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32590 scanning after all the ACLs have run. A transport filter can be used to scan
32591 messages at delivery time (see the &%transport_filter%& option, described in
32592 chapter &<<CHAPtransportgeneric>>&).
32593
32594 If you want to include the ACL-time content-scanning features when you compile
32595 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32596 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32597
32598 .ilist
32599 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32600 for all MIME parts for SMTP and non-SMTP messages, respectively.
32601 .next
32602 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32603 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32604 run at the end of message reception (the &%acl_smtp_data%& ACL).
32605 .next
32606 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32607 of messages, or parts of messages, for debugging purposes.
32608 .next
32609 Additional expansion variables that are set in the new ACL and by the new
32610 conditions.
32611 .next
32612 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32613 .endlist
32614
32615 Content-scanning is continually evolving, and new features are still being
32616 added. While such features are still unstable and liable to incompatible
32617 changes, they are made available in Exim by setting options whose names begin
32618 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32619 this manual. You can find out about them by reading the file called
32620 &_doc/experimental.txt_&.
32621
32622 All the content-scanning facilities work on a MBOX copy of the message that is
32623 temporarily created in a file called:
32624 .display
32625 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32626 .endd
32627 The &_.eml_& extension is a friendly hint to virus scanners that they can
32628 expect an MBOX-like structure inside that file. The file is created when the
32629 first content scanning facility is called. Subsequent calls to content
32630 scanning conditions open the same file again. The directory is recursively
32631 removed when the &%acl_smtp_data%& ACL has finished running, unless
32632 .code
32633 control = no_mbox_unspool
32634 .endd
32635 has been encountered. When the MIME ACL decodes files, they are put into the
32636 same directory by default.
32637
32638
32639
32640 .section "Scanning for viruses" "SECTscanvirus"
32641 .cindex "virus scanning"
32642 .cindex "content scanning" "for viruses"
32643 .cindex "content scanning" "the &%malware%& condition"
32644 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32645 It supports a &"generic"& interface to scanners called via the shell, and
32646 specialized interfaces for &"daemon"& type virus scanners, which are resident
32647 in memory and thus are much faster.
32648
32649 A timeout of 2 minutes is applied to a scanner call (by default);
32650 if it expires then a defer action is taken.
32651
32652 .oindex "&%av_scanner%&"
32653 You can set the &%av_scanner%& option in the main part of the configuration
32654 to specify which scanner to use, together with any additional options that
32655 are needed. The basic syntax is as follows:
32656 .display
32657 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32658 .endd
32659 If you do not set &%av_scanner%&, it defaults to
32660 .code
32661 av_scanner = sophie:/var/run/sophie
32662 .endd
32663 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32664 before use.
32665 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32666 The following scanner types are supported in this release,
32667 though individual ones can be included or not at build time:
32668
32669 .vlist
32670 .vitem &%avast%&
32671 .cindex "virus scanners" "avast"
32672 This is the scanner daemon of Avast. It has been tested with Avast Core
32673 Security (currently at version 2.2.0).
32674 You can get a trial version at &url(https://www.avast.com) or for Linux
32675 at &url(https://www.avast.com/linux-server-antivirus).
32676 This scanner type takes one option,
32677 which can be either a full path to a UNIX socket,
32678 or host and port specifiers separated by white space.
32679 The host may be a name or an IP address; the port is either a
32680 single number or a pair of numbers with a dash between.
32681 A list of options may follow. These options are interpreted on the
32682 Exim's side of the malware scanner, or are given on separate lines to
32683 the daemon as options before the main scan command.
32684
32685 .cindex &`pass_unscanned`& "avast"
32686 If &`pass_unscanned`&
32687 is set, any files the Avast scanner can't scan (e.g.
32688 decompression bombs, or invalid archives) are considered clean. Use with
32689 care.
32690
32691 For example:
32692 .code
32693 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32694 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32695 av_scanner = avast:192.168.2.22 5036
32696 .endd
32697 If you omit the argument, the default path
32698 &_/var/run/avast/scan.sock_&
32699 is used.
32700 If you use a remote host,
32701 you need to make Exim's spool directory available to it,
32702 as the scanner is passed a file path, not file contents.
32703 For information about available commands and their options you may use
32704 .code
32705 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32706     FLAGS
32707     SENSITIVITY
32708     PACK
32709 .endd
32710
32711 If the scanner returns a temporary failure (e.g. license issues, or
32712 permission problems), the message is deferred and a paniclog entry is
32713 written.  The usual &`defer_ok`& option is available.
32714
32715 .vitem &%aveserver%&
32716 .cindex "virus scanners" "Kaspersky"
32717 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32718 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32719 which is the path to the daemon's UNIX socket. The default is shown in this
32720 example:
32721 .code
32722 av_scanner = aveserver:/var/run/aveserver
32723 .endd
32724
32725
32726 .vitem &%clamd%&
32727 .cindex "virus scanners" "clamd"
32728 This daemon-type scanner is GPL and free. You can get it at
32729 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32730 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32731 in the MIME ACL. This is no longer believed to be necessary.
32732
32733 The options are a list of server specifiers, which may be
32734 a UNIX socket specification,
32735 a TCP socket specification,
32736 or a (global) option.
32737
32738 A socket specification consists of a space-separated list.
32739 For a Unix socket the first element is a full path for the socket,
32740 for a TCP socket the first element is the IP address
32741 and the second a port number,
32742 Any further elements are per-server (non-global) options.
32743 These per-server options are supported:
32744 .code
32745 retry=<timespec>        Retry on connect fail
32746 .endd
32747
32748 The &`retry`& option specifies a time after which a single retry for
32749 a failed connect is made.  The default is to not retry.
32750
32751 If a Unix socket file is specified, only one server is supported.
32752
32753 Examples:
32754 .code
32755 av_scanner = clamd:/opt/clamd/socket
32756 av_scanner = clamd:192.0.2.3 1234
32757 av_scanner = clamd:192.0.2.3 1234:local
32758 av_scanner = clamd:192.0.2.3 1234 retry=10s
32759 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32760 .endd
32761 If the value of av_scanner points to a UNIX socket file or contains the
32762 &`local`&
32763 option, then the ClamAV interface will pass a filename containing the data
32764 to be scanned, which should normally result in less I/O happening and be
32765 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32766 Exim does not assume that there is a common filesystem with the remote host.
32767
32768 The final example shows that multiple TCP targets can be specified.  Exim will
32769 randomly use one for each incoming email (i.e. it load balances them).  Note
32770 that only TCP targets may be used if specifying a list of scanners; a UNIX
32771 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32772 unavailable, Exim will try the remaining one(s) until it finds one that works.
32773 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32774 not keep track of scanner state between multiple messages, and the scanner
32775 selection is random, so the message will get logged in the mainlog for each
32776 email that the down scanner gets chosen first (message wrapped to be readable):
32777 .code
32778 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32779    clamd: connection to localhost, port 3310 failed
32780    (Connection refused)
32781 .endd
32782
32783 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32784 contributing the code for this scanner.
32785
32786 .vitem &%cmdline%&
32787 .cindex "virus scanners" "command line interface"
32788 This is the keyword for the generic command line scanner interface. It can be
32789 used to attach virus scanners that are invoked from the shell. This scanner
32790 type takes 3 mandatory options:
32791
32792 .olist
32793 The full path and name of the scanner binary, with all command line options,
32794 and a placeholder (&`%s`&) for the directory to scan.
32795
32796 .next
32797 A regular expression to match against the STDOUT and STDERR output of the
32798 virus scanner. If the expression matches, a virus was found. You must make
32799 absolutely sure that this expression matches on &"virus found"&. This is called
32800 the &"trigger"& expression.
32801
32802 .next
32803 Another regular expression, containing exactly one pair of parentheses, to
32804 match the name of the virus found in the scanners output. This is called the
32805 &"name"& expression.
32806 .endlist olist
32807
32808 For example, Sophos Sweep reports a virus on a line like this:
32809 .code
32810 Virus 'W32/Magistr-B' found in file ./those.bat
32811 .endd
32812 For the trigger expression, we can match the phrase &"found in file"&. For the
32813 name expression, we want to extract the W32/Magistr-B string, so we can match
32814 for the single quotes left and right of it. Altogether, this makes the
32815 configuration setting:
32816 .code
32817 av_scanner = cmdline:\
32818              /path/to/sweep -ss -all -rec -archive %s:\
32819              found in file:'(.+)'
32820 .endd
32821 .vitem &%drweb%&
32822 .cindex "virus scanners" "DrWeb"
32823 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32824 takes one option,
32825 either a full path to a UNIX socket,
32826 or host and port specifiers separated by white space.
32827 The host may be a name or an IP address; the port is either a
32828 single number or a pair of numbers with a dash between.
32829 For example:
32830 .code
32831 av_scanner = drweb:/var/run/drwebd.sock
32832 av_scanner = drweb:192.168.2.20 31337
32833 .endd
32834 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32835 is used. Thanks to Alex Miller for contributing the code for this scanner.
32836
32837 .vitem &%f-protd%&
32838 .cindex "virus scanners" "f-protd"
32839 The f-protd scanner is accessed via HTTP over TCP.
32840 One argument is taken, being a space-separated hostname and port number
32841 (or port-range).
32842 For example:
32843 .code
32844 av_scanner = f-protd:localhost 10200-10204
32845 .endd
32846 If you omit the argument, the default values shown above are used.
32847
32848 .vitem &%f-prot6d%&
32849 .cindex "virus scanners" "f-prot6d"
32850 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32851 One argument is taken, being a space-separated hostname and port number.
32852 For example:
32853 .code
32854 av_scanner = f-prot6d:localhost 10200
32855 .endd
32856 If you omit the argument, the default values show above are used.
32857
32858 .vitem &%fsecure%&
32859 .cindex "virus scanners" "F-Secure"
32860 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32861 argument which is the path to a UNIX socket. For example:
32862 .code
32863 av_scanner = fsecure:/path/to/.fsav
32864 .endd
32865 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32866 Thelmen for contributing the code for this scanner.
32867
32868 .vitem &%kavdaemon%&
32869 .cindex "virus scanners" "Kaspersky"
32870 This is the scanner daemon of Kaspersky Version 4. This version of the
32871 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32872 scanner type takes one option, which is the path to the daemon's UNIX socket.
32873 For example:
32874 .code
32875 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32876 .endd
32877 The default path is &_/var/run/AvpCtl_&.
32878
32879 .vitem &%mksd%&
32880 .cindex "virus scanners" "mksd"
32881 This was a daemon type scanner that is aimed mainly at Polish users,
32882 though some documentation was available in English.
32883 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32884 and this appears to be a candidate for removal from Exim, unless
32885 we are informed of other virus scanners which use the same protocol
32886 to integrate.
32887 The only option for this scanner type is
32888 the maximum number of processes used simultaneously to scan the attachments,
32889 provided that mksd has
32890 been run with at least the same number of child processes. For example:
32891 .code
32892 av_scanner = mksd:2
32893 .endd
32894 You can safely omit this option (the default value is 1).
32895
32896 .vitem &%sock%&
32897 .cindex "virus scanners" "simple socket-connected"
32898 This is a general-purpose way of talking to simple scanner daemons
32899 running on the local machine.
32900 There are four options:
32901 an address (which may be an IP address and port, or the path of a Unix socket),
32902 a commandline to send (may include a single %s which will be replaced with
32903 the path to the mail file to be scanned),
32904 an RE to trigger on from the returned data,
32905 and an RE to extract malware_name from the returned data.
32906 For example:
32907 .code
32908 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32909 .endd
32910 Note that surrounding whitespace is stripped from each option, meaning
32911 there is no way to specify a trailing newline.
32912 The socket specifier and both regular-expressions are required.
32913 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32914 specify an empty element to get this.
32915
32916 .vitem &%sophie%&
32917 .cindex "virus scanners" "Sophos and Sophie"
32918 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32919 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32920 for this scanner type is the path to the UNIX socket that Sophie uses for
32921 client communication. For example:
32922 .code
32923 av_scanner = sophie:/tmp/sophie
32924 .endd
32925 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32926 the option.
32927 .endlist
32928
32929 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32930 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32931 ACL.
32932
32933 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32934 makes it possible to use different scanners. See further below for an example.
32935 The &%malware%& condition caches its results, so when you use it multiple times
32936 for the same message, the actual scanning process is only carried out once.
32937 However, using expandable items in &%av_scanner%& disables this caching, in
32938 which case each use of the &%malware%& condition causes a new scan of the
32939 message.
32940
32941 The &%malware%& condition takes a right-hand argument that is expanded before
32942 use and taken as a list, slash-separated by default.
32943 The first element can then be one of
32944
32945 .ilist
32946 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32947 The condition succeeds if a virus was found, and fail otherwise. This is the
32948 recommended usage.
32949 .next
32950 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32951 the condition fails immediately.
32952 .next
32953 A regular expression, in which case the message is scanned for viruses. The
32954 condition succeeds if a virus is found and its name matches the regular
32955 expression. This allows you to take special actions on certain types of virus.
32956 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32957 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
32958 .endlist
32959
32960 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32961 messages even if there is a problem with the virus scanner.
32962 Otherwise, such a problem causes the ACL to defer.
32963
32964 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32965 specify a non-default timeout.  The default is two minutes.
32966 For example:
32967 .code
32968 malware = * / defer_ok / tmo=10s
32969 .endd
32970 A timeout causes the ACL to defer.
32971
32972 .vindex "&$callout_address$&"
32973 When a connection is made to the scanner the expansion variable &$callout_address$&
32974 is set to record the actual address used.
32975
32976 .vindex "&$malware_name$&"
32977 When a virus is found, the condition sets up an expansion variable called
32978 &$malware_name$& that contains the name of the virus. You can use it in a
32979 &%message%& modifier that specifies the error returned to the sender, and/or in
32980 logging data.
32981
32982 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32983 imposed by your anti-virus scanner.
32984
32985 Here is a very simple scanning example:
32986 .code
32987 deny message = This message contains malware ($malware_name)
32988      malware = *
32989 .endd
32990 The next example accepts messages when there is a problem with the scanner:
32991 .code
32992 deny message = This message contains malware ($malware_name)
32993      malware = */defer_ok
32994 .endd
32995 The next example shows how to use an ACL variable to scan with both sophie and
32996 aveserver. It assumes you have set:
32997 .code
32998 av_scanner = $acl_m0
32999 .endd
33000 in the main Exim configuration.
33001 .code
33002 deny message = This message contains malware ($malware_name)
33003      set acl_m0 = sophie
33004      malware = *
33005
33006 deny message = This message contains malware ($malware_name)
33007      set acl_m0 = aveserver
33008      malware = *
33009 .endd
33010
33011
33012 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33013 .cindex "content scanning" "for spam"
33014 .cindex "spam scanning"
33015 .cindex "SpamAssassin"
33016 .cindex "Rspamd"
33017 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33018 score and a report for the message.
33019 Support is also provided for Rspamd.
33020
33021 For more information about installation and configuration of SpamAssassin or
33022 Rspamd refer to their respective websites at
33023 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33024
33025 SpamAssassin can be installed with CPAN by running:
33026 .code
33027 perl -MCPAN -e 'install Mail::SpamAssassin'
33028 .endd
33029 SpamAssassin has its own set of configuration files. Please review its
33030 documentation to see how you can tweak it. The default installation should work
33031 nicely, however.
33032
33033 .oindex "&%spamd_address%&"
33034 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33035 intend to use an instance running on the local host you do not need to set
33036 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33037 you must set the &%spamd_address%& option in the global part of the Exim
33038 configuration as follows (example):
33039 .code
33040 spamd_address = 192.168.99.45 783
33041 .endd
33042 The SpamAssassin protocol relies on a TCP half-close from the client.
33043 If your SpamAssassin client side is running a Linux system with an
33044 iptables firewall, consider setting
33045 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33046 timeout, Exim uses when waiting for a response from the SpamAssassin
33047 server (currently defaulting to 120s).  With a lower value the Linux
33048 connection tracking may consider your half-closed connection as dead too
33049 soon.
33050
33051
33052 To use Rspamd (which by default listens on all local addresses
33053 on TCP port 11333)
33054 you should add &%variant=rspamd%& after the address/port pair, for example:
33055 .code
33056 spamd_address = 127.0.0.1 11333 variant=rspamd
33057 .endd
33058
33059 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33060 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33061 filename instead of an address/port pair:
33062 .code
33063 spamd_address = /var/run/spamd_socket
33064 .endd
33065 You can have multiple &%spamd%& servers to improve scalability. These can
33066 reside on other hardware reachable over the network. To specify multiple
33067 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33068 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33069 .code
33070 spamd_address = 192.168.2.10 783 : \
33071                 192.168.2.11 783 : \
33072                 192.168.2.12 783
33073 .endd
33074 Up to 32 &%spamd%& servers are supported.
33075 When a server fails to respond to the connection attempt, all other
33076 servers are tried until one succeeds. If no server responds, the &%spam%&
33077 condition defers.
33078
33079 Unix and TCP socket specifications may be mixed in any order.
33080 Each element of the list is a list itself, space-separated by default
33081 and changeable in the usual way (&<<SECTlistsepchange>>&);
33082 take care to not double the separator.
33083
33084 For TCP socket specifications a host name or IP (v4 or v6, but
33085 subject to list-separator quoting rules) address can be used,
33086 and the port can be one or a dash-separated pair.
33087 In the latter case, the range is tried in strict order.
33088
33089 Elements after the first for Unix sockets, or second for TCP socket,
33090 are options.
33091 The supported options are:
33092 .code
33093 pri=<priority>      Selection priority
33094 weight=<value>      Selection bias
33095 time=<start>-<end>  Use only between these times of day
33096 retry=<timespec>    Retry on connect fail
33097 tmo=<timespec>      Connection time limit
33098 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33099 .endd
33100
33101 The &`pri`& option specifies a priority for the server within the list,
33102 higher values being tried first.
33103 The default priority is 1.
33104
33105 The &`weight`& option specifies a selection bias.
33106 Within a priority set
33107 servers are queried in a random fashion, weighted by this value.
33108 The default value for selection bias is 1.
33109
33110 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33111 in the local time zone; each element being one or more digits.
33112 Either the seconds or both minutes and seconds, plus the leading &`.`&
33113 characters, may be omitted and will be taken as zero.
33114
33115 Timeout specifications for the &`retry`& and &`tmo`& options
33116 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33117
33118 The &`tmo`& option specifies an overall timeout for communication.
33119 The default value is two minutes.
33120
33121 The &`retry`& option specifies a time after which a single retry for
33122 a failed connect is made.
33123 The default is to not retry.
33124
33125 The &%spamd_address%& variable is expanded before use if it starts with
33126 a dollar sign. In this case, the expansion may return a string that is
33127 used as the list so that multiple spamd servers can be the result of an
33128 expansion.
33129
33130 .vindex "&$callout_address$&"
33131 When a connection is made to the server the expansion variable &$callout_address$&
33132 is set to record the actual address used.
33133
33134 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33135 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33136 .code
33137 deny message = This message was classified as SPAM
33138      spam = joe
33139 .endd
33140 The right-hand side of the &%spam%& condition specifies a name. This is
33141 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33142 to scan using a specific profile, but rather use the SpamAssassin system-wide
33143 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33144 Rspamd does not use this setting. However, you must put something on the
33145 right-hand side.
33146
33147 The name allows you to use per-domain or per-user antispam profiles in
33148 principle, but this is not straightforward in practice, because a message may
33149 have multiple recipients, not necessarily all in the same domain. Because the
33150 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33151 read the contents of the message, the variables &$local_part$& and &$domain$&
33152 are not set.
33153 Careful enforcement of single-recipient messages
33154 (e.g. by responding with defer in the recipient ACL for all recipients
33155 after the first),
33156 or the use of PRDR,
33157 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33158 are needed to use this feature.
33159
33160 The right-hand side of the &%spam%& condition is expanded before being used, so
33161 you can put lookups or conditions there. When the right-hand side evaluates to
33162 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33163
33164
33165 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33166 large ones may cause significant performance degradation. As most spam messages
33167 are quite small, it is recommended that you do not scan the big ones. For
33168 example:
33169 .code
33170 deny message = This message was classified as SPAM
33171      condition = ${if < {$message_size}{10K}}
33172      spam = nobody
33173 .endd
33174
33175 The &%spam%& condition returns true if the threshold specified in the user's
33176 SpamAssassin profile has been matched or exceeded. If you want to use the
33177 &%spam%& condition for its side effects (see the variables below), you can make
33178 it always return &"true"& by appending &`:true`& to the username.
33179
33180 .cindex "spam scanning" "returned variables"
33181 When the &%spam%& condition is run, it sets up a number of expansion
33182 variables.
33183 Except for &$spam_report$&,
33184 these variables are saved with the received message so are
33185 available for use at delivery time.
33186
33187 .vlist
33188 .vitem &$spam_score$&
33189 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33190 for inclusion in log or reject messages.
33191
33192 .vitem &$spam_score_int$&
33193 The spam score of the message, multiplied by ten, as an integer value. For
33194 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33195 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33196 The integer value is useful for numeric comparisons in conditions.
33197
33198 .vitem &$spam_bar$&
33199 A string consisting of a number of &"+"& or &"-"& characters, representing the
33200 integer part of the spam score value. A spam score of 4.4 would have a
33201 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33202 headers, since MUAs can match on such strings. The maximum length of the
33203 spam bar is 50 characters.
33204
33205 .vitem &$spam_report$&
33206 A multiline text table, containing the full SpamAssassin report for the
33207 message. Useful for inclusion in headers or reject messages.
33208 This variable is only usable in a DATA-time ACL.
33209 Beware that SpamAssassin may return non-ASCII characters, especially
33210 when running in country-specific locales, which are not legal
33211 unencoded in headers.
33212
33213 .vitem &$spam_action$&
33214 For SpamAssassin either 'reject' or 'no action' depending on the
33215 spam score versus threshold.
33216 For Rspamd, the recommended action.
33217
33218 .endlist
33219
33220 The &%spam%& condition caches its results unless expansion in
33221 spamd_address was used. If you call it again with the same user name, it
33222 does not scan again, but rather returns the same values as before.
33223
33224 The &%spam%& condition returns DEFER if there is any error while running
33225 the message through SpamAssassin or if the expansion of spamd_address
33226 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33227 statement block), append &`/defer_ok`& to the right-hand side of the
33228 spam condition, like this:
33229 .code
33230 deny message = This message was classified as SPAM
33231      spam    = joe/defer_ok
33232 .endd
33233 This causes messages to be accepted even if there is a problem with &%spamd%&.
33234
33235 Here is a longer, commented example of the use of the &%spam%&
33236 condition:
33237 .code
33238 # put headers in all messages (no matter if spam or not)
33239 warn  spam = nobody:true
33240       add_header = X-Spam-Score: $spam_score ($spam_bar)
33241       add_header = X-Spam-Report: $spam_report
33242
33243 # add second subject line with *SPAM* marker when message
33244 # is over threshold
33245 warn  spam = nobody
33246       add_header = Subject: *SPAM* $h_Subject:
33247
33248 # reject spam at high scores (> 12)
33249 deny  message = This message scored $spam_score spam points.
33250       spam = nobody:true
33251       condition = ${if >{$spam_score_int}{120}{1}{0}}
33252 .endd
33253
33254
33255
33256 .section "Scanning MIME parts" "SECTscanmimepart"
33257 .cindex "content scanning" "MIME parts"
33258 .cindex "MIME content scanning"
33259 .oindex "&%acl_smtp_mime%&"
33260 .oindex "&%acl_not_smtp_mime%&"
33261 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33262 each MIME part of an SMTP message, including multipart types, in the sequence
33263 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33264 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33265 options may both refer to the same ACL if you want the same processing in both
33266 cases.
33267
33268 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33269 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33270 the case of a non-SMTP message. However, a MIME ACL is called only if the
33271 message contains a &'Content-Type:'& header line. When a call to a MIME
33272 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33273 result code is sent to the client. In the case of an SMTP message, the
33274 &%acl_smtp_data%& ACL is not called when this happens.
33275
33276 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33277 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33278 condition to match against the raw MIME part. You can also use the
33279 &%mime_regex%& condition to match against the decoded MIME part (see section
33280 &<<SECTscanregex>>&).
33281
33282 At the start of a MIME ACL, a number of variables are set from the header
33283 information for the relevant MIME part. These are described below. The contents
33284 of the MIME part are not by default decoded into a disk file except for MIME
33285 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33286 part into a disk file, you can use the &%decode%& condition. The general
33287 syntax is:
33288 .display
33289 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33290 .endd
33291 The right hand side is expanded before use. After expansion,
33292 the value can be:
33293
33294 .olist
33295 &"0"& or &"false"&, in which case no decoding is done.
33296 .next
33297 The string &"default"&. In that case, the file is put in the temporary
33298 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33299 a sequential filename consisting of the message id and a sequence number. The
33300 full path and name is available in &$mime_decoded_filename$& after decoding.
33301 .next
33302 A full path name starting with a slash. If the full name is an existing
33303 directory, it is used as a replacement for the default directory. The filename
33304 is then sequentially assigned. If the path does not exist, it is used as
33305 the full path and filename.
33306 .next
33307 If the string does not start with a slash, it is used as the
33308 filename, and the default path is then used.
33309 .endlist
33310 The &%decode%& condition normally succeeds. It is only false for syntax
33311 errors or unusual circumstances such as memory shortages. You can easily decode
33312 a file with its original, proposed filename using
33313 .code
33314 decode = $mime_filename
33315 .endd
33316 However, you should keep in mind that &$mime_filename$& might contain
33317 anything. If you place files outside of the default path, they are not
33318 automatically unlinked.
33319
33320 For RFC822 attachments (these are messages attached to messages, with a
33321 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33322 as for the primary message, only that the &$mime_is_rfc822$& expansion
33323 variable is set (see below). Attached messages are always decoded to disk
33324 before being checked, and the files are unlinked once the check is done.
33325
33326 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33327 used to match regular expressions against raw and decoded MIME parts,
33328 respectively. They are described in section &<<SECTscanregex>>&.
33329
33330 .cindex "MIME content scanning" "returned variables"
33331 The following list describes all expansion variables that are
33332 available in the MIME ACL:
33333
33334 .vlist
33335 .vitem &$mime_boundary$&
33336 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33337 have a boundary string, which is stored in this variable. If the current part
33338 has no boundary parameter in the &'Content-Type:'& header, this variable
33339 contains the empty string.
33340
33341 .vitem &$mime_charset$&
33342 This variable contains the character set identifier, if one was found in the
33343 &'Content-Type:'& header. Examples for charset identifiers are:
33344 .code
33345 us-ascii
33346 gb2312 (Chinese)
33347 iso-8859-1
33348 .endd
33349 Please note that this value is not normalized, so you should do matches
33350 case-insensitively.
33351
33352 .vitem &$mime_content_description$&
33353 This variable contains the normalized content of the &'Content-Description:'&
33354 header. It can contain a human-readable description of the parts content. Some
33355 implementations repeat the filename for attachments here, but they are usually
33356 only used for display purposes.
33357
33358 .vitem &$mime_content_disposition$&
33359 This variable contains the normalized content of the &'Content-Disposition:'&
33360 header. You can expect strings like &"attachment"& or &"inline"& here.
33361
33362 .vitem &$mime_content_id$&
33363 This variable contains the normalized content of the &'Content-ID:'& header.
33364 This is a unique ID that can be used to reference a part from another part.
33365
33366 .vitem &$mime_content_size$&
33367 This variable is set only after the &%decode%& modifier (see above) has been
33368 successfully run. It contains the size of the decoded part in kilobytes. The
33369 size is always rounded up to full kilobytes, so only a completely empty part
33370 has a &$mime_content_size$& of zero.
33371
33372 .vitem &$mime_content_transfer_encoding$&
33373 This variable contains the normalized content of the
33374 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33375 type. Typical values are &"base64"& and &"quoted-printable"&.
33376
33377 .vitem &$mime_content_type$&
33378 If the MIME part has a &'Content-Type:'& header, this variable contains its
33379 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33380 are some examples of popular MIME types, as they may appear in this variable:
33381 .code
33382 text/plain
33383 text/html
33384 application/octet-stream
33385 image/jpeg
33386 audio/midi
33387 .endd
33388 If the MIME part has no &'Content-Type:'& header, this variable contains the
33389 empty string.
33390
33391 .vitem &$mime_decoded_filename$&
33392 This variable is set only after the &%decode%& modifier (see above) has been
33393 successfully run. It contains the full path and filename of the file
33394 containing the decoded data.
33395 .endlist
33396
33397 .cindex "RFC 2047"
33398 .vlist
33399 .vitem &$mime_filename$&
33400 This is perhaps the most important of the MIME variables. It contains a
33401 proposed filename for an attachment, if one was found in either the
33402 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33403 RFC2047
33404 or RFC2231
33405 decoded, but no additional sanity checks are done.
33406  If no filename was
33407 found, this variable contains the empty string.
33408
33409 .vitem &$mime_is_coverletter$&
33410 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33411 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33412 content in the cover letter, while not restricting attachments at all.
33413
33414 The variable contains 1 (true) for a MIME part believed to be part of the
33415 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33416 follows:
33417
33418 .olist
33419 The outermost MIME part of a message is always a cover letter.
33420
33421 .next
33422 If a multipart/alternative or multipart/related MIME part is a cover letter,
33423 so are all MIME subparts within that multipart.
33424
33425 .next
33426 If any other multipart is a cover letter, the first subpart is a cover letter,
33427 and the rest are attachments.
33428
33429 .next
33430 All parts contained within an attachment multipart are attachments.
33431 .endlist olist
33432
33433 As an example, the following will ban &"HTML mail"& (including that sent with
33434 alternative plain text), while allowing HTML files to be attached. HTML
33435 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33436 .code
33437 deny message = HTML mail is not accepted here
33438 !condition = $mime_is_rfc822
33439 condition = $mime_is_coverletter
33440 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33441 .endd
33442 .vitem &$mime_is_multipart$&
33443 This variable has the value 1 (true) when the current part has the main type
33444 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33445 Since multipart entities only serve as containers for other parts, you may not
33446 want to carry out specific actions on them.
33447
33448 .vitem &$mime_is_rfc822$&
33449 This variable has the value 1 (true) if the current part is not a part of the
33450 checked message itself, but part of an attached message. Attached message
33451 decoding is fully recursive.
33452
33453 .vitem &$mime_part_count$&
33454 This variable is a counter that is raised for each processed MIME part. It
33455 starts at zero for the very first part (which is usually a multipart). The
33456 counter is per-message, so it is reset when processing RFC822 attachments (see
33457 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33458 complete, so you can use it in the DATA ACL to determine the number of MIME
33459 parts of a message. For non-MIME messages, this variable contains the value -1.
33460 .endlist
33461
33462
33463
33464 .section "Scanning with regular expressions" "SECTscanregex"
33465 .cindex "content scanning" "with regular expressions"
33466 .cindex "regular expressions" "content scanning with"
33467 You can specify your own custom regular expression matches on the full body of
33468 the message, or on individual MIME parts.
33469
33470 The &%regex%& condition takes one or more regular expressions as arguments and
33471 matches them against the full message (when called in the DATA ACL) or a raw
33472 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33473 linewise, with a maximum line length of 32K characters. That means you cannot
33474 have multiline matches with the &%regex%& condition.
33475
33476 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33477 to 32K of decoded content (the whole content at once, not linewise). If the
33478 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33479 is decoded automatically when &%mime_regex%& is executed (using default path
33480 and filename values). If the decoded data is larger than  32K, only the first
33481 32K characters are checked.
33482
33483 The regular expressions are passed as a colon-separated list. To include a
33484 literal colon, you must double it. Since the whole right-hand side string is
33485 expanded before being used, you must also escape dollar signs and backslashes
33486 with more backslashes, or use the &`\N`& facility to disable expansion.
33487 Here is a simple example that contains two regular expressions:
33488 .code
33489 deny message = contains blacklisted regex ($regex_match_string)
33490      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33491 .endd
33492 The conditions returns true if any one of the regular expressions matches. The
33493 &$regex_match_string$& expansion variable is then set up and contains the
33494 matching regular expression.
33495 The expansion variables &$regex1$& &$regex2$& etc
33496 are set to any substrings captured by the regular expression.
33497
33498 &*Warning*&: With large messages, these conditions can be fairly
33499 CPU-intensive.
33500
33501 .ecindex IIDcosca
33502
33503
33504
33505
33506 . ////////////////////////////////////////////////////////////////////////////
33507 . ////////////////////////////////////////////////////////////////////////////
33508
33509 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33510          "Local scan function"
33511 .scindex IIDlosca "&[local_scan()]& function" "description of"
33512 .cindex "customizing" "input scan using C function"
33513 .cindex "policy control" "by local scan function"
33514 In these days of email worms, viruses, and ever-increasing spam, some sites
33515 want to apply a lot of checking to messages before accepting them.
33516
33517 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33518 passing messages to external virus and spam scanning software. You can also do
33519 a certain amount in Exim itself through string expansions and the &%condition%&
33520 condition in the ACL that runs after the SMTP DATA command or the ACL for
33521 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33522
33523 To allow for further customization to a site's own requirements, there is the
33524 possibility of linking Exim with a private message scanning function, written
33525 in C. If you want to run code that is written in something other than C, you
33526 can of course use a little C stub to call it.
33527
33528 The local scan function is run once for every incoming message, at the point
33529 when Exim is just about to accept the message.
33530 It can therefore be used to control non-SMTP messages from local processes as
33531 well as messages arriving via SMTP.
33532
33533 Exim applies a timeout to calls of the local scan function, and there is an
33534 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33535 Zero means &"no timeout"&.
33536 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33537 before calling the local scan function, so that the most common types of crash
33538 are caught. If the timeout is exceeded or one of those signals is caught, the
33539 incoming message is rejected with a temporary error if it is an SMTP message.
33540 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33541 code. The incident is logged on the main and reject logs.
33542
33543
33544
33545 .section "Building Exim to use a local scan function" "SECID207"
33546 .cindex "&[local_scan()]& function" "building Exim to use"
33547 To make use of the local scan function feature, you must tell Exim where your
33548 function is before building Exim, by setting
33549 both HAVE_LOCAL_SCAN and
33550 LOCAL_SCAN_SOURCE in your
33551 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33552 directory, so you might set
33553 .code
33554 HAVE_LOCAL_SCAN=yes
33555 LOCAL_SCAN_SOURCE=Local/local_scan.c
33556 .endd
33557 for example. The function must be called &[local_scan()]&. It is called by
33558 Exim after it has received a message, when the success return code is about to
33559 be sent. This is after all the ACLs have been run. The return code from your
33560 function controls whether the message is actually accepted or not. There is a
33561 commented template function (that just accepts the message) in the file
33562 _src/local_scan.c_.
33563
33564 If you want to make use of Exim's runtime configuration file to set options
33565 for your &[local_scan()]& function, you must also set
33566 .code
33567 LOCAL_SCAN_HAS_OPTIONS=yes
33568 .endd
33569 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33570
33571
33572
33573
33574 .section "API for local_scan()" "SECTapiforloc"
33575 .cindex "&[local_scan()]& function" "API description"
33576 .cindex &%dlfunc%& "API description"
33577 You must include this line near the start of your code:
33578 .code
33579 #include "local_scan.h"
33580 .endd
33581 This header file defines a number of variables and other values, and the
33582 prototype for the function itself. Exim is coded to use unsigned char values
33583 almost exclusively, and one of the things this header defines is a shorthand
33584 for &`unsigned char`& called &`uschar`&.
33585 It also contains the following macro definitions, to simplify casting character
33586 strings and pointers to character strings:
33587 .code
33588 #define CS   (char *)
33589 #define CCS  (const char *)
33590 #define CSS  (char **)
33591 #define US   (unsigned char *)
33592 #define CUS  (const unsigned char *)
33593 #define USS  (unsigned char **)
33594 .endd
33595 The function prototype for &[local_scan()]& is:
33596 .code
33597 extern int local_scan(int fd, uschar **return_text);
33598 .endd
33599 The arguments are as follows:
33600
33601 .ilist
33602 &%fd%& is a file descriptor for the file that contains the body of the message
33603 (the -D file). The file is open for reading and writing, but updating it is not
33604 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33605
33606 The descriptor is positioned at character 19 of the file, which is the first
33607 character of the body itself, because the first 19 characters are the message
33608 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33609 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33610 case this changes in some future version.
33611 .next
33612 &%return_text%& is an address which you can use to return a pointer to a text
33613 string at the end of the function. The value it points to on entry is NULL.
33614 .endlist
33615
33616 The function must return an &%int%& value which is one of the following macros:
33617
33618 .vlist
33619 .vitem &`LOCAL_SCAN_ACCEPT`&
33620 .vindex "&$local_scan_data$&"
33621 The message is accepted. If you pass back a string of text, it is saved with
33622 the message, and made available in the variable &$local_scan_data$&. No
33623 newlines are permitted (if there are any, they are turned into spaces) and the
33624 maximum length of text is 1000 characters.
33625
33626 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33627 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33628 queued without immediate delivery, and is frozen.
33629
33630 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33631 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33632 queued without immediate delivery.
33633
33634 .vitem &`LOCAL_SCAN_REJECT`&
33635 The message is rejected; the returned text is used as an error message which is
33636 passed back to the sender and which is also logged. Newlines are permitted &--
33637 they cause a multiline response for SMTP rejections, but are converted to
33638 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33639 used.
33640
33641 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33642 The message is temporarily rejected; the returned text is used as an error
33643 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33644 problem"& is used.
33645
33646 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33647 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33648 message is not written to the reject log. It has the effect of unsetting the
33649 &%rejected_header%& log selector for just this rejection. If
33650 &%rejected_header%& is already unset (see the discussion of the
33651 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33652 same as LOCAL_SCAN_REJECT.
33653
33654 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33655 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33656 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33657 .endlist
33658
33659 If the message is not being received by interactive SMTP, rejections are
33660 reported by writing to &%stderr%& or by sending an email, as configured by the
33661 &%-oe%& command line options.
33662
33663
33664
33665 .section "Configuration options for local_scan()" "SECTconoptloc"
33666 .cindex "&[local_scan()]& function" "configuration options"
33667 It is possible to have option settings in the main configuration file
33668 that set values in static variables in the &[local_scan()]& module. If you
33669 want to do this, you must have the line
33670 .code
33671 LOCAL_SCAN_HAS_OPTIONS=yes
33672 .endd
33673 in your &_Local/Makefile_& when you build Exim. (This line is in
33674 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33675 file, you must define static variables to hold the option values, and a table
33676 to define them.
33677
33678 The table must be a vector called &%local_scan_options%&, of type
33679 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33680 and a pointer to the variable that holds the value. The entries must appear in
33681 alphabetical order. Following &%local_scan_options%& you must also define a
33682 variable called &%local_scan_options_count%& that contains the number of
33683 entries in the table. Here is a short example, showing two kinds of option:
33684 .code
33685 static int my_integer_option = 42;
33686 static uschar *my_string_option = US"a default string";
33687
33688 optionlist local_scan_options[] = {
33689   { "my_integer", opt_int,       &my_integer_option },
33690   { "my_string",  opt_stringptr, &my_string_option }
33691 };
33692
33693 int local_scan_options_count =
33694   sizeof(local_scan_options)/sizeof(optionlist);
33695 .endd
33696 The values of the variables can now be changed from Exim's runtime
33697 configuration file by including a local scan section as in this example:
33698 .code
33699 begin local_scan
33700 my_integer = 99
33701 my_string = some string of text...
33702 .endd
33703 The available types of option data are as follows:
33704
33705 .vlist
33706 .vitem &*opt_bool*&
33707 This specifies a boolean (true/false) option. The address should point to a
33708 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33709 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33710 whether such a variable has been set at all, you can initialize it to
33711 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33712 values.)
33713
33714 .vitem &*opt_fixed*&
33715 This specifies a fixed point number, such as is used for load averages.
33716 The address should point to a variable of type &`int`&. The value is stored
33717 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33718
33719 .vitem &*opt_int*&
33720 This specifies an integer; the address should point to a variable of type
33721 &`int`&. The value may be specified in any of the integer formats accepted by
33722 Exim.
33723
33724 .vitem &*opt_mkint*&
33725 This is the same as &%opt_int%&, except that when such a value is output in a
33726 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33727 printed with the suffix K or M.
33728
33729 .vitem &*opt_octint*&
33730 This also specifies an integer, but the value is always interpreted as an
33731 octal integer, whether or not it starts with the digit zero, and it is
33732 always output in octal.
33733
33734 .vitem &*opt_stringptr*&
33735 This specifies a string value; the address must be a pointer to a
33736 variable that points to a string (for example, of type &`uschar *`&).
33737
33738 .vitem &*opt_time*&
33739 This specifies a time interval value. The address must point to a variable of
33740 type &`int`&. The value that is placed there is a number of seconds.
33741 .endlist
33742
33743 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33744 out the values of all the &[local_scan()]& options.
33745
33746
33747
33748 .section "Available Exim variables" "SECID208"
33749 .cindex "&[local_scan()]& function" "available Exim variables"
33750 The header &_local_scan.h_& gives you access to a number of C variables. These
33751 are the only ones that are guaranteed to be maintained from release to release.
33752 Note, however, that you can obtain the value of any Exim expansion variable,
33753 including &$recipients$&, by calling &'expand_string()'&. The exported
33754 C variables are as follows:
33755
33756 .vlist
33757 .vitem &*int&~body_linecount*&
33758 This variable contains the number of lines in the message's body.
33759 It is not valid if the &%spool_files_wireformat%& option is used.
33760
33761 .vitem &*int&~body_zerocount*&
33762 This variable contains the number of binary zero bytes in the message's body.
33763 It is not valid if the &%spool_files_wireformat%& option is used.
33764
33765 .vitem &*unsigned&~int&~debug_selector*&
33766 This variable is set to zero when no debugging is taking place. Otherwise, it
33767 is a bitmap of debugging selectors. Two bits are identified for use in
33768 &[local_scan()]&; they are defined as macros:
33769
33770 .ilist
33771 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33772 testing option that is not privileged &-- any caller may set it. All the
33773 other selector bits can be set only by admin users.
33774
33775 .next
33776 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33777 by the &`+local_scan`& debug selector. It is not included in the default set
33778 of debugging bits.
33779 .endlist ilist
33780
33781 Thus, to write to the debugging output only when &`+local_scan`& has been
33782 selected, you should use code like this:
33783 .code
33784 if ((debug_selector & D_local_scan) != 0)
33785   debug_printf("xxx", ...);
33786 .endd
33787 .vitem &*uschar&~*expand_string_message*&
33788 After a failing call to &'expand_string()'& (returned value NULL), the
33789 variable &%expand_string_message%& contains the error message, zero-terminated.
33790
33791 .vitem &*header_line&~*header_list*&
33792 A pointer to a chain of header lines. The &%header_line%& structure is
33793 discussed below.
33794
33795 .vitem &*header_line&~*header_last*&
33796 A pointer to the last of the header lines.
33797
33798 .vitem &*uschar&~*headers_charset*&
33799 The value of the &%headers_charset%& configuration option.
33800
33801 .vitem &*BOOL&~host_checking*&
33802 This variable is TRUE during a host checking session that is initiated by the
33803 &%-bh%& command line option.
33804
33805 .vitem &*uschar&~*interface_address*&
33806 The IP address of the interface that received the message, as a string. This
33807 is NULL for locally submitted messages.
33808
33809 .vitem &*int&~interface_port*&
33810 The port on which this message was received. When testing with the &%-bh%&
33811 command line option, the value of this variable is -1 unless a port has been
33812 specified via the &%-oMi%& option.
33813
33814 .vitem &*uschar&~*message_id*&
33815 This variable contains Exim's message id for the incoming message (the value of
33816 &$message_exim_id$&) as a zero-terminated string.
33817
33818 .vitem &*uschar&~*received_protocol*&
33819 The name of the protocol by which the message was received.
33820
33821 .vitem &*int&~recipients_count*&
33822 The number of accepted recipients.
33823
33824 .vitem &*recipient_item&~*recipients_list*&
33825 .cindex "recipient" "adding in local scan"
33826 .cindex "recipient" "removing in local scan"
33827 The list of accepted recipients, held in a vector of length
33828 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33829 can add additional recipients by calling &'receive_add_recipient()'& (see
33830 below). You can delete recipients by removing them from the vector and
33831 adjusting the value in &%recipients_count%&. In particular, by setting
33832 &%recipients_count%& to zero you remove all recipients. If you then return the
33833 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33834 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33835 and then call &'receive_add_recipient()'& as often as needed.
33836
33837 .vitem &*uschar&~*sender_address*&
33838 The envelope sender address. For bounce messages this is the empty string.
33839
33840 .vitem &*uschar&~*sender_host_address*&
33841 The IP address of the sending host, as a string. This is NULL for
33842 locally-submitted messages.
33843
33844 .vitem &*uschar&~*sender_host_authenticated*&
33845 The name of the authentication mechanism that was used, or NULL if the message
33846 was not received over an authenticated SMTP connection.
33847
33848 .vitem &*uschar&~*sender_host_name*&
33849 The name of the sending host, if known.
33850
33851 .vitem &*int&~sender_host_port*&
33852 The port on the sending host.
33853
33854 .vitem &*BOOL&~smtp_input*&
33855 This variable is TRUE for all SMTP input, including BSMTP.
33856
33857 .vitem &*BOOL&~smtp_batched_input*&
33858 This variable is TRUE for BSMTP input.
33859
33860 .vitem &*int&~store_pool*&
33861 The contents of this variable control which pool of memory is used for new
33862 requests. See section &<<SECTmemhanloc>>& for details.
33863 .endlist
33864
33865
33866 .section "Structure of header lines" "SECID209"
33867 The &%header_line%& structure contains the members listed below.
33868 You can add additional header lines by calling the &'header_add()'& function
33869 (see below). You can cause header lines to be ignored (deleted) by setting
33870 their type to *.
33871
33872
33873 .vlist
33874 .vitem &*struct&~header_line&~*next*&
33875 A pointer to the next header line, or NULL for the last line.
33876
33877 .vitem &*int&~type*&
33878 A code identifying certain headers that Exim recognizes. The codes are printing
33879 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33880 Notice in particular that any header line whose type is * is not transmitted
33881 with the message. This flagging is used for header lines that have been
33882 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33883 lines.) Effectively, * means &"deleted"&.
33884
33885 .vitem &*int&~slen*&
33886 The number of characters in the header line, including the terminating and any
33887 internal newlines.
33888
33889 .vitem &*uschar&~*text*&
33890 A pointer to the text of the header. It always ends with a newline, followed by
33891 a zero byte. Internal newlines are preserved.
33892 .endlist
33893
33894
33895
33896 .section "Structure of recipient items" "SECID210"
33897 The &%recipient_item%& structure contains these members:
33898
33899 .vlist
33900 .vitem &*uschar&~*address*&
33901 This is a pointer to the recipient address as it was received.
33902
33903 .vitem &*int&~pno*&
33904 This is used in later Exim processing when top level addresses are created by
33905 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33906 and must always contain -1 at this stage.
33907
33908 .vitem &*uschar&~*errors_to*&
33909 If this value is not NULL, bounce messages caused by failing to deliver to the
33910 recipient are sent to the address it contains. In other words, it overrides the
33911 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33912 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33913 an unqualified address, Exim qualifies it using the domain from
33914 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33915 is NULL for all recipients.
33916 .endlist
33917
33918
33919
33920 .section "Available Exim functions" "SECID211"
33921 .cindex "&[local_scan()]& function" "available Exim functions"
33922 The header &_local_scan.h_& gives you access to a number of Exim functions.
33923 These are the only ones that are guaranteed to be maintained from release to
33924 release:
33925
33926 .vlist
33927 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33928        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33929
33930 This function creates a child process that runs the command specified by
33931 &%argv%&. The environment for the process is specified by &%envp%&, which can
33932 be NULL if no environment variables are to be passed. A new umask is supplied
33933 for the process in &%newumask%&.
33934
33935 Pipes to the standard input and output of the new process are set up
33936 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33937 standard error is cloned to the standard output. If there are any file
33938 descriptors &"in the way"& in the new process, they are closed. If the final
33939 argument is TRUE, the new process is made into a process group leader.
33940
33941 The function returns the pid of the new process, or -1 if things go wrong.
33942
33943 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33944 This function waits for a child process to terminate, or for a timeout (in
33945 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33946 return value is as follows:
33947
33948 .ilist
33949 >= 0
33950
33951 The process terminated by a normal exit and the value is the process
33952 ending status.
33953
33954 .next
33955 < 0 and > &--256
33956
33957 The process was terminated by a signal and the value is the negation of the
33958 signal number.
33959
33960 .next
33961 &--256
33962
33963 The process timed out.
33964 .next
33965 &--257
33966
33967 The was some other error in wait(); &%errno%& is still set.
33968 .endlist
33969
33970 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33971 This function provide you with a means of submitting a new message to
33972 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33973 want, but this packages it all up for you.) The function creates a pipe,
33974 forks a subprocess that is running
33975 .code
33976 exim -t -oem -oi -f <>
33977 .endd
33978 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33979 that is connected to the standard input. The yield of the function is the PID
33980 of the subprocess. You can then write a message to the file descriptor, with
33981 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33982
33983 When you have finished, call &'child_close()'& to wait for the process to
33984 finish and to collect its ending status. A timeout value of zero is usually
33985 fine in this circumstance. Unless you have made a mistake with the recipient
33986 addresses, you should get a return code of zero.
33987
33988
33989 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33990        *sender_authentication)*&
33991 This function is a more sophisticated version of &'child_open()'&. The command
33992 that it runs is:
33993 .display
33994 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33995 .endd
33996 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33997
33998
33999 .vitem &*void&~debug_printf(char&~*,&~...)*&
34000 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34001 output is written to the standard error stream. If no debugging is selected,
34002 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34003 conditional on the &`local_scan`& debug selector by coding like this:
34004 .code
34005 if ((debug_selector & D_local_scan) != 0)
34006   debug_printf("xxx", ...);
34007 .endd
34008
34009 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34010 This is an interface to Exim's string expansion code. The return value is the
34011 expanded string, or NULL if there was an expansion failure.
34012 The C variable &%expand_string_message%& contains an error message after an
34013 expansion failure. If expansion does not change the string, the return value is
34014 the pointer to the input string. Otherwise, the return value points to a new
34015 block of memory that was obtained by a call to &'store_get()'&. See section
34016 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34017
34018 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34019 This function allows you to an add additional header line at the end of the
34020 existing ones. The first argument is the type, and should normally be a space
34021 character. The second argument is a format string and any number of
34022 substitution arguments as for &[sprintf()]&. You may include internal newlines
34023 if you want, and you must ensure that the string ends with a newline.
34024
34025 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34026         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34027 This function adds a new header line at a specified point in the header
34028 chain. The header itself is specified as for &'header_add()'&.
34029
34030 If &%name%& is NULL, the new header is added at the end of the chain if
34031 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34032 NULL, the header lines are searched for the first non-deleted header that
34033 matches the name. If one is found, the new header is added before it if
34034 &%after%& is false. If &%after%& is true, the new header is added after the
34035 found header and any adjacent subsequent ones with the same name (even if
34036 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34037 option controls where the header is added. If it is true, addition is at the
34038 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34039 headers, or at the top if there are no &'Received:'& headers, you could use
34040 .code
34041 header_add_at_position(TRUE, US"Received", TRUE,
34042   ' ', "X-xxx: ...");
34043 .endd
34044 Normally, there is always at least one non-deleted &'Received:'& header, but
34045 there may not be if &%received_header_text%& expands to an empty string.
34046
34047
34048 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34049 This function removes header lines. If &%occurrence%& is zero or negative, all
34050 occurrences of the header are removed. If occurrence is greater than zero, that
34051 particular instance of the header is removed. If no header(s) can be found that
34052 match the specification, the function does nothing.
34053
34054
34055 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34056         int&~length,&~BOOL&~notdel)*&"
34057 This function tests whether the given header has the given name. It is not just
34058 a string comparison, because white space is permitted between the name and the
34059 colon. If the &%notdel%& argument is true, a false return is forced for all
34060 &"deleted"& headers; otherwise they are not treated specially. For example:
34061 .code
34062 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34063 .endd
34064 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34065 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34066 This function base64-encodes a string, which is passed by address and length.
34067 The text may contain bytes of any value, including zero. The result is passed
34068 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34069 zero-terminated.
34070
34071 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34072 This function decodes a base64-encoded string. Its arguments are a
34073 zero-terminated base64-encoded string and the address of a variable that is set
34074 to point to the result, which is in dynamic memory. The length of the decoded
34075 string is the yield of the function. If the input is invalid base64 data, the
34076 yield is -1. A zero byte is added to the end of the output string to make it
34077 easy to interpret as a C string (assuming it contains no zeros of its own). The
34078 added zero byte is not included in the returned count.
34079
34080 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34081 This function checks for a match in a domain list. Domains are always
34082 matched caselessly. The return value is one of the following:
34083 .display
34084 &`OK     `& match succeeded
34085 &`FAIL   `& match failed
34086 &`DEFER  `& match deferred
34087 .endd
34088 DEFER is usually caused by some kind of lookup defer, such as the
34089 inability to contact a database.
34090
34091 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34092         BOOL&~caseless)*&"
34093 This function checks for a match in a local part list. The third argument
34094 controls case-sensitivity. The return values are as for
34095 &'lss_match_domain()'&.
34096
34097 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34098         BOOL&~caseless)*&"
34099 This function checks for a match in an address list. The third argument
34100 controls the case-sensitivity of the local part match. The domain is always
34101 matched caselessly. The return values are as for &'lss_match_domain()'&.
34102
34103 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34104         uschar&~*list)*&"
34105 This function checks for a match in a host list. The most common usage is
34106 expected to be
34107 .code
34108 lss_match_host(sender_host_name, sender_host_address, ...)
34109 .endd
34110 .vindex "&$sender_host_address$&"
34111 An empty address field matches an empty item in the host list. If the host name
34112 is NULL, the name corresponding to &$sender_host_address$& is automatically
34113 looked up if a host name is required to match an item in the list. The return
34114 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34115 returns ERROR in the case when it had to look up a host name, but the lookup
34116 failed.
34117
34118 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34119         *format,&~...)*&"
34120 This function writes to Exim's log files. The first argument should be zero (it
34121 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34122 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34123 them. It specifies to which log or logs the message is written. The remaining
34124 arguments are a format and relevant insertion arguments. The string should not
34125 contain any newlines, not even at the end.
34126
34127
34128 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34129 This function adds an additional recipient to the message. The first argument
34130 is the recipient address. If it is unqualified (has no domain), it is qualified
34131 with the &%qualify_recipient%& domain. The second argument must always be -1.
34132
34133 This function does not allow you to specify a private &%errors_to%& address (as
34134 described with the structure of &%recipient_item%& above), because it pre-dates
34135 the addition of that field to the structure. However, it is easy to add such a
34136 value afterwards. For example:
34137 .code
34138  receive_add_recipient(US"monitor@mydom.example", -1);
34139  recipients_list[recipients_count-1].errors_to =
34140    US"postmaster@mydom.example";
34141 .endd
34142
34143 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34144 This is a convenience function to remove a named recipient from the list of
34145 recipients. It returns true if a recipient was removed, and false if no
34146 matching recipient could be found. The argument must be a complete email
34147 address.
34148 .endlist
34149
34150
34151 .cindex "RFC 2047"
34152 .vlist
34153 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34154   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34155 This function decodes strings that are encoded according to RFC 2047. Typically
34156 these are the contents of header lines. First, each &"encoded word"& is decoded
34157 from the Q or B encoding into a byte-string. Then, if provided with the name of
34158 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34159 made  to translate the result to the named character set. If this fails, the
34160 binary string is returned with an error message.
34161
34162 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34163 maximum MIME word length is enforced. The third argument is the target
34164 encoding, or NULL if no translation is wanted.
34165
34166 .cindex "binary zero" "in RFC 2047 decoding"
34167 .cindex "RFC 2047" "binary zero in"
34168 If a binary zero is encountered in the decoded string, it is replaced by the
34169 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34170 not be 0 because header lines are handled as zero-terminated strings.
34171
34172 The function returns the result of processing the string, zero-terminated; if
34173 &%lenptr%& is not NULL, the length of the result is set in the variable to
34174 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34175
34176 If an error is encountered, the function returns NULL and uses the &%error%&
34177 argument to return an error message. The variable pointed to by &%error%& is
34178 set to NULL if there is no error; it may be set non-NULL even when the function
34179 returns a non-NULL value if decoding was successful, but there was a problem
34180 with translation.
34181
34182
34183 .vitem &*int&~smtp_fflush(void)*&
34184 This function is used in conjunction with &'smtp_printf()'&, as described
34185 below.
34186
34187 .vitem &*void&~smtp_printf(char&~*,&~...)*&
34188 The arguments of this function are like &[printf()]&; it writes to the SMTP
34189 output stream. You should use this function only when there is an SMTP output
34190 stream, that is, when the incoming message is being received via interactive
34191 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34192 is FALSE. If you want to test for an incoming message from another host (as
34193 opposed to a local process that used the &%-bs%& command line option), you can
34194 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34195 is involved.
34196
34197 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34198 output function, so it can be used for all forms of SMTP connection.
34199
34200 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34201 must start with an appropriate response code: 550 if you are going to return
34202 LOCAL_SCAN_REJECT, 451 if you are going to return
34203 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34204 initial lines of a multi-line response, the code must be followed by a hyphen
34205 to indicate that the line is not the final response line. You must also ensure
34206 that the lines you write terminate with CRLF. For example:
34207 .code
34208 smtp_printf("550-this is some extra info\r\n");
34209 return LOCAL_SCAN_REJECT;
34210 .endd
34211 Note that you can also create multi-line responses by including newlines in
34212 the data returned via the &%return_text%& argument. The added value of using
34213 &'smtp_printf()'& is that, for instance, you could introduce delays between
34214 multiple output lines.
34215
34216 The &'smtp_printf()'& function does not return any error indication, because it
34217 does not automatically flush pending output, and therefore does not test
34218 the state of the stream. (In the main code of Exim, flushing and error
34219 detection is done when Exim is ready for the next SMTP input command.) If
34220 you want to flush the output and check for an error (for example, the
34221 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34222 arguments. It flushes the output stream, and returns a non-zero value if there
34223 is an error.
34224
34225 .vitem &*void&~*store_get(int)*&
34226 This function accesses Exim's internal store (memory) manager. It gets a new
34227 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34228 runs out of memory. See the next section for a discussion of memory handling.
34229
34230 .vitem &*void&~*store_get_perm(int)*&
34231 This function is like &'store_get()'&, but it always gets memory from the
34232 permanent pool. See the next section for a discussion of memory handling.
34233
34234 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34235 See below.
34236
34237 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34238 See below.
34239
34240 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34241 These three functions create strings using Exim's dynamic memory facilities.
34242 The first makes a copy of an entire string. The second copies up to a maximum
34243 number of characters, indicated by the second argument. The third uses a format
34244 and insertion arguments to create a new string. In each case, the result is a
34245 pointer to a new string in the current memory pool. See the next section for
34246 more discussion.
34247 .endlist
34248
34249
34250
34251 .section "More about Exim's memory handling" "SECTmemhanloc"
34252 .cindex "&[local_scan()]& function" "memory handling"
34253 No function is provided for freeing memory, because that is never needed.
34254 The dynamic memory that Exim uses when receiving a message is automatically
34255 recycled if another message is received by the same process (this applies only
34256 to incoming SMTP connections &-- other input methods can supply only one
34257 message at a time). After receiving the last message, a reception process
34258 terminates.
34259
34260 Because it is recycled, the normal dynamic memory cannot be used for holding
34261 data that must be preserved over a number of incoming messages on the same SMTP
34262 connection. However, Exim in fact uses two pools of dynamic memory; the second
34263 one is not recycled, and can be used for this purpose.
34264
34265 If you want to allocate memory that remains available for subsequent messages
34266 in the same SMTP connection, you should set
34267 .code
34268 store_pool = POOL_PERM
34269 .endd
34270 before calling the function that does the allocation. There is no need to
34271 restore the value if you do not need to; however, if you do want to revert to
34272 the normal pool, you can either restore the previous value of &%store_pool%& or
34273 set it explicitly to POOL_MAIN.
34274
34275 The pool setting applies to all functions that get dynamic memory, including
34276 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34277 There is also a convenience function called &'store_get_perm()'& that gets a
34278 block of memory from the permanent pool while preserving the value of
34279 &%store_pool%&.
34280 .ecindex IIDlosca
34281
34282
34283
34284
34285 . ////////////////////////////////////////////////////////////////////////////
34286 . ////////////////////////////////////////////////////////////////////////////
34287
34288 .chapter "System-wide message filtering" "CHAPsystemfilter"
34289 .scindex IIDsysfil1 "filter" "system filter"
34290 .scindex IIDsysfil2 "filtering all mail"
34291 .scindex IIDsysfil3 "system filter"
34292 The previous chapters (on ACLs and the local scan function) describe checks
34293 that can be applied to messages before they are accepted by a host. There is
34294 also a mechanism for checking messages once they have been received, but before
34295 they are delivered. This is called the &'system filter'&.
34296
34297 The system filter operates in a similar manner to users' filter files, but it
34298 is run just once per message (however many recipients the message has).
34299 It should not normally be used as a substitute for routing, because &%deliver%&
34300 commands in a system router provide new envelope recipient addresses.
34301 The system filter must be an Exim filter. It cannot be a Sieve filter.
34302
34303 The system filter is run at the start of a delivery attempt, before any routing
34304 is done. If a message fails to be completely delivered at the first attempt,
34305 the system filter is run again at the start of every retry.
34306 If you want your filter to do something only once per message, you can make use
34307 of the &%first_delivery%& condition in an &%if%& command in the filter to
34308 prevent it happening on retries.
34309
34310 .vindex "&$domain$&"
34311 .vindex "&$local_part$&"
34312 &*Warning*&: Because the system filter runs just once, variables that are
34313 specific to individual recipient addresses, such as &$local_part$& and
34314 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34315 you want to run a centrally-specified filter for each recipient address
34316 independently, you can do so by setting up a suitable &(redirect)& router, as
34317 described in section &<<SECTperaddfil>>& below.
34318
34319
34320 .section "Specifying a system filter" "SECID212"
34321 .cindex "uid (user id)" "system filter"
34322 .cindex "gid (group id)" "system filter"
34323 The name of the file that contains the system filter must be specified by
34324 setting &%system_filter%&. If you want the filter to run under a uid and gid
34325 other than root, you must also set &%system_filter_user%& and
34326 &%system_filter_group%& as appropriate. For example:
34327 .code
34328 system_filter = /etc/mail/exim.filter
34329 system_filter_user = exim
34330 .endd
34331 If a system filter generates any deliveries directly to files or pipes (via the
34332 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34333 specified by setting &%system_filter_file_transport%& and
34334 &%system_filter_pipe_transport%&, respectively. Similarly,
34335 &%system_filter_reply_transport%& must be set to handle any messages generated
34336 by the &%reply%& command.
34337
34338
34339 .section "Testing a system filter" "SECID213"
34340 You can run simple tests of a system filter in the same way as for a user
34341 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34342 are permitted only in system filters are recognized.
34343
34344 If you want to test the combined effect of a system filter and a user filter,
34345 you can use both &%-bF%& and &%-bf%& on the same command line.
34346
34347
34348
34349 .section "Contents of a system filter" "SECID214"
34350 The language used to specify system filters is the same as for users' filter
34351 files. It is described in the separate end-user document &'Exim's interface to
34352 mail filtering'&. However, there are some additional features that are
34353 available only in system filters; these are described in subsequent sections.
34354 If they are encountered in a user's filter file or when testing with &%-bf%&,
34355 they cause errors.
34356
34357 .cindex "frozen messages" "manual thaw; testing in filter"
34358 There are two special conditions which, though available in users' filter
34359 files, are designed for use in system filters. The condition &%first_delivery%&
34360 is true only for the first attempt at delivering a message, and
34361 &%manually_thawed%& is true only if the message has been frozen, and
34362 subsequently thawed by an admin user. An explicit forced delivery counts as a
34363 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34364
34365 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34366 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34367 succeed, it will not be tried again.
34368 If you want Exim to retry an unseen delivery until it succeeds, you should
34369 arrange to set it up every time the filter runs.
34370
34371 When a system filter finishes running, the values of the variables &$n0$& &--
34372 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34373 users' filter files. Thus a system filter can, for example, set up &"scores"&
34374 to which users' filter files can refer.
34375
34376
34377
34378 .section "Additional variable for system filters" "SECID215"
34379 .vindex "&$recipients$&"
34380 The expansion variable &$recipients$&, containing a list of all the recipients
34381 of the message (separated by commas and white space), is available in system
34382 filters. It is not available in users' filters for privacy reasons.
34383
34384
34385
34386 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34387 .cindex "freezing messages"
34388 .cindex "message" "freezing"
34389 .cindex "message" "forced failure"
34390 .cindex "&%fail%&" "in system filter"
34391 .cindex "&%freeze%& in system filter"
34392 .cindex "&%defer%& in system filter"
34393 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34394 always available in system filters, but are not normally enabled in users'
34395 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34396 for the &(redirect)& router.) These commands can optionally be followed by the
34397 word &%text%& and a string containing an error message, for example:
34398 .code
34399 fail text "this message looks like spam to me"
34400 .endd
34401 The keyword &%text%& is optional if the next character is a double quote.
34402
34403 The &%defer%& command defers delivery of the original recipients of the
34404 message. The &%fail%& command causes all the original recipients to be failed,
34405 and a bounce message to be created. The &%freeze%& command suspends all
34406 delivery attempts for the original recipients. In all cases, any new deliveries
34407 that are specified by the filter are attempted as normal after the filter has
34408 run.
34409
34410 The &%freeze%& command is ignored if the message has been manually unfrozen and
34411 not manually frozen since. This means that automatic freezing by a system
34412 filter can be used as a way of checking out suspicious messages. If a message
34413 is found to be all right, manually unfreezing it allows it to be delivered.
34414
34415 .cindex "log" "&%fail%& command log line"
34416 .cindex "&%fail%&" "log line; reducing"
34417 The text given with a fail command is used as part of the bounce message as
34418 well as being written to the log. If the message is quite long, this can fill
34419 up a lot of log space when such failures are common. To reduce the size of the
34420 log message, Exim interprets the text in a special way if it starts with the
34421 two characters &`<<`& and contains &`>>`& later. The text between these two
34422 strings is written to the log, and the rest of the text is used in the bounce
34423 message. For example:
34424 .code
34425 fail "<<filter test 1>>Your message is rejected \
34426      because it contains attachments that we are \
34427      not prepared to receive."
34428 .endd
34429
34430 .cindex "loop" "caused by &%fail%&"
34431 Take great care with the &%fail%& command when basing the decision to fail on
34432 the contents of the message, because the bounce message will of course include
34433 the contents of the original message and will therefore trigger the &%fail%&
34434 command again (causing a mail loop) unless steps are taken to prevent this.
34435 Testing the &%error_message%& condition is one way to prevent this. You could
34436 use, for example
34437 .code
34438 if $message_body contains "this is spam" and not error_message
34439 then fail text "spam is not wanted here" endif
34440 .endd
34441 though of course that might let through unwanted bounce messages. The
34442 alternative is clever checking of the body and/or headers to detect bounces
34443 generated by the filter.
34444
34445 The interpretation of a system filter file ceases after a
34446 &%defer%&,
34447 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34448 set up earlier in the filter file are honoured, so you can use a sequence such
34449 as
34450 .code
34451 mail ...
34452 freeze
34453 .endd
34454 to send a specified message when the system filter is freezing (or deferring or
34455 failing) a message. The normal deliveries for the message do not, of course,
34456 take place.
34457
34458
34459
34460 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34461 .cindex "header lines" "adding; in system filter"
34462 .cindex "header lines" "removing; in system filter"
34463 .cindex "filter" "header lines; adding/removing"
34464 Two filter commands that are available only in system filters are:
34465 .code
34466 headers add <string>
34467 headers remove <string>
34468 .endd
34469 The argument for the &%headers add%& is a string that is expanded and then
34470 added to the end of the message's headers. It is the responsibility of the
34471 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34472 space is ignored, and if the string is otherwise empty, or if the expansion is
34473 forced to fail, the command has no effect.
34474
34475 You can use &"\n"& within the string, followed by white space, to specify
34476 continued header lines. More than one header may be added in one command by
34477 including &"\n"& within the string without any following white space. For
34478 example:
34479 .code
34480 headers add "X-header-1: ....\n  \
34481              continuation of X-header-1 ...\n\
34482              X-header-2: ...."
34483 .endd
34484 Note that the header line continuation white space after the first newline must
34485 be placed before the backslash that continues the input string, because white
34486 space after input continuations is ignored.
34487
34488 The argument for &%headers remove%& is a colon-separated list of header names.
34489 This command applies only to those headers that are stored with the message;
34490 those that are added at delivery time (such as &'Envelope-To:'& and
34491 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34492 header with the same name, they are all removed.
34493
34494 The &%headers%& command in a system filter makes an immediate change to the set
34495 of header lines that was received with the message (with possible additions
34496 from ACL processing). Subsequent commands in the system filter operate on the
34497 modified set, which also forms the basis for subsequent message delivery.
34498 Unless further modified during routing or transporting, this set of headers is
34499 used for all recipients of the message.
34500
34501 During routing and transporting, the variables that refer to the contents of
34502 header lines refer only to those lines that are in this set. Thus, header lines
34503 that are added by a system filter are visible to users' filter files and to all
34504 routers and transports. This contrasts with the manipulation of header lines by
34505 routers and transports, which is not immediate, but which instead is saved up
34506 until the message is actually being written (see section
34507 &<<SECTheadersaddrem>>&).
34508
34509 If the message is not delivered at the first attempt, header lines that were
34510 added by the system filter are stored with the message, and so are still
34511 present at the next delivery attempt. Header lines that were removed are still
34512 present, but marked &"deleted"& so that they are not transported with the
34513 message. For this reason, it is usual to make the &%headers%& command
34514 conditional on &%first_delivery%& so that the set of header lines is not
34515 modified more than once.
34516
34517 Because header modification in a system filter acts immediately, you have to
34518 use an indirect approach if you want to modify the contents of a header line.
34519 For example:
34520 .code
34521 headers add "Old-Subject: $h_subject:"
34522 headers remove "Subject"
34523 headers add "Subject: new subject (was: $h_old-subject:)"
34524 headers remove "Old-Subject"
34525 .endd
34526
34527
34528
34529 .section "Setting an errors address in a system filter" "SECID217"
34530 .cindex "envelope from"
34531 .cindex "envelope sender"
34532 In a system filter, if a &%deliver%& command is followed by
34533 .code
34534 errors_to <some address>
34535 .endd
34536 in order to change the envelope sender (and hence the error reporting) for that
34537 delivery, any address may be specified. (In a user filter, only the current
34538 user's address can be set.) For example, if some mail is being monitored, you
34539 might use
34540 .code
34541 unseen deliver monitor@spying.example errors_to root@local.example
34542 .endd
34543 to take a copy which would not be sent back to the normal error reporting
34544 address if its delivery failed.
34545
34546
34547
34548 .section "Per-address filtering" "SECTperaddfil"
34549 .vindex "&$domain$&"
34550 .vindex "&$local_part$&"
34551 In contrast to the system filter, which is run just once per message for each
34552 delivery attempt, it is also possible to set up a system-wide filtering
34553 operation that runs once for each recipient address. In this case, variables
34554 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34555 filter file could be made dependent on them. This is an example of a router
34556 which implements such a filter:
34557 .code
34558 central_filter:
34559   check_local_user
34560   driver = redirect
34561   domains = +local_domains
34562   file = /central/filters/$local_part
34563   no_verify
34564   allow_filter
34565   allow_freeze
34566 .endd
34567 The filter is run in a separate process under its own uid. Therefore, either
34568 &%check_local_user%& must be set (as above), in which case the filter is run as
34569 the local user, or the &%user%& option must be used to specify which user to
34570 use. If both are set, &%user%& overrides.
34571
34572 Care should be taken to ensure that none of the commands in the filter file
34573 specify a significant delivery if the message is to go on to be delivered to
34574 its intended recipient. The router will not then claim to have dealt with the
34575 address, so it will be passed on to subsequent routers to be delivered in the
34576 normal way.
34577 .ecindex IIDsysfil1
34578 .ecindex IIDsysfil2
34579 .ecindex IIDsysfil3
34580
34581
34582
34583
34584
34585
34586 . ////////////////////////////////////////////////////////////////////////////
34587 . ////////////////////////////////////////////////////////////////////////////
34588
34589 .chapter "Message processing" "CHAPmsgproc"
34590 .scindex IIDmesproc "message" "general processing"
34591 Exim performs various transformations on the sender and recipient addresses of
34592 all messages that it handles, and also on the messages' header lines. Some of
34593 these are optional and configurable, while others always take place. All of
34594 this processing, except rewriting as a result of routing, and the addition or
34595 removal of header lines while delivering, happens when a message is received,
34596 before it is placed on Exim's queue.
34597
34598 Some of the automatic processing takes place by default only for
34599 &"locally-originated"& messages. This adjective is used to describe messages
34600 that are not received over TCP/IP, but instead are passed to an Exim process on
34601 its standard input. This includes the interactive &"local SMTP"& case that is
34602 set up by the &%-bs%& command line option.
34603
34604 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34605 or ::1) are not considered to be locally-originated. Exim does not treat the
34606 loopback interface specially in any way.
34607
34608 If you want the loopback interface to be treated specially, you must ensure
34609 that there are appropriate entries in your ACLs.
34610
34611
34612
34613
34614 .section "Submission mode for non-local messages" "SECTsubmodnon"
34615 .cindex "message" "submission"
34616 .cindex "submission mode"
34617 Processing that happens automatically for locally-originated messages (unless
34618 &%suppress_local_fixups%& is set) can also be requested for messages that are
34619 received over TCP/IP. The term &"submission mode"& is used to describe this
34620 state. Submission mode is set by the modifier
34621 .code
34622 control = submission
34623 .endd
34624 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34625 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34626 a local submission, and is normally used when the source of the message is
34627 known to be an MUA running on a client host (as opposed to an MTA). For
34628 example, to set submission mode for messages originating on the IPv4 loopback
34629 interface, you could include the following in the MAIL ACL:
34630 .code
34631 warn  hosts = 127.0.0.1
34632       control = submission
34633 .endd
34634 .cindex "&%sender_retain%& submission option"
34635 There are some options that can be used when setting submission mode. A slash
34636 is used to separate options. For example:
34637 .code
34638 control = submission/sender_retain
34639 .endd
34640 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34641 true and &%local_from_check%& false for the current incoming message. The first
34642 of these allows an existing &'Sender:'& header in the message to remain, and
34643 the second suppresses the check to ensure that &'From:'& matches the
34644 authenticated sender. With this setting, Exim still fixes up messages by adding
34645 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34646 attempt to check sender authenticity in header lines.
34647
34648 When &%sender_retain%& is not set, a submission mode setting may specify a
34649 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34650 example:
34651 .code
34652 control = submission/domain=some.domain
34653 .endd
34654 The domain may be empty. How this value is used is described in sections
34655 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34656 that allows you to specify the user's full name for inclusion in a created
34657 &'Sender:'& or &'From:'& header line. For example:
34658 .code
34659 accept authenticated = *
34660        control = submission/domain=wonderland.example/\
34661                             name=${lookup {$authenticated_id} \
34662                                    lsearch {/etc/exim/namelist}}
34663 .endd
34664 Because the name may contain any characters, including slashes, the &%name%&
34665 option must be given last. The remainder of the string is used as the name. For
34666 the example above, if &_/etc/exim/namelist_& contains:
34667 .code
34668 bigegg:  Humpty Dumpty
34669 .endd
34670 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34671 line would be:
34672 .code
34673 Sender: Humpty Dumpty <bigegg@wonderland.example>
34674 .endd
34675 .cindex "return path" "in submission mode"
34676 By default, submission mode forces the return path to the same address as is
34677 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34678 specified, the return path is also left unchanged.
34679
34680 &*Note*&: The changes caused by submission mode take effect after the predata
34681 ACL. This means that any sender checks performed before the fix-ups use the
34682 untrusted sender address specified by the user, not the trusted sender address
34683 specified by submission mode. Although this might be slightly unexpected, it
34684 does mean that you can configure ACL checks to spot that a user is trying to
34685 spoof another's address.
34686
34687 .section "Line endings" "SECTlineendings"
34688 .cindex "line endings"
34689 .cindex "carriage return"
34690 .cindex "linefeed"
34691 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34692 linefeed) is the line ending for messages transmitted over the Internet using
34693 SMTP over TCP/IP. However, within individual operating systems, different
34694 conventions are used. For example, Unix-like systems use just LF, but others
34695 use CRLF or just CR.
34696
34697 Exim was designed for Unix-like systems, and internally, it stores messages
34698 using the system's convention of a single LF as a line terminator. When
34699 receiving a message, all line endings are translated to this standard format.
34700 Originally, it was thought that programs that passed messages directly to an
34701 MTA within an operating system would use that system's convention. Experience
34702 has shown that this is not the case; for example, there are Unix applications
34703 that use CRLF in this circumstance. For this reason, and for compatibility with
34704 other MTAs, the way Exim handles line endings for all messages is now as
34705 follows:
34706
34707 .ilist
34708 LF not preceded by CR is treated as a line ending.
34709 .next
34710 CR is treated as a line ending; if it is immediately followed by LF, the LF
34711 is ignored.
34712 .next
34713 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34714 nor a local message in the state where a line containing only a dot is a
34715 terminator.
34716 .next
34717 If a bare CR is encountered within a header line, an extra space is added after
34718 the line terminator so as not to end the header line. The reasoning behind this
34719 is that bare CRs in header lines are most likely either to be mistakes, or
34720 people trying to play silly games.
34721 .next
34722 If the first header line received in a message ends with CRLF, a subsequent
34723 bare LF in a header line is treated in the same way as a bare CR in a header
34724 line.
34725 .endlist
34726
34727
34728
34729
34730
34731 .section "Unqualified addresses" "SECID218"
34732 .cindex "unqualified addresses"
34733 .cindex "address" "qualification"
34734 By default, Exim expects every envelope address it receives from an external
34735 host to be fully qualified. Unqualified addresses cause negative responses to
34736 SMTP commands. However, because SMTP is used as a means of transporting
34737 messages from MUAs running on personal workstations, there is sometimes a
34738 requirement to accept unqualified addresses from specific hosts or IP networks.
34739
34740 Exim has two options that separately control which hosts may send unqualified
34741 sender or recipient addresses in SMTP commands, namely
34742 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34743 cases, if an unqualified address is accepted, it is qualified by adding the
34744 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34745
34746 .oindex "&%qualify_domain%&"
34747 .oindex "&%qualify_recipient%&"
34748 Unqualified addresses in header lines are automatically qualified for messages
34749 that are locally originated, unless the &%-bnq%& option is given on the command
34750 line. For messages received over SMTP, unqualified addresses in header lines
34751 are qualified only if unqualified addresses are permitted in SMTP commands. In
34752 other words, such qualification is also controlled by
34753 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34754
34755
34756
34757
34758 .section "The UUCP From line" "SECID219"
34759 .cindex "&""From""& line"
34760 .cindex "UUCP" "&""From""& line"
34761 .cindex "sender" "address"
34762 .oindex "&%uucp_from_pattern%&"
34763 .oindex "&%uucp_from_sender%&"
34764 .cindex "envelope from"
34765 .cindex "envelope sender"
34766 .cindex "Sendmail compatibility" "&""From""& line"
34767 Messages that have come from UUCP (and some other applications) often begin
34768 with a line containing the envelope sender and a timestamp, following the word
34769 &"From"&. Examples of two common formats are:
34770 .code
34771 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34772 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34773 .endd
34774 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34775 Exim recognizes such lines at the start of messages that are submitted to it
34776 via the command line (that is, on the standard input). It does not recognize
34777 such lines in incoming SMTP messages, unless the sending host matches
34778 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34779 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34780 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34781 default value matches the two common cases shown above and puts the address
34782 that follows &"From"& into &$1$&.
34783
34784 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34785 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34786 a trusted user, the message's sender address is constructed by expanding the
34787 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34788 then parsed as an RFC 2822 address. If there is no domain, the local part is
34789 qualified with &%qualify_domain%& unless it is the empty string. However, if
34790 the command line &%-f%& option is used, it overrides the &"From"& line.
34791
34792 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34793 sender address is not changed. This is also the case for incoming SMTP messages
34794 that are permitted to contain &"From"& lines.
34795
34796 Only one &"From"& line is recognized. If there is more than one, the second is
34797 treated as a data line that starts the body of the message, as it is not valid
34798 as a header line. This also happens if a &"From"& line is present in an
34799 incoming SMTP message from a source that is not permitted to send them.
34800
34801
34802
34803 .section "Resent- header lines" "SECID220"
34804 .cindex "&%Resent-%& header lines"
34805 .cindex "header lines" "Resent-"
34806 RFC 2822 makes provision for sets of header lines starting with the string
34807 &`Resent-`& to be added to a message when it is resent by the original
34808 recipient to somebody else. These headers are &'Resent-Date:'&,
34809 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34810 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34811
34812 .blockquote
34813 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34814 processing of replies or other such automatic actions on messages.'&
34815 .endblockquote
34816
34817 This leaves things a bit vague as far as other processing actions such as
34818 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34819 follows:
34820
34821 .ilist
34822 A &'Resent-From:'& line that just contains the login id of the submitting user
34823 is automatically rewritten in the same way as &'From:'& (see below).
34824 .next
34825 If there's a rewriting rule for a particular header line, it is also applied to
34826 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34827 &'From:'& also rewrites &'Resent-From:'&.
34828 .next
34829 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34830 also removed.
34831 .next
34832 For a locally-submitted message,
34833 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34834 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34835 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34836 included in log lines in this case.
34837 .next
34838 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34839 &%Resent-%& header lines are present.
34840 .endlist
34841
34842
34843
34844
34845 .section "The Auto-Submitted: header line" "SECID221"
34846 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34847 includes the header line:
34848 .code
34849 Auto-Submitted: auto-replied
34850 .endd
34851
34852 .section "The Bcc: header line" "SECID222"
34853 .cindex "&'Bcc:'& header line"
34854 If Exim is called with the &%-t%& option, to take recipient addresses from a
34855 message's header, it removes any &'Bcc:'& header line that may exist (after
34856 extracting its addresses). If &%-t%& is not present on the command line, any
34857 existing &'Bcc:'& is not removed.
34858
34859
34860 .section "The Date: header line" "SECID223"
34861 .cindex "&'Date:'& header line"
34862 .cindex "header lines" "Date:"
34863 If a locally-generated or submission-mode message has no &'Date:'& header line,
34864 Exim adds one, using the current date and time, unless the
34865 &%suppress_local_fixups%& control has been specified.
34866
34867 .section "The Delivery-date: header line" "SECID224"
34868 .cindex "&'Delivery-date:'& header line"
34869 .oindex "&%delivery_date_remove%&"
34870 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34871 set. Exim can be configured to add them to the final delivery of messages. (See
34872 the generic &%delivery_date_add%& transport option.) They should not be present
34873 in messages in transit. If the &%delivery_date_remove%& configuration option is
34874 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34875 messages.
34876
34877
34878 .section "The Envelope-to: header line" "SECID225"
34879 .cindex "&'Envelope-to:'& header line"
34880 .cindex "header lines" "Envelope-to:"
34881 .oindex "&%envelope_to_remove%&"
34882 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34883 Exim can be configured to add them to the final delivery of messages. (See the
34884 generic &%envelope_to_add%& transport option.) They should not be present in
34885 messages in transit. If the &%envelope_to_remove%& configuration option is set
34886 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34887 messages.
34888
34889
34890 .section "The From: header line" "SECTthefrohea"
34891 .cindex "&'From:'& header line"
34892 .cindex "header lines" "From:"
34893 .cindex "Sendmail compatibility" "&""From""& line"
34894 .cindex "message" "submission"
34895 .cindex "submission mode"
34896 If a submission-mode message does not contain a &'From:'& header line, Exim
34897 adds one if either of the following conditions is true:
34898
34899 .ilist
34900 The envelope sender address is not empty (that is, this is not a bounce
34901 message). The added header line copies the envelope sender address.
34902 .next
34903 .vindex "&$authenticated_id$&"
34904 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34905 .olist
34906 .vindex "&$qualify_domain$&"
34907 If no domain is specified by the submission control, the local part is
34908 &$authenticated_id$& and the domain is &$qualify_domain$&.
34909 .next
34910 If a non-empty domain is specified by the submission control, the local
34911 part is &$authenticated_id$&, and the domain is the specified domain.
34912 .next
34913 If an empty domain is specified by the submission control,
34914 &$authenticated_id$& is assumed to be the complete address.
34915 .endlist
34916 .endlist
34917
34918 A non-empty envelope sender takes precedence.
34919
34920 If a locally-generated incoming message does not contain a &'From:'& header
34921 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34922 containing the sender's address. The calling user's login name and full name
34923 are used to construct the address, as described in section &<<SECTconstr>>&.
34924 They are obtained from the password data by calling &[getpwuid()]& (but see the
34925 &%unknown_login%& configuration option). The address is qualified with
34926 &%qualify_domain%&.
34927
34928 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34929 &'From:'& header line containing just the unqualified login name of the calling
34930 user, this is replaced by an address containing the user's login name and full
34931 name as described in section &<<SECTconstr>>&.
34932
34933
34934 .section "The Message-ID: header line" "SECID226"
34935 .cindex "&'Message-ID:'& header line"
34936 .cindex "header lines" "Message-ID:"
34937 .cindex "message" "submission"
34938 .oindex "&%message_id_header_text%&"
34939 If a locally-generated or submission-mode incoming message does not contain a
34940 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34941 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34942 to the message. If there are any &'Resent-:'& headers in the message, it
34943 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34944 message id, preceded by the letter E to ensure it starts with a letter, and
34945 followed by @ and the primary host name. Additional information can be included
34946 in this header line by setting the &%message_id_header_text%& and/or
34947 &%message_id_header_domain%& options.
34948
34949
34950 .section "The Received: header line" "SECID227"
34951 .cindex "&'Received:'& header line"
34952 .cindex "header lines" "Received:"
34953 A &'Received:'& header line is added at the start of every message. The
34954 contents are defined by the &%received_header_text%& configuration option, and
34955 Exim automatically adds a semicolon and a timestamp to the configured string.
34956
34957 The &'Received:'& header is generated as soon as the message's header lines
34958 have been received. At this stage, the timestamp in the &'Received:'& header
34959 line is the time that the message started to be received. This is the value
34960 that is seen by the DATA ACL and by the &[local_scan()]& function.
34961
34962 Once a message is accepted, the timestamp in the &'Received:'& header line is
34963 changed to the time of acceptance, which is (apart from a small delay while the
34964 -H spool file is written) the earliest time at which delivery could start.
34965
34966
34967 .section "The References: header line" "SECID228"
34968 .cindex "&'References:'& header line"
34969 .cindex "header lines" "References:"
34970 Messages created by the &(autoreply)& transport include a &'References:'&
34971 header line. This is constructed according to the rules that are described in
34972 section 3.64 of RFC 2822 (which states that replies should contain such a
34973 header line), and section 3.14 of RFC 3834 (which states that automatic
34974 responses are not different in this respect). However, because some mail
34975 processing software does not cope well with very long header lines, no more
34976 than 12 message IDs are copied from the &'References:'& header line in the
34977 incoming message. If there are more than 12, the first one and then the final
34978 11 are copied, before adding the message ID of the incoming message.
34979
34980
34981
34982 .section "The Return-path: header line" "SECID229"
34983 .cindex "&'Return-path:'& header line"
34984 .cindex "header lines" "Return-path:"
34985 .oindex "&%return_path_remove%&"
34986 &'Return-path:'& header lines are defined as something an MTA may insert when
34987 it does the final delivery of messages. (See the generic &%return_path_add%&
34988 transport option.) Therefore, they should not be present in messages in
34989 transit. If the &%return_path_remove%& configuration option is set (the
34990 default), Exim removes &'Return-path:'& header lines from incoming messages.
34991
34992
34993
34994 .section "The Sender: header line" "SECTthesenhea"
34995 .cindex "&'Sender:'& header line"
34996 .cindex "message" "submission"
34997 .cindex "header lines" "Sender:"
34998 For a locally-originated message from an untrusted user, Exim may remove an
34999 existing &'Sender:'& header line, and it may add a new one. You can modify
35000 these actions by setting the &%local_sender_retain%& option true, the
35001 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35002 control setting.
35003
35004 When a local message is received from an untrusted user and
35005 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35006 control has not been set, a check is made to see if the address given in the
35007 &'From:'& header line is the correct (local) sender of the message. The address
35008 that is expected has the login name as the local part and the value of
35009 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35010 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35011 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35012 line is added to the message.
35013
35014 If you set &%local_from_check%& false, this checking does not occur. However,
35015 the removal of an existing &'Sender:'& line still happens, unless you also set
35016 &%local_sender_retain%& to be true. It is not possible to set both of these
35017 options true at the same time.
35018
35019 .cindex "submission mode"
35020 By default, no processing of &'Sender:'& header lines is done for messages
35021 received over TCP/IP or for messages submitted by trusted users. However, when
35022 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35023 not specified on the submission control, the following processing takes place:
35024
35025 .vindex "&$authenticated_id$&"
35026 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35027 authenticated, and &$authenticated_id$& is not empty, a sender address is
35028 created as follows:
35029
35030 .ilist
35031 .vindex "&$qualify_domain$&"
35032 If no domain is specified by the submission control, the local part is
35033 &$authenticated_id$& and the domain is &$qualify_domain$&.
35034 .next
35035 If a non-empty domain is specified by the submission control, the local part
35036 is &$authenticated_id$&, and the domain is the specified domain.
35037 .next
35038 If an empty domain is specified by the submission control,
35039 &$authenticated_id$& is assumed to be the complete address.
35040 .endlist
35041
35042 This address is compared with the address in the &'From:'& header line. If they
35043 are different, a &'Sender:'& header line containing the created address is
35044 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35045 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35046
35047 .cindex "return path" "created from &'Sender:'&"
35048 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35049 the message (the envelope sender address) is changed to be the same address,
35050 except in the case of submission mode when &%sender_retain%& is specified.
35051
35052
35053
35054 .section "Adding and removing header lines in routers and transports" &&&
35055          "SECTheadersaddrem"
35056 .cindex "header lines" "adding; in router or transport"
35057 .cindex "header lines" "removing; in router or transport"
35058 When a message is delivered, the addition and removal of header lines can be
35059 specified in a system filter, or on any of the routers and transports that
35060 process the message. Section &<<SECTaddremheasys>>& contains details about
35061 modifying headers in a system filter. Header lines can also be added in an ACL
35062 as a message is received (see section &<<SECTaddheadacl>>&).
35063
35064 In contrast to what happens in a system filter, header modifications that are
35065 specified on routers and transports apply only to the particular recipient
35066 addresses that are being processed by those routers and transports. These
35067 changes do not actually take place until a copy of the message is being
35068 transported. Therefore, they do not affect the basic set of header lines, and
35069 they do not affect the values of the variables that refer to header lines.
35070
35071 &*Note*&: In particular, this means that any expansions in the configuration of
35072 the transport cannot refer to the modified header lines, because such
35073 expansions all occur before the message is actually transported.
35074
35075 For both routers and transports, the argument of a &%headers_add%&
35076 option must be in the form of one or more RFC 2822 header lines, separated by
35077 newlines (coded as &"\n"&). For example:
35078 .code
35079 headers_add = X-added-header: added by $primary_hostname\n\
35080               X-added-second: another added header line
35081 .endd
35082 Exim does not check the syntax of these added header lines.
35083
35084 Multiple &%headers_add%& options for a single router or transport can be
35085 specified; the values will append to a single list of header lines.
35086 Each header-line is separately expanded.
35087
35088 The argument of a &%headers_remove%& option must consist of a colon-separated
35089 list of header names. This is confusing, because header names themselves are
35090 often terminated by colons. In this case, the colons are the list separators,
35091 not part of the names. For example:
35092 .code
35093 headers_remove = return-receipt-to:acknowledge-to
35094 .endd
35095
35096 Multiple &%headers_remove%& options for a single router or transport can be
35097 specified; the arguments will append to a single header-names list.
35098 Each item is separately expanded.
35099 Note that colons in complex expansions which are used to
35100 form all or part of a &%headers_remove%& list
35101 will act as list separators.
35102
35103 When &%headers_add%& or &%headers_remove%& is specified on a router,
35104 items are expanded at routing time,
35105 and then associated with all addresses that are
35106 accepted by that router, and also with any new addresses that it generates. If
35107 an address passes through several routers as a result of aliasing or
35108 forwarding, the changes are cumulative.
35109
35110 .oindex "&%unseen%&"
35111 However, this does not apply to multiple routers that result from the use of
35112 the &%unseen%& option. Any header modifications that were specified by the
35113 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35114
35115 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35116 settings cannot be delivered together in a batch, so a transport is always
35117 dealing with a set of addresses that have the same header-processing
35118 requirements.
35119
35120 The transport starts by writing the original set of header lines that arrived
35121 with the message, possibly modified by the system filter. As it writes out
35122 these lines, it consults the list of header names that were attached to the
35123 recipient address(es) by &%headers_remove%& options in routers, and it also
35124 consults the transport's own &%headers_remove%& option. Header lines whose
35125 names are on either of these lists are not written out. If there are multiple
35126 instances of any listed header, they are all skipped.
35127
35128 After the remaining original header lines have been written, new header
35129 lines that were specified by routers' &%headers_add%& options are written, in
35130 the order in which they were attached to the address. These are followed by any
35131 header lines specified by the transport's &%headers_add%& option.
35132
35133 This way of handling header line modifications in routers and transports has
35134 the following consequences:
35135
35136 .ilist
35137 The original set of header lines, possibly modified by the system filter,
35138 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35139 to it, at all times.
35140 .next
35141 Header lines that are added by a router's
35142 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35143 expansion syntax in subsequent routers or the transport.
35144 .next
35145 Conversely, header lines that are specified for removal by &%headers_remove%&
35146 in a router remain visible to subsequent routers and the transport.
35147 .next
35148 Headers added to an address by &%headers_add%& in a router cannot be removed by
35149 a later router or by a transport.
35150 .next
35151 An added header can refer to the contents of an original header that is to be
35152 removed, even it has the same name as the added header. For example:
35153 .code
35154 headers_remove = subject
35155 headers_add = Subject: new subject (was: $h_subject:)
35156 .endd
35157 .endlist
35158
35159 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35160 for a &(redirect)& router that has the &%one_time%& option set.
35161
35162
35163
35164
35165
35166 .section "Constructed addresses" "SECTconstr"
35167 .cindex "address" "constructed"
35168 .cindex "constructed address"
35169 When Exim constructs a sender address for a locally-generated message, it uses
35170 the form
35171 .display
35172 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35173 .endd
35174 For example:
35175 .code
35176 Zaphod Beeblebrox <zaphod@end.univ.example>
35177 .endd
35178 The user name is obtained from the &%-F%& command line option if set, or
35179 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35180 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35181 ampersand character, this is replaced by the login name with the first letter
35182 upper cased, as is conventional in a number of operating systems. See the
35183 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35184 The &%unknown_username%& option can be used to specify user names in cases when
35185 there is no password file entry.
35186
35187 .cindex "RFC 2047"
35188 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35189 parts of it if necessary. In addition, if it contains any non-printing
35190 characters, it is encoded as described in RFC 2047, which defines a way of
35191 including non-ASCII characters in header lines. The value of the
35192 &%headers_charset%& option specifies the name of the encoding that is used (the
35193 characters are assumed to be in this encoding). The setting of
35194 &%print_topbitchars%& controls whether characters with the top bit set (that
35195 is, with codes greater than 127) count as printing characters or not.
35196
35197
35198
35199 .section "Case of local parts" "SECID230"
35200 .cindex "case of local parts"
35201 .cindex "local part" "case of"
35202 RFC 2822 states that the case of letters in the local parts of addresses cannot
35203 be assumed to be non-significant. Exim preserves the case of local parts of
35204 addresses, but by default it uses a lower-cased form when it is routing,
35205 because on most Unix systems, usernames are in lower case and case-insensitive
35206 routing is required. However, any particular router can be made to use the
35207 original case for local parts by setting the &%caseful_local_part%& generic
35208 router option.
35209
35210 .cindex "mixed-case login names"
35211 If you must have mixed-case user names on your system, the best way to proceed,
35212 assuming you want case-independent handling of incoming email, is to set up
35213 your first router to convert incoming local parts in your domains to the
35214 correct case by means of a file lookup. For example:
35215 .code
35216 correct_case:
35217   driver = redirect
35218   domains = +local_domains
35219   data = ${lookup{$local_part}cdb\
35220               {/etc/usercased.cdb}{$value}fail}\
35221               @$domain
35222 .endd
35223 For this router, the local part is forced to lower case by the default action
35224 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35225 up a new local part in the correct case. If you then set &%caseful_local_part%&
35226 on any subsequent routers which process your domains, they will operate on
35227 local parts with the correct case in a case-sensitive manner.
35228
35229
35230
35231 .section "Dots in local parts" "SECID231"
35232 .cindex "dot" "in local part"
35233 .cindex "local part" "dots in"
35234 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35235 part may not begin or end with a dot, nor have two consecutive dots in the
35236 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35237 empty components for compatibility.
35238
35239
35240
35241 .section "Rewriting addresses" "SECID232"
35242 .cindex "rewriting" "addresses"
35243 Rewriting of sender and recipient addresses, and addresses in headers, can
35244 happen automatically, or as the result of configuration options, as described
35245 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35246 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35247
35248 Automatic rewriting includes qualification, as mentioned above. The other case
35249 in which it can happen is when an incomplete non-local domain is given. The
35250 routing process may cause this to be expanded into the full domain name. For
35251 example, a header such as
35252 .code
35253 To: hare@teaparty
35254 .endd
35255 might get rewritten as
35256 .code
35257 To: hare@teaparty.wonderland.fict.example
35258 .endd
35259 Rewriting as a result of routing is the one kind of message processing that
35260 does not happen at input time, as it cannot be done until the address has
35261 been routed.
35262
35263 Strictly, one should not do &'any'& deliveries of a message until all its
35264 addresses have been routed, in case any of the headers get changed as a
35265 result of routing. However, doing this in practice would hold up many
35266 deliveries for unreasonable amounts of time, just because one address could not
35267 immediately be routed. Exim therefore does not delay other deliveries when
35268 routing of one or more addresses is deferred.
35269 .ecindex IIDmesproc
35270
35271
35272
35273 . ////////////////////////////////////////////////////////////////////////////
35274 . ////////////////////////////////////////////////////////////////////////////
35275
35276 .chapter "SMTP processing" "CHAPSMTP"
35277 .scindex IIDsmtpproc1 "SMTP" "processing details"
35278 .scindex IIDsmtpproc2 "LMTP" "processing details"
35279 Exim supports a number of different ways of using the SMTP protocol, and its
35280 LMTP variant, which is an interactive protocol for transferring messages into a
35281 closed mail store application. This chapter contains details of how SMTP is
35282 processed. For incoming mail, the following are available:
35283
35284 .ilist
35285 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35286 .next
35287 SMTP over the standard input and output (the &%-bs%& option);
35288 .next
35289 Batched SMTP on the standard input (the &%-bS%& option).
35290 .endlist
35291
35292 For mail delivery, the following are available:
35293
35294 .ilist
35295 SMTP over TCP/IP (the &(smtp)& transport);
35296 .next
35297 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35298 &"lmtp"&);
35299 .next
35300 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35301 transport);
35302 .next
35303 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35304 the &%use_bsmtp%& option set).
35305 .endlist
35306
35307 &'Batched SMTP'& is the name for a process in which batches of messages are
35308 stored in or read from files (or pipes), in a format in which SMTP commands are
35309 used to contain the envelope information.
35310
35311
35312
35313 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35314 .cindex "SMTP" "outgoing over TCP/IP"
35315 .cindex "outgoing SMTP over TCP/IP"
35316 .cindex "LMTP" "over TCP/IP"
35317 .cindex "outgoing LMTP over TCP/IP"
35318 .cindex "EHLO"
35319 .cindex "HELO"
35320 .cindex "SIZE option on MAIL command"
35321 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35322 The &%protocol%& option selects which protocol is to be used, but the actual
35323 processing is the same in both cases.
35324
35325 If, in response to its EHLO command, Exim is told that the SIZE
35326 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35327 command. The value of <&'n'&> is the message size plus the value of the
35328 &%size_addition%& option (default 1024) to allow for additions to the message
35329 such as per-transport header lines, or changes made in a
35330 .cindex "transport" "filter"
35331 .cindex "filter" "transport filter"
35332 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35333 suppressed.
35334
35335 If the remote server advertises support for PIPELINING, Exim uses the
35336 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35337 required for the transaction.
35338
35339 If the remote server advertises support for the STARTTLS command, and Exim
35340 was built to support TLS encryption, it tries to start a TLS session unless the
35341 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35342 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35343 is called for verification.
35344
35345 If the remote server advertises support for the AUTH command, Exim scans
35346 the authenticators configuration for any suitable client settings, as described
35347 in chapter &<<CHAPSMTPAUTH>>&.
35348
35349 .cindex "carriage return"
35350 .cindex "linefeed"
35351 Responses from the remote host are supposed to be terminated by CR followed by
35352 LF. However, there are known to be hosts that do not send CR characters, so in
35353 order to be able to interwork with such hosts, Exim treats LF on its own as a
35354 line terminator.
35355
35356 If a message contains a number of different addresses, all those with the same
35357 characteristics (for example, the same envelope sender) that resolve to the
35358 same set of hosts, in the same order, are sent in a single SMTP transaction,
35359 even if they are for different domains, unless there are more than the setting
35360 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35361 they are split into groups containing no more than &%max_rcpt%&s addresses
35362 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35363 in parallel sessions. The order of hosts with identical MX values is not
35364 significant when checking whether addresses can be batched in this way.
35365
35366 When the &(smtp)& transport suffers a temporary failure that is not
35367 message-related, Exim updates its transport-specific database, which contains
35368 records indexed by host name that remember which messages are waiting for each
35369 particular host. It also updates the retry database with new retry times.
35370
35371 .cindex "hints database" "retry keys"
35372 Exim's retry hints are based on host name plus IP address, so if one address of
35373 a multi-homed host is broken, it will soon be skipped most of the time.
35374 See the next section for more detail about error handling.
35375
35376 .cindex "SMTP" "passed connection"
35377 .cindex "SMTP" "batching over TCP/IP"
35378 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35379 looks in the hints database for the transport to see if there are any queued
35380 messages waiting for the host to which it is connected. If it finds one, it
35381 creates a new Exim process using the &%-MC%& option (which can only be used by
35382 a process running as root or the Exim user) and passes the TCP/IP socket to it
35383 so that it can deliver another message using the same socket. The new process
35384 does only those deliveries that are routed to the connected host, and may in
35385 turn pass the socket on to a third process, and so on.
35386
35387 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35388 limit the number of messages sent down a single TCP/IP connection.
35389
35390 .cindex "asterisk" "after IP address"
35391 The second and subsequent messages delivered down an existing connection are
35392 identified in the main log by the addition of an asterisk after the closing
35393 square bracket of the IP address.
35394
35395
35396
35397
35398 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35399 .cindex "error" "in outgoing SMTP"
35400 .cindex "SMTP" "errors in outgoing"
35401 .cindex "host" "error"
35402 Three different kinds of error are recognized for outgoing SMTP: host errors,
35403 message errors, and recipient errors.
35404
35405 .vlist
35406 .vitem "&*Host errors*&"
35407 A host error is not associated with a particular message or with a
35408 particular recipient of a message. The host errors are:
35409
35410 .ilist
35411 Connection refused or timed out,
35412 .next
35413 Any error response code on connection,
35414 .next
35415 Any error response code to EHLO or HELO,
35416 .next
35417 Loss of connection at any time, except after &"."&,
35418 .next
35419 I/O errors at any time,
35420 .next
35421 Timeouts during the session, other than in response to MAIL, RCPT or
35422 the &"."& at the end of the data.
35423 .endlist ilist
35424
35425 For a host error, a permanent error response on connection, or in response to
35426 EHLO, causes all addresses routed to the host to be failed. Any other host
35427 error causes all addresses to be deferred, and retry data to be created for the
35428 host. It is not tried again, for any message, until its retry time arrives. If
35429 the current set of addresses are not all delivered in this run (to some
35430 alternative host), the message is added to the list of those waiting for this
35431 host, so if it is still undelivered when a subsequent successful delivery is
35432 made to the host, it will be sent down the same SMTP connection.
35433
35434 .vitem "&*Message errors*&"
35435 .cindex "message" "error"
35436 A message error is associated with a particular message when sent to a
35437 particular host, but not with a particular recipient of the message. The
35438 message errors are:
35439
35440 .ilist
35441 Any error response code to MAIL, DATA, or the &"."& that terminates
35442 the data,
35443 .next
35444 Timeout after MAIL,
35445 .next
35446 Timeout or loss of connection after the &"."& that terminates the data. A
35447 timeout after the DATA command itself is treated as a host error, as is loss of
35448 connection at any other time.
35449 .endlist ilist
35450
35451 For a message error, a permanent error response (5&'xx'&) causes all addresses
35452 to be failed, and a delivery error report to be returned to the sender. A
35453 temporary error response (4&'xx'&), or one of the timeouts, causes all
35454 addresses to be deferred. Retry data is not created for the host, but instead,
35455 a retry record for the combination of host plus message id is created. The
35456 message is not added to the list of those waiting for this host. This ensures
35457 that the failing message will not be sent to this host again until the retry
35458 time arrives. However, other messages that are routed to the host are not
35459 affected, so if it is some property of the message that is causing the error,
35460 it will not stop the delivery of other mail.
35461
35462 If the remote host specified support for the SIZE parameter in its response
35463 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35464 over-large message will cause a message error because the error arrives as a
35465 response to MAIL.
35466
35467 .vitem "&*Recipient errors*&"
35468 .cindex "recipient" "error"
35469 A recipient error is associated with a particular recipient of a message. The
35470 recipient errors are:
35471
35472 .ilist
35473 Any error response to RCPT,
35474 .next
35475 Timeout after RCPT.
35476 .endlist
35477
35478 For a recipient error, a permanent error response (5&'xx'&) causes the
35479 recipient address to be failed, and a bounce message to be returned to the
35480 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35481 address to be deferred, and routing retry data to be created for it. This is
35482 used to delay processing of the address in subsequent queue runs, until its
35483 routing retry time arrives. This applies to all messages, but because it
35484 operates only in queue runs, one attempt will be made to deliver a new message
35485 to the failing address before the delay starts to operate. This ensures that,
35486 if the failure is really related to the message rather than the recipient
35487 (&"message too big for this recipient"& is a possible example), other messages
35488 have a chance of getting delivered. If a delivery to the address does succeed,
35489 the retry information gets cleared, so all stuck messages get tried again, and
35490 the retry clock is reset.
35491
35492 The message is not added to the list of those waiting for this host. Use of the
35493 host for other messages is unaffected, and except in the case of a timeout,
35494 other recipients are processed independently, and may be successfully delivered
35495 in the current SMTP session. After a timeout it is of course impossible to
35496 proceed with the session, so all addresses get deferred. However, those other
35497 than the one that failed do not suffer any subsequent retry delays. Therefore,
35498 if one recipient is causing trouble, the others have a chance of getting
35499 through when a subsequent delivery attempt occurs before the failing
35500 recipient's retry time.
35501 .endlist
35502
35503 In all cases, if there are other hosts (or IP addresses) available for the
35504 current set of addresses (for example, from multiple MX records), they are
35505 tried in this run for any undelivered addresses, subject of course to their
35506 own retry data. In other words, recipient error retry data does not take effect
35507 until the next delivery attempt.
35508
35509 Some hosts have been observed to give temporary error responses to every
35510 MAIL command at certain times (&"insufficient space"& has been seen). It
35511 would be nice if such circumstances could be recognized, and defer data for the
35512 host itself created, but this is not possible within the current Exim design.
35513 What actually happens is that retry data for every (host, message) combination
35514 is created.
35515
35516 The reason that timeouts after MAIL and RCPT are treated specially is that
35517 these can sometimes arise as a result of the remote host's verification
35518 procedures. Exim makes this assumption, and treats them as if a temporary error
35519 response had been received. A timeout after &"."& is treated specially because
35520 it is known that some broken implementations fail to recognize the end of the
35521 message if the last character of the last line is a binary zero. Thus, it is
35522 helpful to treat this case as a message error.
35523
35524 Timeouts at other times are treated as host errors, assuming a problem with the
35525 host, or the connection to it. If a timeout after MAIL, RCPT,
35526 or &"."& is really a connection problem, the assumption is that at the next try
35527 the timeout is likely to occur at some other point in the dialogue, causing it
35528 then to be treated as a host error.
35529
35530 There is experimental evidence that some MTAs drop the connection after the
35531 terminating &"."& if they do not like the contents of the message for some
35532 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35533 should be given. That is why Exim treats this case as a message rather than a
35534 host error, in order not to delay other messages to the same host.
35535
35536
35537
35538
35539 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35540 .cindex "SMTP" "incoming over TCP/IP"
35541 .cindex "incoming SMTP over TCP/IP"
35542 .cindex "inetd"
35543 .cindex "daemon"
35544 Incoming SMTP messages can be accepted in one of two ways: by running a
35545 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35546 &_/etc/inetd.conf_& should be like this:
35547 .code
35548 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35549 .endd
35550 Exim distinguishes between this case and the case of a locally running user
35551 agent using the &%-bs%& option by checking whether or not the standard input is
35552 a socket. When it is, either the port must be privileged (less than 1024), or
35553 the caller must be root or the Exim user. If any other user passes a socket
35554 with an unprivileged port number, Exim prints a message on the standard error
35555 stream and exits with an error code.
35556
35557 By default, Exim does not make a log entry when a remote host connects or
35558 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35559 unexpected. It can be made to write such log entries by setting the
35560 &%smtp_connection%& log selector.
35561
35562 .cindex "carriage return"
35563 .cindex "linefeed"
35564 Commands from the remote host are supposed to be terminated by CR followed by
35565 LF. However, there are known to be hosts that do not send CR characters. In
35566 order to be able to interwork with such hosts, Exim treats LF on its own as a
35567 line terminator.
35568 Furthermore, because common code is used for receiving messages from all
35569 sources, a CR on its own is also interpreted as a line terminator. However, the
35570 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35571
35572 .cindex "EHLO" "invalid data"
35573 .cindex "HELO" "invalid data"
35574 One area that sometimes gives rise to problems concerns the EHLO or
35575 HELO commands. Some clients send syntactically invalid versions of these
35576 commands, which Exim rejects by default. (This is nothing to do with verifying
35577 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35578 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35579 match the broken hosts that send invalid commands.
35580
35581 .cindex "SIZE option on MAIL command"
35582 .cindex "MAIL" "SIZE option"
35583 The amount of disk space available is checked whenever SIZE is received on
35584 a MAIL command, independently of whether &%message_size_limit%& or
35585 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35586 false. A temporary error is given if there is not enough space. If
35587 &%check_spool_space%& is set, the check is for that amount of space plus the
35588 value given with SIZE, that is, it checks that the addition of the incoming
35589 message will not reduce the space below the threshold.
35590
35591 When a message is successfully received, Exim includes the local message id in
35592 its response to the final &"."& that terminates the data. If the remote host
35593 logs this text it can help with tracing what has happened to a message.
35594
35595 The Exim daemon can limit the number of simultaneous incoming connections it is
35596 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35597 number of simultaneous incoming connections from a single remote host (see the
35598 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35599 rejected using the SMTP temporary error code 421.
35600
35601 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35602 subprocess has finished, as this can get lost at busy times. Instead, it looks
35603 for completed subprocesses every time it wakes up. Provided there are other
35604 things happening (new incoming calls, starts of queue runs), completed
35605 processes will be noticed and tidied away. On very quiet systems you may
35606 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35607 it will be noticed when the daemon next wakes up.
35608
35609 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35610 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35611 high system load &-- for details see the &%smtp_accept_reserve%&,
35612 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35613 applies in both the daemon and &'inetd'& cases.
35614
35615 Exim normally starts a delivery process for each message received, though this
35616 can be varied by means of the &%-odq%& command line option and the
35617 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35618 number of simultaneously running delivery processes started in this way from
35619 SMTP input can be limited by the &%smtp_accept_queue%& and
35620 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35621 subsequently received messages are just put on the input queue without starting
35622 a delivery process.
35623
35624 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35625 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35626 started up from the &'inetd'& daemon, because in that case each connection is
35627 handled by an entirely independent Exim process. Control by load average is,
35628 however, available with &'inetd'&.
35629
35630 Exim can be configured to verify addresses in incoming SMTP commands as they
35631 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35632 to rewrite addresses at this time &-- before any syntax checking is done. See
35633 section &<<SECTrewriteS>>&.
35634
35635 Exim can also be configured to limit the rate at which a client host submits
35636 MAIL and RCPT commands in a single SMTP session. See the
35637 &%smtp_ratelimit_hosts%& option.
35638
35639
35640
35641 .section "Unrecognized SMTP commands" "SECID234"
35642 .cindex "SMTP" "unrecognized commands"
35643 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35644 commands during a single SMTP connection, it drops the connection after sending
35645 the error response to the last command. The default value for
35646 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35647 abuse that subvert web servers into making connections to SMTP ports; in these
35648 circumstances, a number of non-SMTP lines are sent first.
35649
35650
35651 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35652 .cindex "SMTP" "syntax errors"
35653 .cindex "SMTP" "protocol errors"
35654 A syntax error is detected if an SMTP command is recognized, but there is
35655 something syntactically wrong with its data, for example, a malformed email
35656 address in a RCPT command. Protocol errors include invalid command
35657 sequencing such as RCPT before MAIL. If Exim receives more than
35658 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35659 drops the connection after sending the error response to the last command. The
35660 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35661 broken clients that loop sending bad commands (yes, it has been seen).
35662
35663
35664
35665 .section "Use of non-mail SMTP commands" "SECID236"
35666 .cindex "SMTP" "non-mail commands"
35667 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35668 DATA. Exim counts such commands, and drops the connection if there are too
35669 many of them in a single SMTP session. This action catches some
35670 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35671 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35672 defines what &"too many"& means. Its default value is 10.
35673
35674 When a new message is expected, one occurrence of RSET is not counted. This
35675 allows a client to send one RSET between messages (this is not necessary,
35676 but some clients do it). Exim also allows one uncounted occurrence of HELO
35677 or EHLO, and one occurrence of STARTTLS between messages. After
35678 starting up a TLS session, another EHLO is expected, and so it too is not
35679 counted.
35680
35681 The first occurrence of AUTH in a connection, or immediately following
35682 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35683 RCPT, DATA, and QUIT are counted.
35684
35685 You can control which hosts are subject to the limit set by
35686 &%smtp_accept_max_nonmail%& by setting
35687 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35688 the limit apply to all hosts. This option means that you can exclude any
35689 specific badly-behaved hosts that you have to live with.
35690
35691
35692
35693
35694 .section "The VRFY and EXPN commands" "SECID237"
35695 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35696 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35697 appropriate) in order to decide whether the command should be accepted or not.
35698
35699 .cindex "VRFY" "processing"
35700 When no ACL is defined for VRFY, or if it rejects without
35701 setting an explicit response code, the command is accepted
35702 (with a 252 SMTP response code)
35703 in order to support awkward clients that do a VRFY before every RCPT.
35704 When VRFY is accepted, it runs exactly the same code as when Exim is
35705 called with the &%-bv%& option, and returns 250/451/550
35706 SMTP response codes.
35707
35708 .cindex "EXPN" "processing"
35709 If no ACL for EXPN is defined, the command is rejected.
35710 When EXPN is accepted, a single-level expansion of the address is done.
35711 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35712 than a verification (the &%-bv%& option). If an unqualified local part is given
35713 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35714 of VRFY and EXPN commands are logged on the main and reject logs, and
35715 VRFY verification failures are logged on the main log for consistency with
35716 RCPT failures.
35717
35718
35719
35720 .section "The ETRN command" "SECTETRN"
35721 .cindex "ETRN" "processing"
35722 RFC 1985 describes an SMTP command called ETRN that is designed to
35723 overcome the security problems of the TURN command (which has fallen into
35724 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35725 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35726 should be accepted or not. If no ACL is defined, the command is rejected.
35727
35728 The ETRN command is concerned with &"releasing"& messages that are awaiting
35729 delivery to certain hosts. As Exim does not organize its message queue by host,
35730 the only form of ETRN that is supported by default is the one where the
35731 text starts with the &"#"& prefix, in which case the remainder of the text is
35732 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35733 the &%-R%& option to happen, with the remainder of the ETRN text as its
35734 argument. For example,
35735 .code
35736 ETRN #brigadoon
35737 .endd
35738 runs the command
35739 .code
35740 exim -R brigadoon
35741 .endd
35742 which causes a delivery attempt on all messages with undelivered addresses
35743 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35744 default), Exim prevents the simultaneous execution of more than one queue run
35745 for the same argument string as a result of an ETRN command. This stops
35746 a misbehaving client from starting more than one queue runner at once.
35747
35748 .cindex "hints database" "ETRN serialization"
35749 Exim implements the serialization by means of a hints database in which a
35750 record is written whenever a process is started by ETRN, and deleted when
35751 the process completes. However, Exim does not keep the SMTP session waiting for
35752 the ETRN process to complete. Once ETRN is accepted, the client is sent
35753 a &"success"& return code. Obviously there is scope for hints records to get
35754 left lying around if there is a system or program crash. To guard against this,
35755 Exim ignores any records that are more than six hours old.
35756
35757 .oindex "&%smtp_etrn_command%&"
35758 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35759 used. This specifies a command that is run whenever ETRN is received,
35760 whatever the form of its argument. For
35761 example:
35762 .code
35763 smtp_etrn_command = /etc/etrn_command $domain \
35764                     $sender_host_address
35765 .endd
35766 .vindex "&$domain$&"
35767 The string is split up into arguments which are independently expanded. The
35768 expansion variable &$domain$& is set to the argument of the ETRN command,
35769 and no syntax checking is done on the contents of this argument. Exim does not
35770 wait for the command to complete, so its status code is not checked. Exim runs
35771 under its own uid and gid when receiving incoming SMTP, so it is not possible
35772 for it to change them before running the command.
35773
35774
35775
35776 .section "Incoming local SMTP" "SECID238"
35777 .cindex "SMTP" "local incoming"
35778 Some user agents use SMTP to pass messages to their local MTA using the
35779 standard input and output, as opposed to passing the envelope on the command
35780 line and writing the message to the standard input. This is supported by the
35781 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35782 messages over TCP/IP (including the use of ACLs), except that the envelope
35783 sender given in a MAIL command is ignored unless the caller is trusted. In
35784 an ACL you can detect this form of SMTP input by testing for an empty host
35785 identification. It is common to have this as the first line in the ACL that
35786 runs for RCPT commands:
35787 .code
35788 accept hosts = :
35789 .endd
35790 This accepts SMTP messages from local processes without doing any other tests.
35791
35792
35793
35794 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35795 .cindex "SMTP" "batched outgoing"
35796 .cindex "batched SMTP output"
35797 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35798 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35799 be output in BSMTP format. No SMTP responses are possible for this form of
35800 delivery. All it is doing is using SMTP commands as a way of transmitting the
35801 envelope along with the message.
35802
35803 The message is written to the file or pipe preceded by the SMTP commands
35804 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35805 the message that start with a dot have an extra dot added. The SMTP command
35806 HELO is not normally used. If it is required, the &%message_prefix%& option
35807 can be used to specify it.
35808
35809 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35810 one recipient address at a time by default. However, you can arrange for them
35811 to handle several addresses at once by setting the &%batch_max%& option. When
35812 this is done for BSMTP, messages may contain multiple RCPT commands. See
35813 chapter &<<CHAPbatching>>& for more details.
35814
35815 .vindex "&$host$&"
35816 When one or more addresses are routed to a BSMTP transport by a router that
35817 sets up a host list, the name of the first host on the list is available to the
35818 transport in the variable &$host$&. Here is an example of such a transport and
35819 router:
35820 .code
35821 begin routers
35822 route_append:
35823   driver = manualroute
35824   transport = smtp_appendfile
35825   route_list = domain.example  batch.host.example
35826
35827 begin transports
35828 smtp_appendfile:
35829   driver = appendfile
35830   directory = /var/bsmtp/$host
35831   batch_max = 1000
35832   use_bsmtp
35833   user = exim
35834 .endd
35835 This causes messages addressed to &'domain.example'& to be written in BSMTP
35836 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35837 message (unless there are more than 1000 recipients).
35838
35839
35840
35841 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35842 .cindex "SMTP" "batched incoming"
35843 .cindex "batched SMTP input"
35844 The &%-bS%& command line option causes Exim to accept one or more messages by
35845 reading SMTP on the standard input, but to generate no responses. If the caller
35846 is trusted, the senders in the MAIL commands are believed; otherwise the
35847 sender is always the caller of Exim. Unqualified senders and receivers are not
35848 rejected (there seems little point) but instead just get qualified. HELO
35849 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35850 as NOOP; QUIT quits.
35851
35852 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35853 ACL is run in the same way as for non-SMTP local input.
35854
35855 If an error is detected while reading a message, including a missing &"."& at
35856 the end, Exim gives up immediately. It writes details of the error to the
35857 standard output in a stylized way that the calling program should be able to
35858 make some use of automatically, for example:
35859 .code
35860 554 Unexpected end of file
35861 Transaction started in line 10
35862 Error detected in line 14
35863 .endd
35864 It writes a more verbose version, for human consumption, to the standard error
35865 file, for example:
35866 .code
35867 An error was detected while processing a file of BSMTP input.
35868 The error message was:
35869
35870 501 '>' missing at end of address
35871
35872 The SMTP transaction started in line 10.
35873 The error was detected in line 12.
35874 The SMTP command at fault was:
35875
35876 rcpt to:<malformed@in.com.plete
35877
35878 1 previous message was successfully processed.
35879 The rest of the batch was abandoned.
35880 .endd
35881 The return code from Exim is zero only if there were no errors. It is 1 if some
35882 messages were accepted before an error was detected, and 2 if no messages were
35883 accepted.
35884 .ecindex IIDsmtpproc1
35885 .ecindex IIDsmtpproc2
35886
35887
35888
35889 . ////////////////////////////////////////////////////////////////////////////
35890 . ////////////////////////////////////////////////////////////////////////////
35891
35892 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35893          "Customizing messages"
35894 When a message fails to be delivered, or remains in the queue for more than a
35895 configured amount of time, Exim sends a message to the original sender, or
35896 to an alternative configured address. The text of these messages is built into
35897 the code of Exim, but it is possible to change it, either by adding a single
35898 string, or by replacing each of the paragraphs by text supplied in a file.
35899
35900 The &'From:'& and &'To:'& header lines are automatically generated; you can
35901 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35902 option. Exim also adds the line
35903 .code
35904 Auto-Submitted: auto-generated
35905 .endd
35906 to all warning and bounce messages,
35907
35908
35909 .section "Customizing bounce messages" "SECID239"
35910 .cindex "customizing" "bounce message"
35911 .cindex "bounce message" "customizing"
35912 If &%bounce_message_text%& is set, its contents are included in the default
35913 message immediately after &"This message was created automatically by mail
35914 delivery software."& The string is not expanded. It is not used if
35915 &%bounce_message_file%& is set.
35916
35917 When &%bounce_message_file%& is set, it must point to a template file for
35918 constructing error messages. The file consists of a series of text items,
35919 separated by lines consisting of exactly four asterisks. If the file cannot be
35920 opened, default text is used and a message is written to the main and panic
35921 logs. If any text item in the file is empty, default text is used for that
35922 item.
35923
35924 .vindex "&$bounce_recipient$&"
35925 .vindex "&$bounce_return_size_limit$&"
35926 Each item of text that is read from the file is expanded, and there are two
35927 expansion variables which can be of use here: &$bounce_recipient$& is set to
35928 the recipient of an error message while it is being created, and
35929 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35930 option, rounded to a whole number.
35931
35932 The items must appear in the file in the following order:
35933
35934 .ilist
35935 The first item is included in the headers, and should include at least a
35936 &'Subject:'& header. Exim does not check the syntax of these headers.
35937 .next
35938 The second item forms the start of the error message. After it, Exim lists the
35939 failing addresses with their error messages.
35940 .next
35941 The third item is used to introduce any text from pipe transports that is to be
35942 returned to the sender. It is omitted if there is no such text.
35943 .next
35944 The fourth, fifth and sixth items will be ignored and may be empty.
35945 The fields exist for back-compatibility
35946 .endlist
35947
35948 The default state (&%bounce_message_file%& unset) is equivalent to the
35949 following file, in which the sixth item is empty. The &'Subject:'& and some
35950 other lines have been split in order to fit them on the page:
35951 .code
35952 Subject: Mail delivery failed
35953   ${if eq{$sender_address}{$bounce_recipient}
35954   {: returning message to sender}}
35955 ****
35956 This message was created automatically by mail delivery software.
35957
35958 A message ${if eq{$sender_address}{$bounce_recipient}
35959   {that you sent }{sent by
35960
35961 <$sender_address>
35962
35963 }}could not be delivered to all of its recipients.
35964 This is a permanent error. The following address(es) failed:
35965 ****
35966 The following text was generated during the delivery attempt(s):
35967 ****
35968 ------ This is a copy of the message, including all the headers.
35969   ------
35970 ****
35971 ------ The body of the message is $message_size characters long;
35972   only the first
35973 ------ $bounce_return_size_limit or so are included here.
35974 ****
35975 .endd
35976 .section "Customizing warning messages" "SECTcustwarn"
35977 .cindex "customizing" "warning message"
35978 .cindex "warning of delay" "customizing the message"
35979 The option &%warn_message_file%& can be pointed at a template file for use when
35980 warnings about message delays are created. In this case there are only three
35981 text sections:
35982
35983 .ilist
35984 The first item is included in the headers, and should include at least a
35985 &'Subject:'& header. Exim does not check the syntax of these headers.
35986 .next
35987 The second item forms the start of the warning message. After it, Exim lists
35988 the delayed addresses.
35989 .next
35990 The third item then ends the message.
35991 .endlist
35992
35993 The default state is equivalent to the following file, except that some lines
35994 have been split here, in order to fit them on the page:
35995 .code
35996 Subject: Warning: message $message_exim_id delayed
35997   $warn_message_delay
35998 ****
35999 This message was created automatically by mail delivery software.
36000
36001 A message ${if eq{$sender_address}{$warn_message_recipients}
36002 {that you sent }{sent by
36003
36004 <$sender_address>
36005
36006 }}has not been delivered to all of its recipients after
36007 more than $warn_message_delay in the queue on $primary_hostname.
36008
36009 The message identifier is:     $message_exim_id
36010 The subject of the message is: $h_subject
36011 The date of the message is:    $h_date
36012
36013 The following address(es) have not yet been delivered:
36014 ****
36015 No action is required on your part. Delivery attempts will
36016 continue for some time, and this warning may be repeated at
36017 intervals if the message remains undelivered. Eventually the
36018 mail delivery software will give up, and when that happens,
36019 the message will be returned to you.
36020 .endd
36021 .vindex "&$warn_message_delay$&"
36022 .vindex "&$warn_message_recipients$&"
36023 However, in the default state the subject and date lines are omitted if no
36024 appropriate headers exist. During the expansion of this file,
36025 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36026 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36027 of recipients for the warning message. There may be more than one if there are
36028 multiple addresses with different &%errors_to%& settings on the routers that
36029 handled them.
36030
36031
36032
36033
36034 . ////////////////////////////////////////////////////////////////////////////
36035 . ////////////////////////////////////////////////////////////////////////////
36036
36037 .chapter "Some common configuration settings" "CHAPcomconreq"
36038 This chapter discusses some configuration settings that seem to be fairly
36039 common. More examples and discussion can be found in the Exim book.
36040
36041
36042
36043 .section "Sending mail to a smart host" "SECID240"
36044 .cindex "smart host" "example router"
36045 If you want to send all mail for non-local domains to a &"smart host"&, you
36046 should replace the default &(dnslookup)& router with a router which does the
36047 routing explicitly:
36048 .code
36049 send_to_smart_host:
36050   driver = manualroute
36051   route_list = !+local_domains smart.host.name
36052   transport = remote_smtp
36053 .endd
36054 You can use the smart host's IP address instead of the name if you wish.
36055 If you are using Exim only to submit messages to a smart host, and not for
36056 receiving incoming messages, you can arrange for it to do the submission
36057 synchronously by setting the &%mua_wrapper%& option (see chapter
36058 &<<CHAPnonqueueing>>&).
36059
36060
36061
36062
36063 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36064 .cindex "mailing lists"
36065 Exim can be used to run simple mailing lists, but for large and/or complicated
36066 requirements, the use of additional specialized mailing list software such as
36067 Majordomo or Mailman is recommended.
36068
36069 The &(redirect)& router can be used to handle mailing lists where each list
36070 is maintained in a separate file, which can therefore be managed by an
36071 independent manager. The &%domains%& router option can be used to run these
36072 lists in a separate domain from normal mail. For example:
36073 .code
36074 lists:
36075   driver = redirect
36076   domains = lists.example
36077   file = /usr/lists/$local_part
36078   forbid_pipe
36079   forbid_file
36080   errors_to = $local_part-request@lists.example
36081   no_more
36082 .endd
36083 This router is skipped for domains other than &'lists.example'&. For addresses
36084 in that domain, it looks for a file that matches the local part. If there is no
36085 such file, the router declines, but because &%no_more%& is set, no subsequent
36086 routers are tried, and so the whole delivery fails.
36087
36088 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36089 expanded into a filename or a pipe delivery, which is usually inappropriate in
36090 a mailing list.
36091
36092 .oindex "&%errors_to%&"
36093 The &%errors_to%& option specifies that any delivery errors caused by addresses
36094 taken from a mailing list are to be sent to the given address rather than the
36095 original sender of the message. However, before acting on this, Exim verifies
36096 the error address, and ignores it if verification fails.
36097
36098 For example, using the configuration above, mail sent to
36099 &'dicts@lists.example'& is passed on to those addresses contained in
36100 &_/usr/lists/dicts_&, with error reports directed to
36101 &'dicts-request@lists.example'&, provided that this address can be verified.
36102 There could be a file called &_/usr/lists/dicts-request_& containing
36103 the address(es) of this particular list's manager(s), but other approaches,
36104 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36105 or &%local_part_suffix%& options) to handle addresses of the form
36106 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36107
36108
36109
36110 .section "Syntax errors in mailing lists" "SECID241"
36111 .cindex "mailing lists" "syntax errors in"
36112 If an entry in redirection data contains a syntax error, Exim normally defers
36113 delivery of the original address. That means that a syntax error in a mailing
36114 list holds up all deliveries to the list. This may not be appropriate when a
36115 list is being maintained automatically from data supplied by users, and the
36116 addresses are not rigorously checked.
36117
36118 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36119 entries that fail to parse, noting the incident in the log. If in addition
36120 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36121 whenever a broken address is skipped. It is usually appropriate to set
36122 &%syntax_errors_to%& to the same address as &%errors_to%&.
36123
36124
36125
36126 .section "Re-expansion of mailing lists" "SECID242"
36127 .cindex "mailing lists" "re-expansion of"
36128 Exim remembers every individual address to which a message has been delivered,
36129 in order to avoid duplication, but it normally stores only the original
36130 recipient addresses with a message. If all the deliveries to a mailing list
36131 cannot be done at the first attempt, the mailing list is re-expanded when the
36132 delivery is next tried. This means that alterations to the list are taken into
36133 account at each delivery attempt, so addresses that have been added to
36134 the list since the message arrived will therefore receive a copy of the
36135 message, even though it pre-dates their subscription.
36136
36137 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36138 on the &(redirect)& router. If this is done, any addresses generated by the
36139 router that fail to deliver at the first attempt are added to the message as
36140 &"top level"& addresses, and the parent address that generated them is marked
36141 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36142 subsequent delivery attempts. The disadvantage of this is that if any of the
36143 failing addresses are incorrect, correcting them in the file has no effect on
36144 pre-existing messages.
36145
36146 The original top-level address is remembered with each of the generated
36147 addresses, and is output in any log messages. However, any intermediate parent
36148 addresses are not recorded. This makes a difference to the log only if the
36149 &%all_parents%& selector is set, but for mailing lists there is normally only
36150 one level of expansion anyway.
36151
36152
36153
36154 .section "Closed mailing lists" "SECID243"
36155 .cindex "mailing lists" "closed"
36156 The examples so far have assumed open mailing lists, to which anybody may
36157 send mail. It is also possible to set up closed lists, where mail is accepted
36158 from specified senders only. This is done by making use of the generic
36159 &%senders%& option to restrict the router that handles the list.
36160
36161 The following example uses the same file as a list of recipients and as a list
36162 of permitted senders. It requires three routers:
36163 .code
36164 lists_request:
36165   driver = redirect
36166   domains = lists.example
36167   local_part_suffix = -request
36168   file = /usr/lists/$local_part$local_part_suffix
36169   no_more
36170
36171 lists_post:
36172   driver = redirect
36173   domains = lists.example
36174   senders = ${if exists {/usr/lists/$local_part}\
36175              {lsearch;/usr/lists/$local_part}{*}}
36176   file = /usr/lists/$local_part
36177   forbid_pipe
36178   forbid_file
36179   errors_to = $local_part-request@lists.example
36180   no_more
36181
36182 lists_closed:
36183   driver = redirect
36184   domains = lists.example
36185   allow_fail
36186   data = :fail: $local_part@lists.example is a closed mailing list
36187 .endd
36188 All three routers have the same &%domains%& setting, so for any other domains,
36189 they are all skipped. The first router runs only if the local part ends in
36190 &%-request%&. It handles messages to the list manager(s) by means of an open
36191 mailing list.
36192
36193 The second router runs only if the &%senders%& precondition is satisfied. It
36194 checks for the existence of a list that corresponds to the local part, and then
36195 checks that the sender is on the list by means of a linear search. It is
36196 necessary to check for the existence of the file before trying to search it,
36197 because otherwise Exim thinks there is a configuration error. If the file does
36198 not exist, the expansion of &%senders%& is *, which matches all senders. This
36199 means that the router runs, but because there is no list, declines, and
36200 &%no_more%& ensures that no further routers are run. The address fails with an
36201 &"unrouteable address"& error.
36202
36203 The third router runs only if the second router is skipped, which happens when
36204 a mailing list exists, but the sender is not on it. This router forcibly fails
36205 the address, giving a suitable error message.
36206
36207
36208
36209
36210 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36211 .cindex "VERP"
36212 .cindex "Variable Envelope Return Paths"
36213 .cindex "envelope from"
36214 .cindex "envelope sender"
36215 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36216 are a way of helping mailing list administrators discover which subscription
36217 address is the cause of a particular delivery failure. The idea is to encode
36218 the original recipient address in the outgoing envelope sender address, so that
36219 if the message is forwarded by another host and then subsequently bounces, the
36220 original recipient can be extracted from the recipient address of the bounce.
36221
36222 .oindex &%errors_to%&
36223 .oindex &%return_path%&
36224 Envelope sender addresses can be modified by Exim using two different
36225 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36226 list examples), or the &%return_path%& option on a transport. The second of
36227 these is effective only if the message is successfully delivered to another
36228 host; it is not used for errors detected on the local host (see the description
36229 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36230 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36231 .code
36232 verp_smtp:
36233   driver = smtp
36234   max_rcpt = 1
36235   return_path = \
36236     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36237       {$1-request+$local_part=$domain@your.dom.example}fail}
36238 .endd
36239 This has the effect of rewriting the return path (envelope sender) on outgoing
36240 SMTP messages, if the local part of the original return path ends in
36241 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36242 local part and domain of the recipient into the return path. Suppose, for
36243 example, that a message whose return path has been set to
36244 &'somelist-request@your.dom.example'& is sent to
36245 &'subscriber@other.dom.example'&. In the transport, the return path is
36246 rewritten as
36247 .code
36248 somelist-request+subscriber=other.dom.example@your.dom.example
36249 .endd
36250 .vindex "&$local_part$&"
36251 For this to work, you must tell Exim to send multiple copies of messages that
36252 have more than one recipient, so that each copy has just one recipient. This is
36253 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36254 might be sent to several different recipients in the same domain, in which case
36255 &$local_part$& is not available in the transport, because it is not unique.
36256
36257 Unless your host is doing nothing but mailing list deliveries, you should
36258 probably use a separate transport for the VERP deliveries, so as not to use
36259 extra resources in making one-per-recipient copies for other deliveries. This
36260 can easily be done by expanding the &%transport%& option in the router:
36261 .code
36262 dnslookup:
36263   driver = dnslookup
36264   domains = ! +local_domains
36265   transport = \
36266     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36267       {verp_smtp}{remote_smtp}}
36268   no_more
36269 .endd
36270 If you want to change the return path using &%errors_to%& in a router instead
36271 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36272 routers that handle mailing list addresses. This will ensure that all delivery
36273 errors, including those detected on the local host, are sent to the VERP
36274 address.
36275
36276 On a host that does no local deliveries and has no manual routing, only the
36277 &(dnslookup)& router needs to be changed. A special transport is not needed for
36278 SMTP deliveries. Every mailing list recipient has its own return path value,
36279 and so Exim must hand them to the transport one at a time. Here is an example
36280 of a &(dnslookup)& router that implements VERP:
36281 .code
36282 verp_dnslookup:
36283   driver = dnslookup
36284   domains = ! +local_domains
36285   transport = remote_smtp
36286   errors_to = \
36287     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36288      {$1-request+$local_part=$domain@your.dom.example}fail}
36289   no_more
36290 .endd
36291 Before you start sending out messages with VERPed return paths, you must also
36292 configure Exim to accept the bounce messages that come back to those paths.
36293 Typically this is done by setting a &%local_part_suffix%& option for a
36294 router, and using this to route the messages to wherever you want to handle
36295 them.
36296
36297 The overhead incurred in using VERP depends very much on the size of the
36298 message, the number of recipient addresses that resolve to the same remote
36299 host, and the speed of the connection over which the message is being sent. If
36300 a lot of addresses resolve to the same host and the connection is slow, sending
36301 a separate copy of the message for each address may take substantially longer
36302 than sending a single copy with many recipients (for which VERP cannot be
36303 used).
36304
36305
36306
36307
36308
36309
36310 .section "Virtual domains" "SECTvirtualdomains"
36311 .cindex "virtual domains"
36312 .cindex "domain" "virtual"
36313 The phrase &'virtual domain'& is unfortunately used with two rather different
36314 meanings:
36315
36316 .ilist
36317 A domain for which there are no real mailboxes; all valid local parts are
36318 aliases for other email addresses. Common examples are organizational
36319 top-level domains and &"vanity"& domains.
36320 .next
36321 One of a number of independent domains that are all handled by the same host,
36322 with mailboxes on that host, but where the mailbox owners do not necessarily
36323 have login accounts on that host.
36324 .endlist
36325
36326 The first usage is probably more common, and does seem more &"virtual"& than
36327 the second. This kind of domain can be handled in Exim with a straightforward
36328 aliasing router. One approach is to create a separate alias file for each
36329 virtual domain. Exim can test for the existence of the alias file to determine
36330 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36331 to a router of this form:
36332 .code
36333 virtual:
36334   driver = redirect
36335   domains = dsearch;/etc/mail/virtual
36336   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36337   no_more
36338 .endd
36339 The &%domains%& option specifies that the router is to be skipped, unless there
36340 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36341 domain that is being processed. When the router runs, it looks up the local
36342 part in the file to find a new address (or list of addresses). The &%no_more%&
36343 setting ensures that if the lookup fails (leading to &%data%& being an empty
36344 string), Exim gives up on the address without trying any subsequent routers.
36345
36346 This one router can handle all the virtual domains because the alias filenames
36347 follow a fixed pattern. Permissions can be arranged so that appropriate people
36348 can edit the different alias files. A successful aliasing operation results in
36349 a new envelope recipient address, which is then routed from scratch.
36350
36351 The other kind of &"virtual"& domain can also be handled in a straightforward
36352 way. One approach is to create a file for each domain containing a list of
36353 valid local parts, and use it in a router like this:
36354 .code
36355 my_domains:
36356   driver = accept
36357   domains = dsearch;/etc/mail/domains
36358   local_parts = lsearch;/etc/mail/domains/$domain
36359   transport = my_mailboxes
36360 .endd
36361 The address is accepted if there is a file for the domain, and the local part
36362 can be found in the file. The &%domains%& option is used to check for the
36363 file's existence because &%domains%& is tested before the &%local_parts%&
36364 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36365 because that option is tested after &%local_parts%&. The transport is as
36366 follows:
36367 .code
36368 my_mailboxes:
36369   driver = appendfile
36370   file = /var/mail/$domain/$local_part
36371   user = mail
36372 .endd
36373 This uses a directory of mailboxes for each domain. The &%user%& setting is
36374 required, to specify which uid is to be used for writing to the mailboxes.
36375
36376 The configuration shown here is just one example of how you might support this
36377 requirement. There are many other ways this kind of configuration can be set
36378 up, for example, by using a database instead of separate files to hold all the
36379 information about the domains.
36380
36381
36382
36383 .section "Multiple user mailboxes" "SECTmulbox"
36384 .cindex "multiple mailboxes"
36385 .cindex "mailbox" "multiple"
36386 .cindex "local part" "prefix"
36387 .cindex "local part" "suffix"
36388 Heavy email users often want to operate with multiple mailboxes, into which
36389 incoming mail is automatically sorted. A popular way of handling this is to
36390 allow users to use multiple sender addresses, so that replies can easily be
36391 identified. Users are permitted to add prefixes or suffixes to their local
36392 parts for this purpose. The wildcard facility of the generic router options
36393 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36394 example, consider this router:
36395 .code
36396 userforward:
36397   driver = redirect
36398   check_local_user
36399   file = $home/.forward
36400   local_part_suffix = -*
36401   local_part_suffix_optional
36402   allow_filter
36403 .endd
36404 .vindex "&$local_part_suffix$&"
36405 It runs a user's &_.forward_& file for all local parts of the form
36406 &'username-*'&. Within the filter file the user can distinguish different
36407 cases by testing the variable &$local_part_suffix$&. For example:
36408 .code
36409 if $local_part_suffix contains -special then
36410 save /home/$local_part/Mail/special
36411 endif
36412 .endd
36413 If the filter file does not exist, or does not deal with such addresses, they
36414 fall through to subsequent routers, and, assuming no subsequent use of the
36415 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36416 control over which suffixes are valid.
36417
36418 Alternatively, a suffix can be used to trigger the use of a different
36419 &_.forward_& file &-- which is the way a similar facility is implemented in
36420 another MTA:
36421 .code
36422 userforward:
36423   driver = redirect
36424   check_local_user
36425   file = $home/.forward$local_part_suffix
36426   local_part_suffix = -*
36427   local_part_suffix_optional
36428   allow_filter
36429 .endd
36430 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36431 example, &_.forward-special_& is used. Once again, if the appropriate file
36432 does not exist, or does not deal with the address, it is passed on to
36433 subsequent routers, which could, if required, look for an unqualified
36434 &_.forward_& file to use as a default.
36435
36436
36437
36438 .section "Simplified vacation processing" "SECID244"
36439 .cindex "vacation processing"
36440 The traditional way of running the &'vacation'& program is for a user to set up
36441 a pipe command in a &_.forward_& file
36442 (see section &<<SECTspecitredli>>& for syntax details).
36443 This is prone to error by inexperienced users. There are two features of Exim
36444 that can be used to make this process simpler for users:
36445
36446 .ilist
36447 A local part prefix such as &"vacation-"& can be specified on a router which
36448 can cause the message to be delivered directly to the &'vacation'& program, or
36449 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36450 &_.forward_& file are then much simpler. For example:
36451 .code
36452 spqr, vacation-spqr
36453 .endd
36454 .next
36455 The &%require_files%& generic router option can be used to trigger a
36456 vacation delivery by checking for the existence of a certain file in the
36457 user's home directory. The &%unseen%& generic option should also be used, to
36458 ensure that the original delivery also proceeds. In this case, all the user has
36459 to do is to create a file called, say, &_.vacation_&, containing a vacation
36460 message.
36461 .endlist
36462
36463 Another advantage of both these methods is that they both work even when the
36464 use of arbitrary pipes by users is locked out.
36465
36466
36467
36468 .section "Taking copies of mail" "SECID245"
36469 .cindex "message" "copying every"
36470 Some installations have policies that require archive copies of all messages to
36471 be made. A single copy of each message can easily be taken by an appropriate
36472 command in a system filter, which could, for example, use a different file for
36473 each day's messages.
36474
36475 There is also a shadow transport mechanism that can be used to take copies of
36476 messages that are successfully delivered by local transports, one copy per
36477 delivery. This could be used, &'inter alia'&, to implement automatic
36478 notification of delivery by sites that insist on doing such things.
36479
36480
36481
36482 .section "Intermittently connected hosts" "SECID246"
36483 .cindex "intermittently connected hosts"
36484 It has become quite common (because it is cheaper) for hosts to connect to the
36485 Internet periodically rather than remain connected all the time. The normal
36486 arrangement is that mail for such hosts accumulates on a system that is
36487 permanently connected.
36488
36489 Exim was designed for use on permanently connected hosts, and so it is not
36490 particularly well-suited to use in an intermittently connected environment.
36491 Nevertheless there are some features that can be used.
36492
36493
36494 .section "Exim on the upstream server host" "SECID247"
36495 It is tempting to arrange for incoming mail for the intermittently connected
36496 host to remain in Exim's queue until the client connects. However, this
36497 approach does not scale very well. Two different kinds of waiting message are
36498 being mixed up in the same queue &-- those that cannot be delivered because of
36499 some temporary problem, and those that are waiting for their destination host
36500 to connect. This makes it hard to manage the queue, as well as wasting
36501 resources, because each queue runner scans the entire queue.
36502
36503 A better approach is to separate off those messages that are waiting for an
36504 intermittently connected host. This can be done by delivering these messages
36505 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36506 format, from where they are transmitted by other software when their
36507 destination connects. This makes it easy to collect all the mail for one host
36508 in a single directory, and to apply local timeout rules on a per-message basis
36509 if required.
36510
36511 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36512 you are doing this, you should configure Exim with a long retry period for the
36513 intermittent host. For example:
36514 .code
36515 cheshire.wonderland.fict.example    *   F,5d,24h
36516 .endd
36517 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36518 which messages it has queued up for that host. Once the intermittent host comes
36519 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36520 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36521 causes all the queued up messages to be delivered, often down a single SMTP
36522 connection. While the host remains connected, any new messages get delivered
36523 immediately.
36524
36525 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36526 issued with a different IP address each time it connects, Exim's retry
36527 mechanisms on the holding host get confused, because the IP address is normally
36528 used as part of the key string for holding retry information. This can be
36529 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36530 Since this has disadvantages for permanently connected hosts, it is best to
36531 arrange a separate transport for the intermittently connected ones.
36532
36533
36534
36535 .section "Exim on the intermittently connected client host" "SECID248"
36536 The value of &%smtp_accept_queue_per_connection%& should probably be
36537 increased, or even set to zero (that is, disabled) on the intermittently
36538 connected host, so that all incoming messages down a single connection get
36539 delivered immediately.
36540
36541 .cindex "SMTP" "passed connection"
36542 .cindex "SMTP" "multiple deliveries"
36543 .cindex "multiple SMTP deliveries"
36544 Mail waiting to be sent from an intermittently connected host will probably
36545 not have been routed, because without a connection DNS lookups are not
36546 possible. This means that if a normal queue run is done at connection time,
36547 each message is likely to be sent in a separate SMTP session. This can be
36548 avoided by starting the queue run with a command line option beginning with
36549 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36550 first pass, routing is done but no deliveries take place. The second pass is a
36551 normal queue run; since all the messages have been previously routed, those
36552 destined for the same host are likely to get sent as multiple deliveries in a
36553 single SMTP connection.
36554
36555
36556
36557 . ////////////////////////////////////////////////////////////////////////////
36558 . ////////////////////////////////////////////////////////////////////////////
36559
36560 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36561          "Exim as a non-queueing client"
36562 .cindex "client, non-queueing"
36563 .cindex "smart host" "suppressing queueing"
36564 On a personal computer, it is a common requirement for all
36565 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36566 configured to operate that way, for all the popular operating systems.
36567 However, there are some MUAs for Unix-like systems that cannot be so
36568 configured: they submit messages using the command line interface of
36569 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36570 messages this way.
36571
36572 If the personal computer runs continuously, there is no problem, because it can
36573 run a conventional MTA that handles delivery to the smart host, and deal with
36574 any delays via its queueing mechanism. However, if the computer does not run
36575 continuously or runs different operating systems at different times, queueing
36576 email is not desirable.
36577
36578 There is therefore a requirement for something that can provide the
36579 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36580 any queueing or retrying facilities. Furthermore, the delivery to the smart
36581 host should be synchronous, so that if it fails, the sending MUA is immediately
36582 informed. In other words, we want something that extends an MUA that submits
36583 to a local MTA via the command line so that it behaves like one that submits
36584 to a remote smart host using TCP/SMTP.
36585
36586 There are a number of applications (for example, there is one called &'ssmtp'&)
36587 that do this job. However, people have found them to be lacking in various
36588 ways. For instance, you might want to allow aliasing and forwarding to be done
36589 before sending a message to the smart host.
36590
36591 Exim already had the necessary infrastructure for doing this job. Just a few
36592 tweaks were needed to make it behave as required, though it is somewhat of an
36593 overkill to use a fully-featured MTA for this purpose.
36594
36595 .oindex "&%mua_wrapper%&"
36596 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36597 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36598 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36599 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36600 compatible router and transport configuration. Typically there will be just one
36601 router and one transport, sending everything to a smart host.
36602
36603 When run in MUA wrapping mode, the behaviour of Exim changes in the
36604 following ways:
36605
36606 .ilist
36607 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36608 In other words, the only way to submit messages is via the command line.
36609 .next
36610 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36611 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36612 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36613 does not finish until the delivery attempt is complete. If the delivery is
36614 successful, a zero return code is given.
36615 .next
36616 Address redirection is permitted, but the final routing for all addresses must
36617 be to the same remote transport, and to the same list of hosts. Furthermore,
36618 the return address (envelope sender) must be the same for all recipients, as
36619 must any added or deleted header lines. In other words, it must be possible to
36620 deliver the message in a single SMTP transaction, however many recipients there
36621 are.
36622 .next
36623 If these conditions are not met, or if routing any address results in a
36624 failure or defer status, or if Exim is unable to deliver all the recipients
36625 successfully to one of the smart hosts, delivery of the entire message fails.
36626 .next
36627 Because no queueing is allowed, all failures are treated as permanent; there
36628 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36629 smart host. Furthermore, because only a single yes/no response can be given to
36630 the caller, it is not possible to deliver to some recipients and not others. If
36631 there is an error (temporary or permanent) for any recipient, all are failed.
36632 .next
36633 If more than one smart host is listed, Exim will try another host after a
36634 connection failure or a timeout, in the normal way. However, if this kind of
36635 failure happens for all the hosts, the delivery fails.
36636 .next
36637 When delivery fails, an error message is written to the standard error stream
36638 (as well as to Exim's log), and Exim exits to the caller with a return code
36639 value 1. The message is expunged from Exim's spool files. No bounce messages
36640 are ever generated.
36641 .next
36642 No retry data is maintained, and any retry rules are ignored.
36643 .next
36644 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36645 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36646 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36647 .endlist
36648
36649 The overall effect is that Exim makes a single synchronous attempt to deliver
36650 the message, failing if there is any kind of problem. Because no local
36651 deliveries are done and no daemon can be run, Exim does not need root
36652 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36653 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36654 the advantages and disadvantages of running without root privilege.
36655
36656
36657
36658
36659 . ////////////////////////////////////////////////////////////////////////////
36660 . ////////////////////////////////////////////////////////////////////////////
36661
36662 .chapter "Log files" "CHAPlog"
36663 .scindex IIDloggen "log" "general description"
36664 .cindex "log" "types of"
36665 Exim writes three different logs, referred to as the main log, the reject log,
36666 and the panic log:
36667
36668 .ilist
36669 .cindex "main log"
36670 The main log records the arrival of each message and each delivery in a single
36671 line in each case. The format is as compact as possible, in an attempt to keep
36672 down the size of log files. Two-character flag sequences make it easy to pick
36673 out these lines. A number of other events are recorded in the main log. Some of
36674 them are optional, in which case the &%log_selector%& option controls whether
36675 they are included or not. A Perl script called &'eximstats'&, which does simple
36676 analysis of main log files, is provided in the Exim distribution (see section
36677 &<<SECTmailstat>>&).
36678 .next
36679 .cindex "reject log"
36680 The reject log records information from messages that are rejected as a result
36681 of a configuration option (that is, for policy reasons).
36682 The first line of each rejection is a copy of the line that is also written to
36683 the main log. Then, if the message's header has been read at the time the log
36684 is written, its contents are written to this log. Only the original header
36685 lines are available; header lines added by ACLs are not logged. You can use the
36686 reject log to check that your policy controls are working correctly; on a busy
36687 host this may be easier than scanning the main log for rejection messages. You
36688 can suppress the writing of the reject log by setting &%write_rejectlog%&
36689 false.
36690 .next
36691 .cindex "panic log"
36692 .cindex "system log"
36693 When certain serious errors occur, Exim writes entries to its panic log. If the
36694 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36695 are usually written to the main log as well, but can get lost amid the mass of
36696 other entries. The panic log should be empty under normal circumstances. It is
36697 therefore a good idea to check it (or to have a &'cron'& script check it)
36698 regularly, in order to become aware of any problems. When Exim cannot open its
36699 panic log, it tries as a last resort to write to the system log (syslog). This
36700 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36701 message itself is written at priority LOG_CRIT.
36702 .endlist
36703
36704 Every log line starts with a timestamp, in the format shown in the following
36705 example. Note that many of the examples shown in this chapter are line-wrapped.
36706 In the log file, this would be all on one line:
36707 .code
36708 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36709   by QUIT
36710 .endd
36711 By default, the timestamps are in the local timezone. There are two
36712 ways of changing this:
36713
36714 .ilist
36715 You can set the &%timezone%& option to a different time zone; in particular, if
36716 you set
36717 .code
36718 timezone = UTC
36719 .endd
36720 the timestamps will be in UTC (aka GMT).
36721 .next
36722 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36723 example:
36724 .code
36725 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36726 .endd
36727 .endlist
36728
36729 .cindex "log" "process ids in"
36730 .cindex "pid (process id)" "in log lines"
36731 Exim does not include its process id in log lines by default, but you can
36732 request that it does so by specifying the &`pid`& log selector (see section
36733 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36734 brackets, immediately after the time and date.
36735
36736
36737
36738
36739 .section "Where the logs are written" "SECTwhelogwri"
36740 .cindex "log" "destination"
36741 .cindex "log" "to file"
36742 .cindex "log" "to syslog"
36743 .cindex "syslog"
36744 The logs may be written to local files, or to syslog, or both. However, it
36745 should be noted that many syslog implementations use UDP as a transport, and
36746 are therefore unreliable in the sense that messages are not guaranteed to
36747 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36748 It has also been reported that on large log files (tens of megabytes) you may
36749 need to tweak syslog to prevent it syncing the file with each write &-- on
36750 Linux this has been seen to make syslog take 90% plus of CPU time.
36751
36752 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36753 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36754 configuration. This latter string is expanded, so it can contain, for example,
36755 references to the host name:
36756 .code
36757 log_file_path = /var/log/$primary_hostname/exim_%slog
36758 .endd
36759 It is generally advisable, however, to set the string in &_Local/Makefile_&
36760 rather than at runtime, because then the setting is available right from the
36761 start of Exim's execution. Otherwise, if there's something it wants to log
36762 before it has read the configuration file (for example, an error in the
36763 configuration file) it will not use the path you want, and may not be able to
36764 log at all.
36765
36766 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36767 list, currently limited to at most two items. This is one option where the
36768 facility for changing a list separator may not be used. The list must always be
36769 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36770 otherwise the item must either be an absolute path, containing &`%s`& at the
36771 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36772 implying the use of a default path.
36773
36774 When Exim encounters an empty item in the list, it searches the list defined by
36775 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36776 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36777 mean &"use the path specified at build time"&. It no such item exists, log
36778 files are written in the &_log_& subdirectory of the spool directory. This is
36779 equivalent to the setting:
36780 .code
36781 log_file_path = $spool_directory/log/%slog
36782 .endd
36783 If you do not specify anything at build time or runtime,
36784 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36785 that is where the logs are written.
36786
36787 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36788 are in use &-- see section &<<SECTdatlogfil>>& below.
36789
36790 Here are some examples of possible settings:
36791 .display
36792 &`LOG_FILE_PATH=syslog                    `& syslog only
36793 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36794 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36795 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36796 .endd
36797 If there are more than two paths in the list, the first is used and a panic
36798 error is logged.
36799
36800
36801
36802 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36803 .cindex "log" "cycling local files"
36804 .cindex "cycling logs"
36805 .cindex "&'exicyclog'&"
36806 .cindex "log" "local files; writing to"
36807 Some operating systems provide centralized and standardized methods for cycling
36808 log files. For those that do not, a utility script called &'exicyclog'& is
36809 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36810 main and reject logs each time it is called. The maximum number of old logs to
36811 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36812
36813 An Exim delivery process opens the main log when it first needs to write to it,
36814 and it keeps the file open in case subsequent entries are required &-- for
36815 example, if a number of different deliveries are being done for the same
36816 message. However, remote SMTP deliveries can take a long time, and this means
36817 that the file may be kept open long after it is renamed if &'exicyclog'& or
36818 something similar is being used to rename log files on a regular basis. To
36819 ensure that a switch of log files is noticed as soon as possible, Exim calls
36820 &[stat()]& on the main log's name before reusing an open file, and if the file
36821 does not exist, or its inode has changed, the old file is closed and Exim
36822 tries to open the main log from scratch. Thus, an old log file may remain open
36823 for quite some time, but no Exim processes should write to it once it has been
36824 renamed.
36825
36826
36827
36828 .section "Datestamped log files" "SECTdatlogfil"
36829 .cindex "log" "datestamped files"
36830 Instead of cycling the main and reject log files by renaming them
36831 periodically, some sites like to use files whose names contain a datestamp,
36832 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36833 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36834 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36835 point where the datestamp is required. For example:
36836 .code
36837 log_file_path = /var/spool/exim/log/%slog-%D
36838 log_file_path = /var/log/exim-%s-%D.log
36839 log_file_path = /var/spool/exim/log/%D-%slog
36840 log_file_path = /var/log/exim/%s.%M
36841 .endd
36842 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36843 examples of names generated by the above examples:
36844 .code
36845 /var/spool/exim/log/mainlog-20021225
36846 /var/log/exim-reject-20021225.log
36847 /var/spool/exim/log/20021225-mainlog
36848 /var/log/exim/main.200212
36849 .endd
36850 When this form of log file is specified, Exim automatically switches to new
36851 files at midnight. It does not make any attempt to compress old logs; you
36852 will need to write your own script if you require this. You should not
36853 run &'exicyclog'& with this form of logging.
36854
36855 The location of the panic log is also determined by &%log_file_path%&, but it
36856 is not datestamped, because rotation of the panic log does not make sense.
36857 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36858 the string. In addition, if it immediately follows a slash, a following
36859 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36860 character is removed. Thus, the four examples above would give these panic
36861 log names:
36862 .code
36863 /var/spool/exim/log/paniclog
36864 /var/log/exim-panic.log
36865 /var/spool/exim/log/paniclog
36866 /var/log/exim/panic
36867 .endd
36868
36869
36870 .section "Logging to syslog" "SECID249"
36871 .cindex "log" "syslog; writing to"
36872 The use of syslog does not change what Exim logs or the format of its messages,
36873 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36874 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36875 that, the same strings are written to syslog as to log files. The syslog
36876 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36877 by default, but you can change these by setting the &%syslog_facility%& and
36878 &%syslog_processname%& options, respectively. If Exim was compiled with
36879 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36880 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36881 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36882 the time and host name to each line.
36883 The three log streams are mapped onto syslog priorities as follows:
36884
36885 .ilist
36886 &'mainlog'& is mapped to LOG_INFO
36887 .next
36888 &'rejectlog'& is mapped to LOG_NOTICE
36889 .next
36890 &'paniclog'& is mapped to LOG_ALERT
36891 .endlist
36892
36893 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36894 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36895 these are routed by syslog to the same place. You can suppress this duplication
36896 by setting &%syslog_duplication%& false.
36897
36898 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36899 entries contain multiple lines when headers are included. To cope with both
36900 these cases, entries written to syslog are split into separate &[syslog()]&
36901 calls at each internal newline, and also after a maximum of
36902 870 data characters. (This allows for a total syslog line length of 1024, when
36903 additions such as timestamps are added.) If you are running a syslog
36904 replacement that can handle lines longer than the 1024 characters allowed by
36905 RFC 3164, you should set
36906 .code
36907 SYSLOG_LONG_LINES=yes
36908 .endd
36909 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36910 lines, but it still splits at internal newlines in &'reject'& log entries.
36911
36912 To make it easy to re-assemble split lines later, each component of a split
36913 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36914 where <&'n'&> is the component number and <&'m'&> is the total number of
36915 components in the entry. The / delimiter is used when the line was split
36916 because it was too long; if it was split because of an internal newline, the \
36917 delimiter is used. For example, supposing the length limit to be 50 instead of
36918 870, the following would be the result of a typical rejection message to
36919 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36920 name, and pid as added by syslog:
36921 .code
36922 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36923 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36924 [3/5]  when scanning for sender: missing or malformed lo
36925 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36926 [5/5] mple>)
36927 .endd
36928 The same error might cause the following lines to be written to &"rejectlog"&
36929 (LOG_NOTICE):
36930 .code
36931 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36932 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36933 [3/18] er when scanning for sender: missing or malformed
36934 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36935 [5\18] .example>)
36936 [6\18] Recipients: ph10@some.domain.cam.example
36937 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36938 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36939 [9\18]        id 16RdAL-0006pc-00
36940 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36941 [11\18] 09:43 +0100
36942 [12\18] F From: <>
36943 [13\18]   Subject: this is a test header
36944 [18\18]   X-something: this is another header
36945 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36946 [16\18] le>
36947 [17\18] B Bcc:
36948 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36949 .endd
36950 Log lines that are neither too long nor contain newlines are written to syslog
36951 without modification.
36952
36953 If only syslog is being used, the Exim monitor is unable to provide a log tail
36954 display, unless syslog is routing &'mainlog'& to a file on the local host and
36955 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36956 where it is.
36957
36958
36959
36960 .section "Log line flags" "SECID250"
36961 One line is written to the main log for each message received, and for each
36962 successful, unsuccessful, and delayed delivery. These lines can readily be
36963 picked out by the distinctive two-character flags that immediately follow the
36964 timestamp. The flags are:
36965 .display
36966 &`<=`&     message arrival
36967 &`(=`&     message fakereject
36968 &`=>`&     normal message delivery
36969 &`->`&     additional address in same delivery
36970 &`>>`&     cutthrough message delivery
36971 &`*>`&     delivery suppressed by &%-N%&
36972 &`**`&     delivery failed; address bounced
36973 &`==`&     delivery deferred; temporary problem
36974 .endd
36975
36976
36977 .section "Logging message reception" "SECID251"
36978 .cindex "log" "reception line"
36979 The format of the single-line entry in the main log that is written for every
36980 message received is shown in the basic example below, which is split over
36981 several lines in order to fit it on the page:
36982 .code
36983 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36984   H=mailer.fict.example [192.168.123.123] U=exim
36985   P=smtp S=5678 id=<incoming message id>
36986 .endd
36987 The address immediately following &"<="& is the envelope sender address. A
36988 bounce message is shown with the sender address &"<>"&, and if it is locally
36989 generated, this is followed by an item of the form
36990 .code
36991 R=<message id>
36992 .endd
36993 which is a reference to the message that caused the bounce to be sent.
36994
36995 .cindex "HELO"
36996 .cindex "EHLO"
36997 For messages from other hosts, the H and U fields identify the remote host and
36998 record the RFC 1413 identity of the user that sent the message, if one was
36999 received. The number given in square brackets is the IP address of the sending
37000 host. If there is a single, unparenthesized  host name in the H field, as
37001 above, it has been verified to correspond to the IP address (see the
37002 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37003 by the remote host in the SMTP HELO or EHLO command, and has not been
37004 verified. If verification yields a different name to that given for HELO or
37005 EHLO, the verified name appears first, followed by the HELO or EHLO
37006 name in parentheses.
37007
37008 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37009 without brackets, in the HELO or EHLO command, leading to entries in
37010 the log containing text like these examples:
37011 .code
37012 H=(10.21.32.43) [192.168.8.34]
37013 H=([10.21.32.43]) [192.168.8.34]
37014 .endd
37015 This can be confusing. Only the final address in square brackets can be relied
37016 on.
37017
37018 For locally generated messages (that is, messages not received over TCP/IP),
37019 the H field is omitted, and the U field contains the login name of the caller
37020 of Exim.
37021
37022 .cindex "authentication" "logging"
37023 .cindex "AUTH" "logging"
37024 For all messages, the P field specifies the protocol used to receive the
37025 message. This is the value that is stored in &$received_protocol$&. In the case
37026 of incoming SMTP messages, the value indicates whether or not any SMTP
37027 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37028 session was encrypted, there is an additional X field that records the cipher
37029 suite that was used.
37030
37031 .cindex log protocol
37032 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37033 hosts that have authenticated themselves using the SMTP AUTH command. The first
37034 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37035 there is an additional item A= followed by the name of the authenticator that
37036 was used. If an authenticated identification was set up by the authenticator's
37037 &%server_set_id%& option, this is logged too, separated by a colon from the
37038 authenticator name.
37039
37040 .cindex "size" "of message"
37041 The id field records the existing message id, if present. The size of the
37042 received message is given by the S field. When the message is delivered,
37043 headers may be removed or added, so that the size of delivered copies of the
37044 message may not correspond with this value (and indeed may be different to each
37045 other).
37046
37047 The &%log_selector%& option can be used to request the logging of additional
37048 data when a message is received. See section &<<SECTlogselector>>& below.
37049
37050
37051
37052 .section "Logging deliveries" "SECID252"
37053 .cindex "log" "delivery line"
37054 The format of the single-line entry in the main log that is written for every
37055 delivery is shown in one of the examples below, for local and remote
37056 deliveries, respectively. Each example has been split into multiple lines in order
37057 to fit it on the page:
37058 .code
37059 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37060   <marv@hitch.fict.example> R=localuser T=local_delivery
37061 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37062   monk@holistic.fict.example R=dnslookup T=remote_smtp
37063   H=holistic.fict.example [192.168.234.234]
37064 .endd
37065 For ordinary local deliveries, the original address is given in angle brackets
37066 after the final delivery address, which might be a pipe or a file. If
37067 intermediate address(es) exist between the original and the final address, the
37068 last of these is given in parentheses after the final address. The R and T
37069 fields record the router and transport that were used to process the address.
37070
37071 If SMTP AUTH was used for the delivery there is an additional item A=
37072 followed by the name of the authenticator that was used.
37073 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37074 option, this is logged too, separated by a colon from the authenticator name.
37075
37076 If a shadow transport was run after a successful local delivery, the log line
37077 for the successful delivery has an item added on the end, of the form
37078 .display
37079 &`ST=<`&&'shadow transport name'&&`>`&
37080 .endd
37081 If the shadow transport did not succeed, the error message is put in
37082 parentheses afterwards.
37083
37084 .cindex "asterisk" "after IP address"
37085 When more than one address is included in a single delivery (for example, two
37086 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37087 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37088 down a single SMTP connection, an asterisk follows the IP address in the log
37089 lines for the second and subsequent messages.
37090 When two or more messages are delivered down a single TLS connection, the
37091 DNS and some TLS-related information logged for the first message delivered
37092 will not be present in the log lines for the second and subsequent messages.
37093 TLS cipher information is still available.
37094
37095 .cindex "delivery" "cutthrough; logging"
37096 .cindex "cutthrough" "logging"
37097 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37098 line precedes the reception line, since cutthrough waits for a possible
37099 rejection from the destination in case it can reject the sourced item.
37100
37101 The generation of a reply message by a filter file gets logged as a
37102 &"delivery"& to the addressee, preceded by &">"&.
37103
37104 The &%log_selector%& option can be used to request the logging of additional
37105 data when a message is delivered. See section &<<SECTlogselector>>& below.
37106
37107
37108 .section "Discarded deliveries" "SECID253"
37109 .cindex "discarded messages"
37110 .cindex "message" "discarded"
37111 .cindex "delivery" "discarded; logging"
37112 When a message is discarded as a result of the command &"seen finish"& being
37113 obeyed in a filter file which generates no deliveries, a log entry of the form
37114 .code
37115 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37116   <low.club@bridge.example> R=userforward
37117 .endd
37118 is written, to record why no deliveries are logged. When a message is discarded
37119 because it is aliased to &":blackhole:"& the log line is like this:
37120 .code
37121 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37122   <hole@nowhere.example> R=blackhole_router
37123 .endd
37124
37125
37126 .section "Deferred deliveries" "SECID254"
37127 When a delivery is deferred, a line of the following form is logged:
37128 .code
37129 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37130   R=dnslookup T=smtp defer (146): Connection refused
37131 .endd
37132 In the case of remote deliveries, the error is the one that was given for the
37133 last IP address that was tried. Details of individual SMTP failures are also
37134 written to the log, so the above line would be preceded by something like
37135 .code
37136 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37137   mail1.endrest.example [192.168.239.239]: Connection refused
37138 .endd
37139 When a deferred address is skipped because its retry time has not been reached,
37140 a message is written to the log, but this can be suppressed by setting an
37141 appropriate value in &%log_selector%&.
37142
37143
37144
37145 .section "Delivery failures" "SECID255"
37146 .cindex "delivery" "failure; logging"
37147 If a delivery fails because an address cannot be routed, a line of the
37148 following form is logged:
37149 .code
37150 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37151   <jim@trek99.example>: unknown mail domain
37152 .endd
37153 If a delivery fails at transport time, the router and transport are shown, and
37154 the response from the remote host is included, as in this example:
37155 .code
37156 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37157   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37158   after pipelined RCPT TO:<ace400@pb.example>: host
37159   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37160   <ace400@pb.example>...Addressee unknown
37161 .endd
37162 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37163 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37164 disabling PIPELINING. The log lines for all forms of delivery failure are
37165 flagged with &`**`&.
37166
37167
37168
37169 .section "Fake deliveries" "SECID256"
37170 .cindex "delivery" "fake; logging"
37171 If a delivery does not actually take place because the &%-N%& option has been
37172 used to suppress it, a normal delivery line is written to the log, except that
37173 &"=>"& is replaced by &"*>"&.
37174
37175
37176
37177 .section "Completion" "SECID257"
37178 A line of the form
37179 .code
37180 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37181 .endd
37182 is written to the main log when a message is about to be removed from the spool
37183 at the end of its processing.
37184
37185
37186
37187
37188 .section "Summary of Fields in Log Lines" "SECID258"
37189 .cindex "log" "summary of fields"
37190 A summary of the field identifiers that are used in log lines is shown in
37191 the following table:
37192 .display
37193 &`A   `&        authenticator name (and optional id and sender)
37194 &`C   `&        SMTP confirmation on delivery
37195 &`    `&        command list for &"no mail in SMTP session"&
37196 &`CV  `&        certificate verification status
37197 &`D   `&        duration of &"no mail in SMTP session"&
37198 &`DKIM`&        domain verified in incoming message
37199 &`DN  `&        distinguished name from peer certificate
37200 &`DS  `&        DNSSEC secured lookups
37201 &`DT  `&        on &`=>`& lines: time taken for a delivery
37202 &`F   `&        sender address (on delivery lines)
37203 &`H   `&        host name and IP address
37204 &`I   `&        local interface used
37205 &`id  `&        message id (from header) for incoming message
37206 &`K   `&        CHUNKING extension used
37207 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37208 &`M8S `&        8BITMIME status for incoming message
37209 &`P   `&        on &`<=`& lines: protocol used
37210 &`    `&        on &`=>`& and &`**`& lines: return path
37211 &`PRDR`&        PRDR extension used
37212 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37213 &`Q   `&        alternate queue name
37214 &`QT  `&        on &`=>`& lines: time spent on queue so far
37215 &`    `&        on &"Completed"& lines: time spent on queue
37216 &`R   `&        on &`<=`& lines: reference for local bounce
37217 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37218 &`RT  `&        on &`<=`& lines: time taken for reception
37219 &`S   `&        size of message in bytes
37220 &`SNI `&        server name indication from TLS client hello
37221 &`ST  `&        shadow transport name
37222 &`T   `&        on &`<=`& lines: message subject (topic)
37223 &`TFO `&        connection took advantage of TCP Fast Open
37224 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37225 &`U   `&        local user or RFC 1413 identity
37226 &`X   `&        TLS cipher suite
37227 .endd
37228
37229
37230 .section "Other log entries" "SECID259"
37231 Various other types of log entry are written from time to time. Most should be
37232 self-explanatory. Among the more common are:
37233
37234 .ilist
37235 .cindex "retry" "time not reached"
37236 &'retry time not reached'&&~&~An address previously suffered a temporary error
37237 during routing or local delivery, and the time to retry has not yet arrived.
37238 This message is not written to an individual message log file unless it happens
37239 during the first delivery attempt.
37240 .next
37241 &'retry time not reached for any host'&&~&~An address previously suffered
37242 temporary errors during remote delivery, and the retry time has not yet arrived
37243 for any of the hosts to which it is routed.
37244 .next
37245 .cindex "spool directory" "file locked"
37246 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37247 some other Exim process is already working on the message. This can be quite
37248 common if queue running processes are started at frequent intervals. The
37249 &'exiwhat'& utility script can be used to find out what Exim processes are
37250 doing.
37251 .next
37252 .cindex "error" "ignored"
37253 &'error ignored'&&~&~There are several circumstances that give rise to this
37254 message:
37255 .olist
37256 Exim failed to deliver a bounce message whose age was greater than
37257 &%ignore_bounce_errors_after%&. The bounce was discarded.
37258 .next
37259 A filter file set up a delivery using the &"noerror"& option, and the delivery
37260 failed. The delivery was discarded.
37261 .next
37262 A delivery set up by a router configured with
37263 . ==== As this is a nested list, any displays it contains must be indented
37264 . ==== as otherwise they are too far to the left.
37265 .code
37266     errors_to = <>
37267 .endd
37268 failed. The delivery was discarded.
37269 .endlist olist
37270 .next
37271 .cindex DKIM "log line"
37272 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37273 logging and the message has a DKIM signature header.
37274 .endlist ilist
37275
37276
37277
37278
37279
37280 .section "Reducing or increasing what is logged" "SECTlogselector"
37281 .cindex "log" "selectors"
37282 By setting the &%log_selector%& global option, you can disable some of Exim's
37283 default logging, or you can request additional logging. The value of
37284 &%log_selector%& is made up of names preceded by plus or minus characters. For
37285 example:
37286 .code
37287 log_selector = +arguments -retry_defer
37288 .endd
37289 The list of optional log items is in the following table, with the default
37290 selection marked by asterisks:
37291 .display
37292 &` 8bitmime                   `&  received 8BITMIME status
37293 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37294 &` address_rewrite            `&  address rewriting
37295 &` all_parents                `&  all parents in => lines
37296 &` arguments                  `&  command line arguments
37297 &`*connection_reject          `&  connection rejections
37298 &`*delay_delivery             `&  immediate delivery delayed
37299 &` deliver_time               `&  time taken to perform delivery
37300 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37301 &`*dkim                       `&  DKIM verified domain on <= lines
37302 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37303 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37304 &` dnssec                     `&  DNSSEC secured lookups
37305 &`*etrn                       `&  ETRN commands
37306 &`*host_lookup_failed         `&  as it says
37307 &` ident_timeout              `&  timeout for ident connection
37308 &` incoming_interface         `&  local interface on <= and => lines
37309 &` incoming_port              `&  remote port on <= lines
37310 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37311 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37312 &`*msg_id                     `&  on <= lines, Message-ID: header value
37313 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37314 &` outgoing_interface         `&  local interface on => lines
37315 &` outgoing_port              `&  add remote port to => lines
37316 &`*queue_run                  `&  start and end queue runs
37317 &` queue_time                 `&  time on queue for one recipient
37318 &` queue_time_overall         `&  time on queue for whole message
37319 &` pid                        `&  Exim process id
37320 &` pipelining                 `&  PIPELINING use, on <= and => lines
37321 &` proxy                      `&  proxy address on <= and => lines
37322 &` receive_time               `&  time taken to receive message
37323 &` received_recipients        `&  recipients on <= lines
37324 &` received_sender            `&  sender on <= lines
37325 &`*rejected_header            `&  header contents on reject log
37326 &`*retry_defer                `&  &"retry time not reached"&
37327 &` return_path_on_delivery    `&  put return path on => and ** lines
37328 &` sender_on_delivery         `&  add sender to => lines
37329 &`*sender_verify_fail         `&  sender verification failures
37330 &`*size_reject                `&  rejection because too big
37331 &`*skip_delivery              `&  delivery skipped in a queue run
37332 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37333 &` smtp_connection            `&  incoming SMTP connections
37334 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37335 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37336 &` smtp_no_mail               `&  session with no MAIL commands
37337 &` smtp_protocol_error        `&  SMTP protocol errors
37338 &` smtp_syntax_error          `&  SMTP syntax errors
37339 &` subject                    `&  contents of &'Subject:'& on <= lines
37340 &`*tls_certificate_verified   `&  certificate verification status
37341 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37342 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37343 &` tls_sni                    `&  TLS SNI on <= lines
37344 &` unknown_in_list            `&  DNS lookup failed in list match
37345
37346 &` all                        `&  all of the above
37347 .endd
37348 See also the &%slow_lookup_log%& main configuration option,
37349 section &<<SECID99>>&
37350
37351 More details on each of these items follows:
37352
37353 .ilist
37354 .cindex "8BITMIME"
37355 .cindex "log" "8BITMIME"
37356 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37357 which may help in tracking down interoperability issues with ancient MTAs
37358 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37359 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37360 &`7BIT`& and &`8BITMIME`& respectively.
37361 .next
37362 .cindex "&%warn%& ACL verb" "log when skipping"
37363 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37364 its conditions cannot be evaluated, a log line to this effect is written if
37365 this log selector is set.
37366 .next
37367 .cindex "log" "rewriting"
37368 .cindex "rewriting" "logging"
37369 &%address_rewrite%&: This applies both to global rewrites and per-transport
37370 rewrites, but not to rewrites in filters run as an unprivileged user (because
37371 such users cannot access the log).
37372 .next
37373 .cindex "log" "full parentage"
37374 &%all_parents%&: Normally only the original and final addresses are logged on
37375 delivery lines; with this selector, intermediate parents are given in
37376 parentheses between them.
37377 .next
37378 .cindex "log" "Exim arguments"
37379 .cindex "Exim arguments, logging"
37380 &%arguments%&: This causes Exim to write the arguments with which it was called
37381 to the main log, preceded by the current working directory. This is a debugging
37382 feature, added to make it easier to find out how certain MUAs call
37383 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37384 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37385 that are empty or that contain white space are quoted. Non-printing characters
37386 are shown as escape sequences. This facility cannot log unrecognized arguments,
37387 because the arguments are checked before the configuration file is read. The
37388 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37389 between the caller and Exim.
37390 .next
37391 .cindex "log" "connection rejections"
37392 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37393 connection is rejected, for whatever reason.
37394 .next
37395 .cindex "log" "delayed delivery"
37396 .cindex "delayed delivery, logging"
37397 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37398 started for an incoming message because the load is too high or too many
37399 messages were received on one connection. Logging does not occur if no delivery
37400 process is started because &%queue_only%& is set or &%-odq%& was used.
37401 .next
37402 .cindex "log" "delivery duration"
37403 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37404 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37405 If millisecond logging is enabled, short times will be shown with greater
37406 precision, eg. &`DT=0.304s`&.
37407 .next
37408 .cindex "log" "message size on delivery"
37409 .cindex "size" "of message"
37410 &%delivery_size%&: For each delivery, the size of message delivered is added to
37411 the &"=>"& line, tagged with S=.
37412 .next
37413 .cindex log "DKIM verification"
37414 .cindex DKIM "verification logging"
37415 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37416 verifies successfully a tag of DKIM is added, with one of the verified domains.
37417 .next
37418 .cindex log "DKIM verification"
37419 .cindex DKIM "verification logging"
37420 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37421 .next
37422 .cindex "log" "dnslist defer"
37423 .cindex "DNS list" "logging defer"
37424 .cindex "black list (DNS)"
37425 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37426 DNS black list suffers a temporary error.
37427 .next
37428 .cindex log dnssec
37429 .cindex dnssec logging
37430 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37431 dns lookups gave secure results a tag of DS is added.
37432 For acceptance this covers the reverse and forward lookups for host name verification.
37433 It does not cover helo-name verification.
37434 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37435 .next
37436 .cindex "log" "ETRN commands"
37437 .cindex "ETRN" "logging"
37438 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37439 is run to determine whether or not it is actually accepted. An invalid ETRN
37440 command, or one received within a message transaction is not logged by this
37441 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37442 .next
37443 .cindex "log" "host lookup failure"
37444 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37445 any addresses, or when a lookup of an IP address fails to find a host name, a
37446 log line is written. This logging does not apply to direct DNS lookups when
37447 routing email addresses, but it does apply to &"byname"& lookups.
37448 .next
37449 .cindex "log" "ident timeout"
37450 .cindex "RFC 1413" "logging timeout"
37451 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37452 client's ident port times out.
37453 .next
37454 .cindex "log" "incoming interface"
37455 .cindex "log" "local interface"
37456 .cindex "log" "local address and port"
37457 .cindex "TCP/IP" "logging local address and port"
37458 .cindex "interface" "logging"
37459 &%incoming_interface%&: The interface on which a message was received is added
37460 to the &"<="& line as an IP address in square brackets, tagged by I= and
37461 followed by a colon and the port number. The local interface and port are also
37462 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37463 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37464 The latter can be disabled by turning off the &%outgoing_interface%& option.
37465 .next
37466 .cindex log "incoming proxy address"
37467 .cindex proxy "logging proxy address"
37468 .cindex "TCP/IP" "logging proxy address"
37469 &%proxy%&: The internal (closest to the system running Exim) IP address
37470 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37471 on a proxied connection
37472 or the &"=>"& line for a message delivered on a proxied connection.
37473 See &<<SECTproxyInbound>>& for more information.
37474 .next
37475 .cindex "log" "incoming remote port"
37476 .cindex "port" "logging remote"
37477 .cindex "TCP/IP" "logging incoming remote port"
37478 .vindex "&$sender_fullhost$&"
37479 .vindex "&$sender_rcvhost$&"
37480 &%incoming_port%&: The remote port number from which a message was received is
37481 added to log entries and &'Received:'& header lines, following the IP address
37482 in square brackets, and separated from it by a colon. This is implemented by
37483 changing the value that is put in the &$sender_fullhost$& and
37484 &$sender_rcvhost$& variables. Recording the remote port number has become more
37485 important with the widening use of NAT (see RFC 2505).
37486 .next
37487 .cindex "log" "dropped connection"
37488 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37489 connection is unexpectedly dropped.
37490 .next
37491 .cindex "log" "millisecond timestamps"
37492 .cindex millisecond logging
37493 .cindex timestamps "millisecond, in logs"
37494 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37495 appended to the seconds value.
37496 .next
37497 .new
37498 .cindex "log" "message id"
37499 &%msg_id%&: The value of the Message-ID: header.
37500 .next
37501 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37502 This will be either because the message is a bounce, or was submitted locally
37503 (submission mode) without one.
37504 The field identifier will have an asterix appended: &"id*="&.
37505 .wen
37506 .next
37507 .cindex "log" "outgoing interface"
37508 .cindex "log" "local interface"
37509 .cindex "log" "local address and port"
37510 .cindex "TCP/IP" "logging local address and port"
37511 .cindex "interface" "logging"
37512 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37513 interface on which a message was sent is added to delivery lines as an I= tag
37514 followed by IP address in square brackets. You can disable this by turning
37515 off the &%outgoing_interface%& option.
37516 .next
37517 .cindex "log" "outgoing remote port"
37518 .cindex "port" "logging outgoing remote"
37519 .cindex "TCP/IP" "logging outgoing remote port"
37520 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37521 containing => tags) following the IP address.
37522 The local port is also added if &%incoming_interface%& and
37523 &%outgoing_interface%& are both enabled.
37524 This option is not included in the default setting, because for most ordinary
37525 configurations, the remote port number is always 25 (the SMTP port), and the
37526 local port is a random ephemeral port.
37527 .next
37528 .cindex "log" "process ids in"
37529 .cindex "pid (process id)" "in log lines"
37530 &%pid%&: The current process id is added to every log line, in square brackets,
37531 immediately after the time and date.
37532 .next
37533 .cindex log pipelining
37534 .cindex pipelining "logging outgoing"
37535 &%pipelining%&: A field is added to delivery and accept
37536 log lines when the ESMTP PIPELINING extension was used.
37537 The field is a single "L".
37538
37539 On accept lines, where PIPELINING was offered but not used by the client,
37540 the field has a minus appended.
37541
37542 .new
37543 .cindex "pipelining" "early connection"
37544 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37545 accept "L" fields have a period appended if the feature was
37546 offered but not used, or an asterisk appended if used.
37547 Delivery "L" fields have an asterisk appended if used.
37548 .wen
37549
37550 .next
37551 .cindex "log" "queue run"
37552 .cindex "queue runner" "logging"
37553 &%queue_run%&: The start and end of every queue run are logged.
37554 .next
37555 .cindex "log" "queue time"
37556 &%queue_time%&: The amount of time the message has been in the queue on the
37557 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37558 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37559 includes reception time as well as the delivery time for the current address.
37560 This means that it may be longer than the difference between the arrival and
37561 delivery log line times, because the arrival log line is not written until the
37562 message has been successfully received.
37563 If millisecond logging is enabled, short times will be shown with greater
37564 precision, eg. &`QT=1.578s`&.
37565 .next
37566 &%queue_time_overall%&: The amount of time the message has been in the queue on
37567 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37568 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37569 message, so it includes reception time as well as the total delivery time.
37570 .next
37571 .cindex "log" "receive duration"
37572 &%receive_time%&: For each message, the amount of real time it has taken to
37573 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37574 If millisecond logging is enabled, short times will be shown with greater
37575 precision, eg. &`RT=0.204s`&.
37576 .next
37577 .cindex "log" "recipients"
37578 &%received_recipients%&: The recipients of a message are listed in the main log
37579 as soon as the message is received. The list appears at the end of the log line
37580 that is written when a message is received, preceded by the word &"for"&. The
37581 addresses are listed after they have been qualified, but before any rewriting
37582 has taken place.
37583 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37584 in the list.
37585 .next
37586 .cindex "log" "sender reception"
37587 &%received_sender%&: The unrewritten original sender of a message is added to
37588 the end of the log line that records the message's arrival, after the word
37589 &"from"& (before the recipients if &%received_recipients%& is also set).
37590 .next
37591 .cindex "log" "header lines for rejection"
37592 &%rejected_header%&: If a message's header has been received at the time a
37593 rejection is written to the reject log, the complete header is added to the
37594 log. Header logging can be turned off individually for messages that are
37595 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37596 .next
37597 .cindex "log" "retry defer"
37598 &%retry_defer%&: A log line is written if a delivery is deferred because a
37599 retry time has not yet been reached. However, this &"retry time not reached"&
37600 message is always omitted from individual message logs after the first delivery
37601 attempt.
37602 .next
37603 .cindex "log" "return path"
37604 &%return_path_on_delivery%&: The return path that is being transmitted with
37605 the message is included in delivery and bounce lines, using the tag P=.
37606 This is omitted if no delivery actually happens, for example, if routing fails,
37607 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37608 .next
37609 .cindex "log" "sender on delivery"
37610 &%sender_on_delivery%&: The message's sender address is added to every delivery
37611 and bounce line, tagged by F= (for &"from"&).
37612 This is the original sender that was received with the message; it is not
37613 necessarily the same as the outgoing return path.
37614 .next
37615 .cindex "log" "sender verify failure"
37616 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37617 gives details of a sender verification failure is not written. Log lines for
37618 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37619 detail is lost.
37620 .next
37621 .cindex "log" "size rejection"
37622 &%size_reject%&: A log line is written whenever a message is rejected because
37623 it is too big.
37624 .next
37625 .cindex "log" "frozen messages; skipped"
37626 .cindex "frozen messages" "logging skipping"
37627 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37628 queue run because it is frozen or because another process is already delivering
37629 it.
37630 .cindex "&""spool file is locked""&"
37631 The message that is written is &"spool file is locked"&.
37632 .next
37633 .cindex "log" "smtp confirmation"
37634 .cindex "SMTP" "logging confirmation"
37635 .cindex "LMTP" "logging confirmation"
37636 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37637 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37638 A number of MTAs (including Exim) return an identifying string in this
37639 response.
37640 .next
37641 .cindex "log" "SMTP connections"
37642 .cindex "SMTP" "logging connections"
37643 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37644 established or closed, unless the connection is from a host that matches
37645 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37646 only when the closure is unexpected.) This applies to connections from local
37647 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37648 dropped in the middle of a message, a log line is always written, whether or
37649 not this selector is set, but otherwise nothing is written at the start and end
37650 of connections unless this selector is enabled.
37651
37652 For TCP/IP connections to an Exim daemon, the current number of connections is
37653 included in the log message for each new connection, but note that the count is
37654 reset if the daemon is restarted.
37655 Also, because connections are closed (and the closure is logged) in
37656 subprocesses, the count may not include connections that have been closed but
37657 whose termination the daemon has not yet noticed. Thus, while it is possible to
37658 match up the opening and closing of connections in the log, the value of the
37659 logged counts may not be entirely accurate.
37660 .next
37661 .cindex "log" "SMTP transaction; incomplete"
37662 .cindex "SMTP" "logging incomplete transactions"
37663 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37664 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37665 and the message sender plus any accepted recipients are included in the log
37666 line. This can provide evidence of dictionary attacks.
37667 .next
37668 .cindex "log" "non-MAIL SMTP sessions"
37669 .cindex "MAIL" "logging session without"
37670 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37671 connection terminates without having issued a MAIL command. This includes both
37672 the case when the connection is dropped, and the case when QUIT is used. It
37673 does not include cases where the connection is rejected right at the start (by
37674 an ACL, or because there are too many connections, or whatever). These cases
37675 already have their own log lines.
37676
37677 The log line that is written contains the identity of the client in the usual
37678 way, followed by D= and a time, which records the duration of the connection.
37679 If the connection was authenticated, this fact is logged exactly as it is for
37680 an incoming message, with an A= item. If the connection was encrypted, CV=,
37681 DN=, and X= items may appear as they do for an incoming message, controlled by
37682 the same logging options.
37683
37684 Finally, if any SMTP commands were issued during the connection, a C= item
37685 is added to the line, listing the commands that were used. For example,
37686 .code
37687 C=EHLO,QUIT
37688 .endd
37689 shows that the client issued QUIT straight after EHLO. If there were fewer
37690 than 20 commands, they are all listed. If there were more than 20 commands,
37691 the last 20 are listed, preceded by &"..."&. However, with the default
37692 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37693 have been aborted before 20 non-mail commands are processed.
37694 .next
37695 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37696 colon-separated, is appended to the A= item for a message arrival or delivery
37697 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37698 was accepted or used.
37699 .next
37700 .cindex "log" "SMTP protocol error"
37701 .cindex "SMTP" "logging protocol error"
37702 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37703 encountered. Exim does not have perfect detection of all protocol errors
37704 because of transmission delays and the use of pipelining. If PIPELINING has
37705 been advertised to a client, an Exim server assumes that the client will use
37706 it, and therefore it does not count &"expected"& errors (for example, RCPT
37707 received after rejecting MAIL) as protocol errors.
37708 .next
37709 .cindex "SMTP" "logging syntax errors"
37710 .cindex "SMTP" "syntax errors; logging"
37711 .cindex "SMTP" "unknown command; logging"
37712 .cindex "log" "unknown SMTP command"
37713 .cindex "log" "SMTP syntax error"
37714 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37715 encountered. An unrecognized command is treated as a syntax error. For an
37716 external connection, the host identity is given; for an internal connection
37717 using &%-bs%& the sender identification (normally the calling user) is given.
37718 .next
37719 .cindex "log" "subject"
37720 .cindex "subject, logging"
37721 &%subject%&: The subject of the message is added to the arrival log line,
37722 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37723 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37724 specifies whether characters with values greater than 127 should be logged
37725 unchanged, or whether they should be rendered as escape sequences.
37726 .next
37727 .cindex "log" "certificate verification"
37728 .cindex log DANE
37729 .cindex DANE logging
37730 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37731 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37732 verified
37733 using a CA trust anchor,
37734 &`CA=dane`& if using a DNS trust anchor,
37735 and &`CV=no`& if not.
37736 .next
37737 .cindex "log" "TLS cipher"
37738 .cindex "TLS" "logging cipher"
37739 &%tls_cipher%&: When a message is sent or received over an encrypted
37740 connection, the cipher suite used is added to the log line, preceded by X=.
37741 .next
37742 .cindex "log" "TLS peer DN"
37743 .cindex "TLS" "logging peer DN"
37744 &%tls_peerdn%&: When a message is sent or received over an encrypted
37745 connection, and a certificate is supplied by the remote host, the peer DN is
37746 added to the log line, preceded by DN=.
37747 .next
37748 .cindex "log" "TLS SNI"
37749 .cindex "TLS" "logging SNI"
37750 &%tls_sni%&: When a message is received over an encrypted connection, and
37751 the remote host provided the Server Name Indication extension, the SNI is
37752 added to the log line, preceded by SNI=.
37753 .next
37754 .cindex "log" "DNS failure in list"
37755 &%unknown_in_list%&: This setting causes a log entry to be written when the
37756 result of a list match is failure because a DNS lookup failed.
37757 .endlist
37758
37759
37760 .section "Message log" "SECID260"
37761 .cindex "message" "log file for"
37762 .cindex "log" "message log; description of"
37763 .cindex "&_msglog_& directory"
37764 .oindex "&%preserve_message_logs%&"
37765 In addition to the general log files, Exim writes a log file for each message
37766 that it handles. The names of these per-message logs are the message ids, and
37767 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37768 message log contains copies of the log lines that apply to the message. This
37769 makes it easier to inspect the status of an individual message without having
37770 to search the main log. A message log is deleted when processing of the message
37771 is complete, unless &%preserve_message_logs%& is set, but this should be used
37772 only with great care because they can fill up your disk very quickly.
37773
37774 On a heavily loaded system, it may be desirable to disable the use of
37775 per-message logs, in order to reduce disk I/O. This can be done by setting the
37776 &%message_logs%& option false.
37777 .ecindex IIDloggen
37778
37779
37780
37781
37782 . ////////////////////////////////////////////////////////////////////////////
37783 . ////////////////////////////////////////////////////////////////////////////
37784
37785 .chapter "Exim utilities" "CHAPutils"
37786 .scindex IIDutils "utilities"
37787 A number of utility scripts and programs are supplied with Exim and are
37788 described in this chapter. There is also the Exim Monitor, which is covered in
37789 the next chapter. The utilities described here are:
37790
37791 .itable none 0 0 3  7* left  15* left  40* left
37792 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37793   "list what Exim processes are doing"
37794 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37795 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37796 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37797 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37798                                                 various criteria"
37799 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37800 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37801   "extract statistics from the log"
37802 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37803   "check address acceptance from given IP"
37804 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37805 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37806 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37807 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37808 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37809 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37810 .endtable
37811
37812 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37813 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37814 &url(https://duncanthrax.net/exilog/) for details.
37815
37816
37817
37818
37819 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37820 .cindex "&'exiwhat'&"
37821 .cindex "process, querying"
37822 .cindex "SIGUSR1"
37823 On operating systems that can restart a system call after receiving a signal
37824 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37825 a line describing what it is doing to the file &_exim-process.info_& in the
37826 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37827 processes it can find, having first emptied the file. It then waits for one
37828 second to allow the Exim processes to react before displaying the results. In
37829 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37830 send the signal to the Exim processes, so it is normally run as root.
37831
37832 &*Warning*&: This is not an efficient process. It is intended for occasional
37833 use by system administrators. It is not sensible, for example, to set up a
37834 script that sends SIGUSR1 signals to Exim processes at short intervals.
37835
37836
37837 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37838 varies in different operating systems. Not only are different options used,
37839 but the format of the output is different. For this reason, there are some
37840 system configuration options that configure exactly how &'exiwhat'& works. If
37841 it doesn't seem to be working for you, check the following compile-time
37842 options:
37843 .display
37844 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37845 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37846 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37847 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37848 .endd
37849 An example of typical output from &'exiwhat'& is
37850 .code
37851 164 daemon: -q1h, listening on port 25
37852 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37853 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37854   [10.19.42.42] (editor@ref.example)
37855 10592 handling incoming call from [192.168.243.242]
37856 10628 accepting a local non-SMTP message
37857 .endd
37858 The first number in the output line is the process number. The third line has
37859 been split here, in order to fit it on the page.
37860
37861
37862
37863 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37864 .cindex "&'exiqgrep'&"
37865 .cindex "queue" "grepping"
37866 This utility is a Perl script contributed by Matt Hubbard. It runs
37867 .code
37868 exim -bpu
37869 .endd
37870 or (in case &*-a*& switch is specified)
37871 .code
37872 exim -bp
37873 .endd
37874 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37875 contain alternate exim configuration the queue management might be using.
37876
37877 to obtain a queue listing, and then greps the output to select messages
37878 that match given criteria. The following selection options are available:
37879
37880 .vlist
37881 .vitem &*-f*&&~<&'regex'&>
37882 Match the sender address using a case-insensitive search. The field that is
37883 tested is enclosed in angle brackets, so you can test for bounce messages with
37884 .code
37885 exiqgrep -f '^<>$'
37886 .endd
37887 .vitem &*-r*&&~<&'regex'&>
37888 Match a recipient address using a case-insensitive search. The field that is
37889 tested is not enclosed in angle brackets.
37890
37891 .vitem &*-s*&&~<&'regex'&>
37892 Match against the size field.
37893
37894 .vitem &*-y*&&~<&'seconds'&>
37895 Match messages that are younger than the given time.
37896
37897 .vitem &*-o*&&~<&'seconds'&>
37898 Match messages that are older than the given time.
37899
37900 .vitem &*-z*&
37901 Match only frozen messages.
37902
37903 .vitem &*-x*&
37904 Match only non-frozen messages.
37905
37906 .new
37907 .vitem &*-G*&&~<&'queuename'&>
37908 Match only messages in the given queue.  Without this, the default queue is searched.
37909 .wen
37910 .endlist
37911
37912 The following options control the format of the output:
37913
37914 .vlist
37915 .vitem &*-c*&
37916 Display only the count of matching messages.
37917
37918 .vitem &*-l*&
37919 Long format &-- display the full message information as output by Exim. This is
37920 the default.
37921
37922 .vitem &*-i*&
37923 Display message ids only.
37924
37925 .vitem &*-b*&
37926 Brief format &-- one line per message.
37927
37928 .vitem &*-R*&
37929 Display messages in reverse order.
37930
37931 .vitem &*-a*&
37932 Include delivered recipients in queue listing.
37933 .endlist
37934
37935 There is one more option, &%-h%&, which outputs a list of options.
37936
37937
37938
37939 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37940 .cindex "&'exiqsumm'&"
37941 .cindex "queue" "summary"
37942 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37943 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
37944 running a command such as
37945 .code
37946 exim -bp | exiqsumm
37947 .endd
37948 The output consists of one line for each domain that has messages waiting for
37949 it, as in the following example:
37950 .code
37951 3   2322   74m   66m  msn.com.example
37952 .endd
37953 Each line lists the number of pending deliveries for a domain, their total
37954 volume, and the length of time that the oldest and the newest messages have
37955 been waiting. Note that the number of pending deliveries is greater than the
37956 number of messages when messages have more than one recipient.
37957
37958 A summary line is output at the end. By default the output is sorted on the
37959 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37960 the output to be sorted by oldest message and by count of messages,
37961 respectively. There are also three options that split the messages for each
37962 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37963 separates frozen messages, and &%-s%& separates messages according to their
37964 sender.
37965
37966 The output of &'exim -bp'& contains the original addresses in the message, so
37967 this also applies to the output from &'exiqsumm'&. No domains from addresses
37968 generated by aliasing or forwarding are included (unless the &%one_time%&
37969 option of the &(redirect)& router has been used to convert them into &"top
37970 level"& addresses).
37971
37972
37973
37974
37975 .section "Extracting specific information from the log (exigrep)" &&&
37976          "SECTextspeinf"
37977 .cindex "&'exigrep'&"
37978 .cindex "log" "extracts; grepping for"
37979 The &'exigrep'& utility is a Perl script that searches one or more main log
37980 files for entries that match a given pattern. When it finds a match, it
37981 extracts all the log entries for the relevant message, not just those that
37982 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37983 given message, or all mail for a given user, or for a given host, for example.
37984 The input files can be in Exim log format or syslog format.
37985 If a matching log line is not associated with a specific message, it is
37986 included in &'exigrep'&'s output without any additional lines. The usage is:
37987 .display
37988 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37989 .endd
37990 If no log filenames are given on the command line, the standard input is read.
37991
37992 The &%-t%& argument specifies a number of seconds. It adds an additional
37993 condition for message selection. Messages that are complete are shown only if
37994 they spent more than <&'n'&> seconds in the queue.
37995
37996 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37997 makes it case-sensitive. This may give a performance improvement when searching
37998 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37999 option; with &%-I%& they do not. In both cases it is possible to change the
38000 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38001
38002 The &%-l%& option means &"literal"&, that is, treat all characters in the
38003 pattern as standing for themselves. Otherwise the pattern must be a Perl
38004 regular expression.
38005
38006 The &%-v%& option inverts the matching condition. That is, a line is selected
38007 if it does &'not'& match the pattern.
38008
38009 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38010 that are generated as a result/response to a message that &'exigrep'& matched
38011 normally.
38012
38013 Example of &%-M%&:
38014 user_a sends a message to user_b, which generates a bounce back to user_b. If
38015 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38016 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38017 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38018 when searching for &"user_a"& will show both messages since the bounce is
38019 &"related"& to or a &"result"& of the first message that was found by the
38020 search term.
38021
38022 If the location of a &'zcat'& command is known from the definition of
38023 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38024 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38025 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38026 autodetection of some well known compression extensions.
38027
38028
38029 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38030 .cindex "&'exipick'&"
38031 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38032 lists messages from the queue according to a variety of criteria. For details
38033 of &'exipick'&'s facilities, run &'exipick'& with
38034 the &%--help%& option.
38035
38036
38037 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38038 .cindex "log" "cycling local files"
38039 .cindex "cycling logs"
38040 .cindex "&'exicyclog'&"
38041 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38042 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38043 you are using log files with datestamps in their names (see section
38044 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38045 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38046 There are two command line options for &'exicyclog'&:
38047 .ilist
38048 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38049 default that is set when Exim is built. The default default is 10.
38050 .next
38051 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38052 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38053 overriding the script's default, which is to find the setting from Exim's
38054 configuration.
38055 .endlist
38056
38057 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38058 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38059 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38060 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38061 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38062 logs are handled similarly.
38063
38064 If the limit is greater than 99, the script uses 3-digit numbers such as
38065 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38066 to one that is greater, or &'vice versa'&, you will have to fix the names of
38067 any existing log files.
38068
38069 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38070 the end are deleted. All files with numbers greater than 01 are compressed,
38071 using a compression command which is configured by the COMPRESS_COMMAND
38072 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38073 root &%crontab%& entry of the form
38074 .code
38075 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38076 .endd
38077 assuming you have used the name &"exim"& for the Exim user. You can run
38078 &'exicyclog'& as root if you wish, but there is no need.
38079
38080
38081
38082 .section "Mail statistics (eximstats)" "SECTmailstat"
38083 .cindex "statistics"
38084 .cindex "&'eximstats'&"
38085 A Perl script called &'eximstats'& is provided for extracting statistical
38086 information from log files. The output is either plain text, or HTML.
38087 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38088 . --- 404 error and everything else points to that.
38089
38090 The &'eximstats'& script has been hacked about quite a bit over time. The
38091 latest version is the result of some extensive revision by Steve Campbell. A
38092 lot of information is given by default, but there are options for suppressing
38093 various parts of it. Following any options, the arguments to the script are a
38094 list of files, which should be main log files. For example:
38095 .code
38096 eximstats -nr /var/spool/exim/log/mainlog.01
38097 .endd
38098 By default, &'eximstats'& extracts information about the number and volume of
38099 messages received from or delivered to various hosts. The information is sorted
38100 both by message count and by volume, and the top fifty hosts in each category
38101 are listed on the standard output. Similar information, based on email
38102 addresses or domains instead of hosts can be requested by means of various
38103 options. For messages delivered and received locally, similar statistics are
38104 also produced per user.
38105
38106 The output also includes total counts and statistics about delivery errors, and
38107 histograms showing the number of messages received and deliveries made in each
38108 hour of the day. A delivery with more than one address in its envelope (for
38109 example, an SMTP transaction with more than one RCPT command) is counted
38110 as a single delivery by &'eximstats'&.
38111
38112 Though normally more deliveries than receipts are reported (as messages may
38113 have multiple recipients), it is possible for &'eximstats'& to report more
38114 messages received than delivered, even though the queue is empty at the start
38115 and end of the period in question. If an incoming message contains no valid
38116 recipients, no deliveries are recorded for it. A bounce message is handled as
38117 an entirely separate message.
38118
38119 &'eximstats'& always outputs a grand total summary giving the volume and number
38120 of messages received and deliveries made, and the number of hosts involved in
38121 each case. It also outputs the number of messages that were delayed (that is,
38122 not completely delivered at the first attempt), and the number that had at
38123 least one address that failed.
38124
38125 The remainder of the output is in sections that can be independently disabled
38126 or modified by various options. It consists of a summary of deliveries by
38127 transport, histograms of messages received and delivered per time interval
38128 (default per hour), information about the time messages spent in the queue,
38129 a list of relayed messages, lists of the top fifty sending hosts, local
38130 senders, destination hosts, and destination local users by count and by volume,
38131 and a list of delivery errors that occurred.
38132
38133 The relay information lists messages that were actually relayed, that is, they
38134 came from a remote host and were directly delivered to some other remote host,
38135 without being processed (for example, for aliasing or forwarding) locally.
38136
38137 There are quite a few options for &'eximstats'& to control exactly what it
38138 outputs. These are documented in the Perl script itself, and can be extracted
38139 by running the command &(perldoc)& on the script. For example:
38140 .code
38141 perldoc /usr/exim/bin/eximstats
38142 .endd
38143
38144 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38145 .cindex "&'exim_checkaccess'&"
38146 .cindex "policy control" "checking access"
38147 .cindex "checking access"
38148 The &%-bh%& command line argument allows you to run a fake SMTP session with
38149 debugging output, in order to check what Exim is doing when it is applying
38150 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38151 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38152 sometimes you just want to answer the question &"Does this address have
38153 access?"& without bothering with any further details.
38154
38155 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38156 two arguments, an IP address and an email address:
38157 .code
38158 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38159 .endd
38160 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38161 given email address would be accepted in a RCPT command in a TCP/IP
38162 connection from the host with the given IP address. The output of the utility
38163 is either the word &"accepted"&, or the SMTP error response, for example:
38164 .code
38165 Rejected:
38166 550 Relay not permitted
38167 .endd
38168 When running this test, the utility uses &`<>`& as the envelope sender address
38169 for the MAIL command, but you can change this by providing additional
38170 options. These are passed directly to the Exim command. For example, to specify
38171 that the test is to be run with the sender address &'himself@there.example'&
38172 you can use:
38173 .code
38174 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38175                  -f himself@there.example
38176 .endd
38177 Note that these additional Exim command line items must be given after the two
38178 mandatory arguments.
38179
38180 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38181 while running its checks. You can run checks that include callouts by using
38182 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38183
38184
38185
38186 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38187 .cindex "DBM" "building dbm files"
38188 .cindex "building DBM files"
38189 .cindex "&'exim_dbmbuild'&"
38190 .cindex "lower casing"
38191 .cindex "binary zero" "in lookup key"
38192 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38193 the format used by the &(lsearch)& lookup (see section
38194 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38195 names as keys and the remainder of the information as data. The lower-casing
38196 can be prevented by calling the program with the &%-nolc%& option.
38197
38198 A terminating zero is included as part of the key string. This is expected by
38199 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38200 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38201 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38202 files.
38203
38204 The program requires two arguments: the name of the input file (which can be a
38205 single hyphen to indicate the standard input), and the name of the output file.
38206 It creates the output under a temporary name, and then renames it if all went
38207 well.
38208
38209 .cindex "USE_DB"
38210 If the native DB interface is in use (USE_DB is set in a compile-time
38211 configuration file &-- this is common in free versions of Unix) the two
38212 filenames must be different, because in this mode the Berkeley DB functions
38213 create a single output file using exactly the name given. For example,
38214 .code
38215 exim_dbmbuild /etc/aliases /etc/aliases.db
38216 .endd
38217 reads the system alias file and creates a DBM version of it in
38218 &_/etc/aliases.db_&.
38219
38220 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38221 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38222 environment, the suffixes are added to the second argument of
38223 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38224 when the Berkeley functions are used in compatibility mode (though this is not
38225 recommended), because in that case it adds a &_.db_& suffix to the filename.
38226
38227 If a duplicate key is encountered, the program outputs a warning, and when it
38228 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38229 option is used. By default, only the first of a set of duplicates is used &--
38230 this makes it compatible with &(lsearch)& lookups. There is an option
38231 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38232 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38233 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38234 return code is 2.
38235
38236
38237
38238
38239 .section "Finding individual retry times (exinext)" "SECTfinindret"
38240 .cindex "retry" "times"
38241 .cindex "&'exinext'&"
38242 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38243 fish specific information out of the retry database. Given a mail domain (or a
38244 complete address), it looks up the hosts for that domain, and outputs any retry
38245 information for the hosts or for the domain. At present, the retry information
38246 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38247 output. For example:
38248 .code
38249 $ exinext piglet@milne.fict.example
38250 kanga.milne.example:192.168.8.1 error 146: Connection refused
38251   first failed: 21-Feb-1996 14:57:34
38252   last tried:   21-Feb-1996 14:57:34
38253   next try at:  21-Feb-1996 15:02:34
38254 roo.milne.example:192.168.8.3 error 146: Connection refused
38255   first failed: 20-Jan-1996 13:12:08
38256   last tried:   21-Feb-1996 11:42:03
38257   next try at:  21-Feb-1996 19:42:03
38258   past final cutoff time
38259 .endd
38260 You can also give &'exinext'& a local part, without a domain, and it
38261 will give any retry information for that local part in your default domain.
38262 A message id can be used to obtain retry information pertaining to a specific
38263 message. This exists only when an attempt to deliver a message to a remote host
38264 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38265 &'exinext'& is not particularly efficient, but then it is not expected to be
38266 run very often.
38267
38268 The &'exinext'& utility calls Exim to find out information such as the location
38269 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38270 passed on to the &'exim'& commands. The first specifies an alternate Exim
38271 configuration file, and the second sets macros for use within the configuration
38272 file. These features are mainly to help in testing, but might also be useful in
38273 environments where more than one configuration file is in use.
38274
38275
38276
38277 .section "Hints database maintenance" "SECThindatmai"
38278 .cindex "hints database" "maintenance"
38279 .cindex "maintaining Exim's hints database"
38280 Three utility programs are provided for maintaining the DBM files that Exim
38281 uses to contain its delivery hint information. Each program requires two
38282 arguments. The first specifies the name of Exim's spool directory, and the
38283 second is the name of the database it is to operate on. These are as follows:
38284
38285 .ilist
38286 &'retry'&: the database of retry information
38287 .next
38288 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38289 for remote hosts
38290 .next
38291 &'callout'&: the callout cache
38292 .next
38293 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38294 .next
38295 &'misc'&: other hints data
38296 .endlist
38297
38298 The &'misc'& database is used for
38299
38300 .ilist
38301 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38302 .next
38303 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38304 &(smtp)& transport)
38305 .next
38306 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38307 in a transport)
38308 .endlist
38309
38310
38311
38312 .section "exim_dumpdb" "SECID261"
38313 .cindex "&'exim_dumpdb'&"
38314 The entire contents of a database are written to the standard output by the
38315 &'exim_dumpdb'& program, which has no options or arguments other than the
38316 spool and database names. For example, to dump the retry database:
38317 .code
38318 exim_dumpdb /var/spool/exim retry
38319 .endd
38320 Two lines of output are produced for each entry:
38321 .code
38322 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38323 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38324 .endd
38325 The first item on the first line is the key of the record. It starts with one
38326 of the letters R, or T, depending on whether it refers to a routing or
38327 transport retry. For a local delivery, the next part is the local address; for
38328 a remote delivery it is the name of the remote host, followed by its failing IP
38329 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38330 transport). If the remote port is not the standard one (port 25), it is added
38331 to the IP address. Then there follows an error code, an additional error code,
38332 and a textual description of the error.
38333
38334 The three times on the second line are the time of first failure, the time of
38335 the last delivery attempt, and the computed time for the next attempt. The line
38336 ends with an asterisk if the cutoff time for the last retry rule has been
38337 exceeded.
38338
38339 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38340 consists of a host name followed by a list of ids for messages that are or were
38341 waiting to be delivered to that host. If there are a very large number for any
38342 one host, continuation records, with a sequence number added to the host name,
38343 may be seen. The data in these records is often out of date, because a message
38344 may be routed to several alternative hosts, and Exim makes no effort to keep
38345 cross-references.
38346
38347
38348
38349 .section "exim_tidydb" "SECID262"
38350 .cindex "&'exim_tidydb'&"
38351 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38352 database. If run with no options, it removes all records that are more than 30
38353 days old. The age is calculated from the date and time that the record was last
38354 updated. Note that, in the case of the retry database, it is &'not'& the time
38355 since the first delivery failure. Information about a host that has been down
38356 for more than 30 days will remain in the database, provided that the record is
38357 updated sufficiently often.
38358
38359 The cutoff date can be altered by means of the &%-t%& option, which must be
38360 followed by a time. For example, to remove all records older than a week from
38361 the retry database:
38362 .code
38363 exim_tidydb -t 7d /var/spool/exim retry
38364 .endd
38365 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38366 message ids. In the former these appear as data in records keyed by host &--
38367 they were messages that were waiting for that host &-- and in the latter they
38368 are the keys for retry information for messages that have suffered certain
38369 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38370 message ids in database records are those of messages that are still on the
38371 queue. Message ids for messages that no longer exist are removed from
38372 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38373 For the &'retry'& database, records whose keys are non-existent message ids are
38374 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38375 whenever it removes information from the database.
38376
38377 Certain records are automatically removed by Exim when they are no longer
38378 needed, but others are not. For example, if all the MX hosts for a domain are
38379 down, a retry record is created for each one. If the primary MX host comes back
38380 first, its record is removed when Exim successfully delivers to it, but the
38381 records for the others remain because Exim has not tried to use those hosts.
38382
38383 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38384 hints databases. You should do this at a quiet time of day, because it requires
38385 a database to be locked (and therefore inaccessible to Exim) while it does its
38386 work. Removing records from a DBM file does not normally make the file smaller,
38387 but all the common DBM libraries are able to re-use the space that is released.
38388 After an initial phase of increasing in size, the databases normally reach a
38389 point at which they no longer get any bigger, as long as they are regularly
38390 tidied.
38391
38392 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38393 databases is likely to keep on increasing.
38394
38395
38396
38397
38398 .section "exim_fixdb" "SECID263"
38399 .cindex "&'exim_fixdb'&"
38400 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38401 Its main use is for testing Exim, but it might also be occasionally useful for
38402 getting round problems in a live system. It has no options, and its interface
38403 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38404 key of a database record can then be entered, and the data for that record is
38405 displayed.
38406
38407 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38408 except the &'retry'& database, that is the only operation that can be carried
38409 out. For the &'retry'& database, each field is output preceded by a number, and
38410 data for individual fields can be changed by typing the field number followed
38411 by new data, for example:
38412 .code
38413 > 4 951102:1000
38414 .endd
38415 resets the time of the next delivery attempt. Time values are given as a
38416 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38417 used as optional separators.
38418
38419
38420
38421
38422 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38423 .cindex "mailbox" "maintenance"
38424 .cindex "&'exim_lock'&"
38425 .cindex "locking mailboxes"
38426 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38427 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38428 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38429 a user agent while investigating a problem. The utility requires the name of
38430 the file as its first argument. If the locking is successful, the second
38431 argument is run as a command (using C's &[system()]& function); if there is no
38432 second argument, the value of the SHELL environment variable is used; if this
38433 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38434 is unlocked and the utility ends. The following options are available:
38435
38436 .vlist
38437 .vitem &%-fcntl%&
38438 Use &[fcntl()]& locking on the open mailbox.
38439
38440 .vitem &%-flock%&
38441 Use &[flock()]& locking on the open mailbox, provided the operating system
38442 supports it.
38443
38444 .vitem &%-interval%&
38445 This must be followed by a number, which is a number of seconds; it sets the
38446 interval to sleep between retries (default 3).
38447
38448 .vitem &%-lockfile%&
38449 Create a lock file before opening the mailbox.
38450
38451 .vitem &%-mbx%&
38452 Lock the mailbox using MBX rules.
38453
38454 .vitem &%-q%&
38455 Suppress verification output.
38456
38457 .vitem &%-retries%&
38458 This must be followed by a number; it sets the number of times to try to get
38459 the lock (default 10).
38460
38461 .vitem &%-restore_time%&
38462 This option causes &%exim_lock%& to restore the modified and read times to the
38463 locked file before exiting. This allows you to access a locked mailbox (for
38464 example, to take a backup copy) without disturbing the times that the user
38465 subsequently sees.
38466
38467 .vitem &%-timeout%&
38468 This must be followed by a number, which is a number of seconds; it sets a
38469 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38470 default), a non-blocking call is used.
38471
38472 .vitem &%-v%&
38473 Generate verbose output.
38474 .endlist
38475
38476 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38477 default is to create a lock file and also to use &[fcntl()]& locking on the
38478 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38479 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38480 requires that the directory containing the file be writeable. Locking by lock
38481 file does not last forever; Exim assumes that a lock file is expired if it is
38482 more than 30 minutes old.
38483
38484 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38485 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38486 to be taken out on the open mailbox, and an exclusive lock on the file
38487 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38488 number of the mailbox file. When the locking is released, if an exclusive lock
38489 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38490
38491 The default output contains verification of the locking that takes place. The
38492 &%-v%& option causes some additional information to be given. The &%-q%& option
38493 suppresses all output except error messages.
38494
38495 A command such as
38496 .code
38497 exim_lock /var/spool/mail/spqr
38498 .endd
38499 runs an interactive shell while the file is locked, whereas
38500 .display
38501 &`exim_lock -q /var/spool/mail/spqr <<End`&
38502 <&'some commands'&>
38503 &`End`&
38504 .endd
38505 runs a specific non-interactive sequence of commands while the file is locked,
38506 suppressing all verification output. A single command can be run by a command
38507 such as
38508 .code
38509 exim_lock -q /var/spool/mail/spqr \
38510   "cp /var/spool/mail/spqr /some/where"
38511 .endd
38512 Note that if a command is supplied, it must be entirely contained within the
38513 second argument &-- hence the quotes.
38514 .ecindex IIDutils
38515
38516
38517 . ////////////////////////////////////////////////////////////////////////////
38518 . ////////////////////////////////////////////////////////////////////////////
38519
38520 .chapter "The Exim monitor" "CHAPeximon"
38521 .scindex IIDeximon "Exim monitor" "description"
38522 .cindex "X-windows"
38523 .cindex "&'eximon'&"
38524 .cindex "Local/eximon.conf"
38525 .cindex "&_exim_monitor/EDITME_&"
38526 The Exim monitor is an application which displays in an X window information
38527 about the state of Exim's queue and what Exim is doing. An admin user can
38528 perform certain operations on messages from this GUI interface; however all
38529 such facilities are also available from the command line, and indeed, the
38530 monitor itself makes use of the command line to perform any actions requested.
38531
38532
38533
38534 .section "Running the monitor" "SECID264"
38535 The monitor is started by running the script called &'eximon'&. This is a shell
38536 script that sets up a number of environment variables, and then runs the
38537 binary called &_eximon.bin_&. The default appearance of the monitor window can
38538 be changed by editing the &_Local/eximon.conf_& file created by editing
38539 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38540 parameters are for.
38541
38542 The parameters that get built into the &'eximon'& script can be overridden for
38543 a particular invocation by setting up environment variables of the same names,
38544 preceded by &`EXIMON_`&. For example, a shell command such as
38545 .code
38546 EXIMON_LOG_DEPTH=400 eximon
38547 .endd
38548 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38549 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38550 overrides the Exim log file configuration. This makes it possible to have
38551 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38552 syslog messages are routed to a file on the local host.
38553
38554 X resources can be used to change the appearance of the window in the normal
38555 way. For example, a resource setting of the form
38556 .code
38557 Eximon*background: gray94
38558 .endd
38559 changes the colour of the background to light grey rather than white. The
38560 stripcharts are drawn with both the data lines and the reference lines in
38561 black. This means that the reference lines are not visible when on top of the
38562 data. However, their colour can be changed by setting a resource called
38563 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38564 For example, if your X server is running Unix, you could set up lighter
38565 reference lines in the stripcharts by obeying
38566 .code
38567 xrdb -merge <<End
38568 Eximon*highlight: gray
38569 End
38570 .endd
38571 .cindex "admin user"
38572 In order to see the contents of messages in the queue, and to operate on them,
38573 &'eximon'& must either be run as root or by an admin user.
38574
38575 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38576 contain X11 resource parameters interpreted by the X11 library.  In addition,
38577 if the first parameter starts with the string "gdb" then it is removed and the
38578 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38579 versioned variants of gdb can be invoked).
38580
38581 The monitor's window is divided into three parts. The first contains one or
38582 more stripcharts and two action buttons, the second contains a &"tail"& of the
38583 main log file, and the third is a display of the queue of messages awaiting
38584 delivery, with two more action buttons. The following sections describe these
38585 different parts of the display.
38586
38587
38588
38589
38590 .section "The stripcharts" "SECID265"
38591 .cindex "stripchart"
38592 The first stripchart is always a count of messages in the queue. Its name can
38593 be configured by setting QUEUE_STRIPCHART_NAME in the
38594 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38595 configuration script by regular expression matches on log file entries, making
38596 it possible to display, for example, counts of messages delivered to certain
38597 hosts or using certain transports. The supplied defaults display counts of
38598 received and delivered messages, and of local and SMTP deliveries. The default
38599 period between stripchart updates is one minute; this can be adjusted by a
38600 parameter in the &_Local/eximon.conf_& file.
38601
38602 The stripchart displays rescale themselves automatically as the value they are
38603 displaying changes. There are always 10 horizontal lines in each chart; the
38604 title string indicates the value of each division when it is greater than one.
38605 For example, &"x2"& means that each division represents a value of 2.
38606
38607 It is also possible to have a stripchart which shows the percentage fullness of
38608 a particular disk partition, which is useful when local deliveries are confined
38609 to a single partition.
38610
38611 .cindex "&%statvfs%& function"
38612 This relies on the availability of the &[statvfs()]& function or equivalent in
38613 the operating system. Most, but not all versions of Unix that support Exim have
38614 this. For this particular stripchart, the top of the chart always represents
38615 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38616 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38617 &_Local/eximon.conf_& file.
38618
38619
38620
38621
38622 .section "Main action buttons" "SECID266"
38623 .cindex "size" "of monitor window"
38624 .cindex "Exim monitor" "window size"
38625 .cindex "window size"
38626 Below the stripcharts there is an action button for quitting the monitor. Next
38627 to this is another button marked &"Size"&. They are placed here so that
38628 shrinking the window to its default minimum size leaves just the queue count
38629 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38630 the window to expand to its maximum size, unless it is already at the maximum,
38631 in which case it is reduced to its minimum.
38632
38633 When expanding to the maximum, if the window cannot be fully seen where it
38634 currently is, it is moved back to where it was the last time it was at full
38635 size. When it is expanding from its minimum size, the old position is
38636 remembered, and next time it is reduced to the minimum it is moved back there.
38637
38638 The idea is that you can keep a reduced window just showing one or two
38639 stripcharts at a convenient place on your screen, easily expand it to show
38640 the full window when required, and just as easily put it back to what it was.
38641 The idea is copied from what the &'twm'& window manager does for its
38642 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38643 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38644
38645 Normally, the monitor starts up with the window at its full size, but it can be
38646 built so that it starts up with the window at its smallest size, by setting
38647 START_SMALL=yes in &_Local/eximon.conf_&.
38648
38649
38650
38651 .section "The log display" "SECID267"
38652 .cindex "log" "tail of; in monitor"
38653 The second section of the window is an area in which a display of the tail of
38654 the main log is maintained.
38655 To save space on the screen, the timestamp on each log line is shortened by
38656 removing the date and, if &%log_timezone%& is set, the timezone.
38657 The log tail is not available when the only destination for logging data is
38658 syslog, unless the syslog lines are routed to a local file whose name is passed
38659 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38660
38661 The log sub-window has a scroll bar at its lefthand side which can be used to
38662 move back to look at earlier text, and the up and down arrow keys also have a
38663 scrolling effect. The amount of log that is kept depends on the setting of
38664 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38665 to use. When this is full, the earlier 50% of data is discarded &-- this is
38666 much more efficient than throwing it away line by line. The sub-window also has
38667 a horizontal scroll bar for accessing the ends of long log lines. This is the
38668 only means of horizontal scrolling; the right and left arrow keys are not
38669 available. Text can be cut from this part of the window using the mouse in the
38670 normal way. The size of this subwindow is controlled by parameters in the
38671 configuration file &_Local/eximon.conf_&.
38672
38673 Searches of the text in the log window can be carried out by means of the ^R
38674 and ^S keystrokes, which default to a reverse and a forward search,
38675 respectively. The search covers only the text that is displayed in the window.
38676 It cannot go further back up the log.
38677
38678 The point from which the search starts is indicated by a caret marker. This is
38679 normally at the end of the text in the window, but can be positioned explicitly
38680 by pointing and clicking with the left mouse button, and is moved automatically
38681 by a successful search. If new text arrives in the window when it is scrolled
38682 back, the caret remains where it is, but if the window is not scrolled back,
38683 the caret is moved to the end of the new text.
38684
38685 Pressing ^R or ^S pops up a window into which the search text can be typed.
38686 There are buttons for selecting forward or reverse searching, for carrying out
38687 the search, and for cancelling. If the &"Search"& button is pressed, the search
38688 happens and the window remains so that further searches can be done. If the
38689 &"Return"& key is pressed, a single search is done and the window is closed. If
38690 ^C is typed the search is cancelled.
38691
38692 The searching facility is implemented using the facilities of the Athena text
38693 widget. By default this pops up a window containing both &"search"& and
38694 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38695 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38696 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38697 provided version of &%TextPop%& when the remaining parts of the text widget
38698 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38699 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38700 on these systems, at the expense of having unwanted items in the search popup
38701 window.
38702
38703
38704
38705 .section "The queue display" "SECID268"
38706 .cindex "queue" "display in monitor"
38707 The bottom section of the monitor window contains a list of all messages that
38708 are in the queue, which includes those currently being received or delivered,
38709 as well as those awaiting delivery. The size of this subwindow is controlled by
38710 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38711 at which it is updated is controlled by another parameter in the same file &--
38712 the default is 5 minutes, since queue scans can be quite expensive. However,
38713 there is an &"Update"& action button just above the display which can be used
38714 to force an update of the queue display at any time.
38715
38716 When a host is down for some time, a lot of pending mail can build up for it,
38717 and this can make it hard to deal with other messages in the queue. To help
38718 with this situation there is a button next to &"Update"& called &"Hide"&. If
38719 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38720 type anything in here and press &"Return"&, the text is added to a chain of
38721 such texts, and if every undelivered address in a message matches at least one
38722 of the texts, the message is not displayed.
38723
38724 If there is an address that does not match any of the texts, all the addresses
38725 are displayed as normal. The matching happens on the ends of addresses so, for
38726 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38727 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38728 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38729 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38730 a hide request is automatically cancelled after one hour.
38731
38732 While the dialogue box is displayed, you can't press any buttons or do anything
38733 else to the monitor window. For this reason, if you want to cut text from the
38734 queue display to use in the dialogue box, you have to do the cutting before
38735 pressing the &"Hide"& button.
38736
38737 The queue display contains, for each unhidden queued message, the length of
38738 time it has been in the queue, the size of the message, the message id, the
38739 message sender, and the first undelivered recipient, all on one line. If it is
38740 a bounce message, the sender is shown as &"<>"&. If there is more than one
38741 recipient to which the message has not yet been delivered, subsequent ones are
38742 listed on additional lines, up to a maximum configured number, following which
38743 an ellipsis is displayed. Recipients that have already received the message are
38744 not shown.
38745
38746 .cindex "frozen messages" "display"
38747 If a message is frozen, an asterisk is displayed at the left-hand side.
38748
38749 The queue display has a vertical scroll bar, and can also be scrolled by means
38750 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38751 The text searching facilities, as described above for the log window, are also
38752 available, but the caret is always moved to the end of the text when the queue
38753 display is updated.
38754
38755
38756
38757 .section "The queue menu" "SECID269"
38758 .cindex "queue" "menu in monitor"
38759 If the &%shift%& key is held down and the left button is clicked when the mouse
38760 pointer is over the text for any message, an action menu pops up, and the first
38761 line of the queue display for the message is highlighted. This does not affect
38762 any selected text.
38763
38764 If you want to use some other event for popping up the menu, you can set the
38765 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38766 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38767 value set in this parameter is a standard X event description. For example, to
38768 run eximon using &%ctrl%& rather than &%shift%& you could use
38769 .code
38770 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38771 .endd
38772 The title of the menu is the message id, and it contains entries which act as
38773 follows:
38774
38775 .ilist
38776 &'message log'&: The contents of the message log for the message are displayed
38777 in a new text window.
38778 .next
38779 &'headers'&: Information from the spool file that contains the envelope
38780 information and headers is displayed in a new text window. See chapter
38781 &<<CHAPspool>>& for a description of the format of spool files.
38782 .next
38783 &'body'&: The contents of the spool file containing the body of the message are
38784 displayed in a new text window. There is a default limit of 20,000 bytes to the
38785 amount of data displayed. This can be changed by setting the BODY_MAX
38786 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38787 .next
38788 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38789 delivery of the message. This causes an automatic thaw if the message is
38790 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38791 a new text window. The delivery is run in a separate process, to avoid holding
38792 up the monitor while the delivery proceeds.
38793 .next
38794 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38795 that the message be frozen.
38796 .next
38797 .cindex "thawing messages"
38798 .cindex "unfreezing messages"
38799 .cindex "frozen messages" "thawing"
38800 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38801 that the message be thawed.
38802 .next
38803 .cindex "delivery" "forcing failure"
38804 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38805 that Exim gives up trying to deliver the message. A bounce message is generated
38806 for any remaining undelivered addresses.
38807 .next
38808 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38809 that the message be deleted from the system without generating a bounce
38810 message.
38811 .next
38812 &'add recipient'&: A dialog box is displayed into which a recipient address can
38813 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38814 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38815 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38816 causes a call to Exim to be made using the &%-Mar%& option to request that an
38817 additional recipient be added to the message, unless the entry box is empty, in
38818 which case no action is taken.
38819 .next
38820 &'mark delivered'&: A dialog box is displayed into which a recipient address
38821 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38822 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38823 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38824 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38825 recipient address as already delivered, unless the entry box is empty, in which
38826 case no action is taken.
38827 .next
38828 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38829 mark all recipient addresses as already delivered.
38830 .next
38831 &'edit sender'&: A dialog box is displayed initialized with the current
38832 sender's address. Pressing RETURN causes a call to Exim to be made using the
38833 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38834 in which case no action is taken. If you want to set an empty sender (as in
38835 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38836 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38837 the address is qualified with that domain.
38838 .endlist
38839
38840 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38841 other cases when a call to Exim is made, if there is any output from Exim (in
38842 particular, if the command fails) a window containing the command and the
38843 output is displayed. Otherwise, the results of the action are normally apparent
38844 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38845 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38846 if no output is generated.
38847
38848 The queue display is automatically updated for actions such as freezing and
38849 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38850 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38851 force an update of the display after one of these actions.
38852
38853 In any text window that is displayed as result of a menu action, the normal
38854 cut-and-paste facility is available, and searching can be carried out using ^R
38855 and ^S, as described above for the log tail window.
38856 .ecindex IIDeximon
38857
38858
38859
38860
38861
38862 . ////////////////////////////////////////////////////////////////////////////
38863 . ////////////////////////////////////////////////////////////////////////////
38864
38865 .chapter "Security considerations" "CHAPsecurity"
38866 .scindex IIDsecurcon "security" "discussion of"
38867 This chapter discusses a number of issues concerned with security, some of
38868 which are also covered in other parts of this manual.
38869
38870 For reasons that this author does not understand, some people have promoted
38871 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38872 existence of this chapter in the documentation. However, the intent of the
38873 chapter is simply to describe the way Exim works in relation to certain
38874 security concerns, not to make any specific claims about the effectiveness of
38875 its security as compared with other MTAs.
38876
38877 What follows is a description of the way Exim is supposed to be. Best efforts
38878 have been made to try to ensure that the code agrees with the theory, but an
38879 absence of bugs can never be guaranteed. Any that are reported will get fixed
38880 as soon as possible.
38881
38882
38883 .section "Building a more &""hardened""& Exim" "SECID286"
38884 .cindex "security" "build-time features"
38885 There are a number of build-time options that can be set in &_Local/Makefile_&
38886 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38887 Exim administrator who does not have the root password, or by someone who has
38888 penetrated the Exim (but not the root) account. These options are as follows:
38889
38890 .ilist
38891 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38892 start of any filenames used with the &%-C%& option. When it is set, these
38893 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38894 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38895 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38896 default setting for &%ALT_CONFIG_PREFIX%&.
38897
38898 If the permitted configuration files are confined to a directory to
38899 which only root has access, this guards against someone who has broken
38900 into the Exim account from running a privileged Exim with an arbitrary
38901 configuration file, and using it to break into other accounts.
38902 .next
38903
38904 If a non-trusted configuration file (i.e. not the default configuration file
38905 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38906 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38907 the next item), then root privilege is retained only if the caller of Exim is
38908 root. This locks out the possibility of testing a configuration using &%-C%&
38909 right through message reception and delivery, even if the caller is root. The
38910 reception works, but by that time, Exim is running as the Exim user, so when
38911 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38912 privilege to be lost. However, root can test reception and delivery using two
38913 separate commands.
38914
38915 .next
38916 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38917 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38918 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38919 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38920 the restrictive side.  Requiring build-time selection of safe macros is onerous
38921 but this option is intended solely as a transition mechanism to permit
38922 previously-working configurations to continue to work after release 4.73.
38923 .next
38924 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38925 is disabled.
38926 .next
38927 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38928 never to be used for any deliveries. This is like the &%never_users%& runtime
38929 option, but it cannot be overridden; the runtime option adds additional users
38930 to the list. The default setting is &"root"&; this prevents a non-root user who
38931 is permitted to modify the runtime file from using Exim as a way to get root.
38932 .endlist
38933
38934
38935
38936 .section "Root privilege" "SECID270"
38937 .cindex "setuid"
38938 .cindex "root privilege"
38939 The Exim binary is normally setuid to root, which means that it gains root
38940 privilege (runs as root) when it starts execution. In some special cases (for
38941 example, when the daemon is not in use and there are no local deliveries), it
38942 may be possible to run Exim setuid to some user other than root. This is
38943 discussed in the next section. However, in most installations, root privilege
38944 is required for two things:
38945
38946 .ilist
38947 To set up a socket connected to the standard SMTP port (25) when initialising
38948 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38949 not required.
38950 .next
38951 To be able to change uid and gid in order to read users' &_.forward_& files and
38952 perform local deliveries as the receiving user or as specified in the
38953 configuration.
38954 .endlist
38955
38956 It is not necessary to be root to do any of the other things Exim does, such as
38957 receiving messages and delivering them externally over SMTP, and it is
38958 obviously more secure if Exim does not run as root except when necessary.
38959 For this reason, a user and group for Exim to use must be defined in
38960 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38961 group"&. Their values can be changed by the runtime configuration, though this
38962 is not recommended. Often a user called &'exim'& is used, but some sites use
38963 &'mail'& or another user name altogether.
38964
38965 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38966 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38967 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38968
38969 After a new Exim process has interpreted its command line options, it changes
38970 uid and gid in the following cases:
38971
38972 .ilist
38973 .oindex "&%-C%&"
38974 .oindex "&%-D%&"
38975 If the &%-C%& option is used to specify an alternate configuration file, or if
38976 the &%-D%& option is used to define macro values for the configuration, and the
38977 calling process is not running as root, the uid and gid are changed to those of
38978 the calling process.
38979 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38980 option may not be used at all.
38981 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38982 can be supplied if the calling process is running as root, the Exim run-time
38983 user or CONFIGURE_OWNER, if defined.
38984 .next
38985 .oindex "&%-be%&"
38986 .oindex "&%-bf%&"
38987 .oindex "&%-bF%&"
38988 If the expansion test option (&%-be%&) or one of the filter testing options
38989 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38990 calling process.
38991 .next
38992 If the process is not a daemon process or a queue runner process or a delivery
38993 process or a process for testing address routing (started with &%-bt%&), the
38994 uid and gid are changed to the Exim user and group. This means that Exim always
38995 runs under its own uid and gid when receiving messages. This also applies when
38996 testing address verification
38997 .oindex "&%-bv%&"
38998 .oindex "&%-bh%&"
38999 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39000 option).
39001 .next
39002 For a daemon, queue runner, delivery, or address testing process, the uid
39003 remains as root at this stage, but the gid is changed to the Exim group.
39004 .endlist
39005
39006 The processes that initially retain root privilege behave as follows:
39007
39008 .ilist
39009 A daemon process changes the gid to the Exim group and the uid to the Exim
39010 user after setting up one or more listening sockets. The &[initgroups()]&
39011 function is called, so that if the Exim user is in any additional groups, they
39012 will be used during message reception.
39013 .next
39014 A queue runner process retains root privilege throughout its execution. Its
39015 job is to fork a controlled sequence of delivery processes.
39016 .next
39017 A delivery process retains root privilege throughout most of its execution,
39018 but any actual deliveries (that is, the transports themselves) are run in
39019 subprocesses which always change to a non-root uid and gid. For local
39020 deliveries this is typically the uid and gid of the owner of the mailbox; for
39021 remote deliveries, the Exim uid and gid are used. Once all the delivery
39022 subprocesses have been run, a delivery process changes to the Exim uid and gid
39023 while doing post-delivery tidying up such as updating the retry database and
39024 generating bounce and warning messages.
39025
39026 While the recipient addresses in a message are being routed, the delivery
39027 process runs as root. However, if a user's filter file has to be processed,
39028 this is done in a subprocess that runs under the individual user's uid and
39029 gid. A system filter is run as root unless &%system_filter_user%& is set.
39030 .next
39031 A process that is testing addresses (the &%-bt%& option) runs as root so that
39032 the routing is done in the same environment as a message delivery.
39033 .endlist
39034
39035
39036
39037
39038 .section "Running Exim without privilege" "SECTrunexiwitpri"
39039 .cindex "privilege, running without"
39040 .cindex "unprivileged running"
39041 .cindex "root privilege" "running without"
39042 Some installations like to run Exim in an unprivileged state for more of its
39043 operation, for added security. Support for this mode of operation is provided
39044 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39045 gid are changed to the Exim user and group at the start of a delivery process
39046 (and also queue runner and address testing processes). This means that address
39047 routing is no longer run as root, and the deliveries themselves cannot change
39048 to any other uid.
39049
39050 .cindex SIGHUP
39051 .cindex "daemon" "restarting"
39052 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39053 that the daemon can still be started in the usual way, and it can respond
39054 correctly to SIGHUP because the re-invocation regains root privilege.
39055
39056 An alternative approach is to make Exim setuid to the Exim user and also setgid
39057 to the Exim group. If you do this, the daemon must be started from a root
39058 process. (Calling Exim from a root process makes it behave in the way it does
39059 when it is setuid root.) However, the daemon cannot restart itself after a
39060 SIGHUP signal because it cannot regain privilege.
39061
39062 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39063 stops Exim from trying to re-invoke itself to do a delivery after a message has
39064 been received. Such a re-invocation is a waste of resources because it has no
39065 effect.
39066
39067 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39068 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39069 to the Exim user seems a clean approach, but there is one complication:
39070
39071 In this style of operation, Exim is running with the real uid and gid set to
39072 those of the calling process, and the effective uid/gid set to Exim's values.
39073 Ideally, any association with the calling process' uid/gid should be dropped,
39074 that is, the real uid/gid should be reset to the effective values so as to
39075 discard any privileges that the caller may have. While some operating systems
39076 have a function that permits this action for a non-root effective uid, quite a
39077 number of them do not. Because of this lack of standardization, Exim does not
39078 address this problem at this time.
39079
39080 For this reason, the recommended approach for &"mostly unprivileged"& running
39081 is to keep the Exim binary setuid to root, and to set
39082 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39083 be used in the most straightforward way.
39084
39085 If you configure Exim not to run delivery processes as root, there are a
39086 number of restrictions on what you can do:
39087
39088 .ilist
39089 You can deliver only as the Exim user/group. You should  explicitly use the
39090 &%user%& and &%group%& options to override routers or local transports that
39091 normally deliver as the recipient. This makes sure that configurations that
39092 work in this mode function the same way in normal mode. Any implicit or
39093 explicit specification of another user causes an error.
39094 .next
39095 Use of &_.forward_& files is severely restricted, such that it is usually
39096 not worthwhile to include them in the configuration.
39097 .next
39098 Users who wish to use &_.forward_& would have to make their home directory and
39099 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39100 and their equivalents in Exim filters, cannot be used. While they could be
39101 enabled in the Exim user's name, that would be insecure and not very useful.
39102 .next
39103 Unless the local user mailboxes are all owned by the Exim user (possible in
39104 some POP3 or IMAP-only environments):
39105
39106 .olist
39107 They must be owned by the Exim group and be writeable by that group. This
39108 implies you must set &%mode%& in the appendfile configuration, as well as the
39109 mode of the mailbox files themselves.
39110 .next
39111 You must set &%no_check_owner%&, since most or all of the files will not be
39112 owned by the Exim user.
39113 .next
39114 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39115 on a newly created mailbox when unprivileged. This also implies that new
39116 mailboxes need to be created manually.
39117 .endlist olist
39118 .endlist ilist
39119
39120
39121 These restrictions severely restrict what can be done in local deliveries.
39122 However, there are no restrictions on remote deliveries. If you are running a
39123 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39124 gives more security at essentially no cost.
39125
39126 If you are using the &%mua_wrapper%& facility (see chapter
39127 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39128
39129
39130
39131
39132 .section "Delivering to local files" "SECID271"
39133 Full details of the checks applied by &(appendfile)& before it writes to a file
39134 are given in chapter &<<CHAPappendfile>>&.
39135
39136
39137
39138 .section "Running local commands" "SECTsecconslocalcmds"
39139 .cindex "security" "local commands"
39140 .cindex "security" "command injection attacks"
39141 There are a number of ways in which an administrator can configure Exim to run
39142 commands based upon received, untrustworthy, data. Further, in some
39143 configurations a user who can control a &_.forward_& file can also arrange to
39144 run commands. Configuration to check includes, but is not limited to:
39145
39146 .ilist
39147 Use of &%use_shell%& in the pipe transport: various forms of shell command
39148 injection may be possible with this option present. It is dangerous and should
39149 be used only with considerable caution. Consider constraints which whitelist
39150 allowed characters in a variable which is to be used in a pipe transport that
39151 has &%use_shell%& enabled.
39152 .next
39153 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39154 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39155 &_.forward_& files in a redirect router. If Exim is running on a central mail
39156 hub to which ordinary users do not have shell access, but home directories are
39157 NFS mounted (for instance) then administrators should review the list of these
39158 forbid options available, and should bear in mind that the options that may
39159 need forbidding can change as new features are added between releases.
39160 .next
39161 The &%${run...}%& expansion item does not use a shell by default, but
39162 administrators can configure use of &_/bin/sh_& as part of the command.
39163 Such invocations should be viewed with prejudicial suspicion.
39164 .next
39165 Administrators who use embedded Perl are advised to explore how Perl's
39166 taint checking might apply to their usage.
39167 .next
39168 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39169 administrators are well advised to view its use with suspicion, in case (for
39170 instance) it allows a local-part to contain embedded Exim directives.
39171 .next
39172 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39173 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39174 each can reference arbitrary lists and files, rather than just being a list
39175 of opaque strings.
39176 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39177 real-world security vulnerabilities caused by its use with untrustworthy data
39178 injected in, for SQL injection attacks.
39179 Consider the use of the &%inlisti%& expansion condition instead.
39180 .endlist
39181
39182
39183
39184
39185 .section "Trust in configuration data" "SECTsecconfdata"
39186 .cindex "security" "data sources"
39187 .cindex "security" "regular expressions"
39188 .cindex "regular expressions" "security"
39189 .cindex "PCRE" "security"
39190 If configuration data for Exim can come from untrustworthy sources, there
39191 are some issues to be aware of:
39192
39193 .ilist
39194 Use of &%${expand...}%& may provide a path for shell injection attacks.
39195 .next
39196 Letting untrusted data provide a regular expression is unwise.
39197 .next
39198 Using &%${match...}%& to apply a fixed regular expression against untrusted
39199 data may result in pathological behaviour within PCRE.  Be aware of what
39200 "backtracking" means and consider options for being more strict with a regular
39201 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39202 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39203 possessive quantifiers or just not using regular expressions against untrusted
39204 data.
39205 .next
39206 It can be important to correctly use &%${quote:...}%&,
39207 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39208 items to ensure that data is correctly constructed.
39209 .next
39210 Some lookups might return multiple results, even though normal usage is only
39211 expected to yield one result.
39212 .endlist
39213
39214
39215
39216
39217 .section "IPv4 source routing" "SECID272"
39218 .cindex "source routing" "in IP packets"
39219 .cindex "IP source routing"
39220 Many operating systems suppress IP source-routed packets in the kernel, but
39221 some cannot be made to do this, so Exim does its own check. It logs incoming
39222 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39223 IPv6. No special checking is currently done.
39224
39225
39226
39227 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39228 Support for these SMTP commands is disabled by default. If required, they can
39229 be enabled by defining suitable ACLs.
39230
39231
39232
39233
39234 .section "Privileged users" "SECID274"
39235 .cindex "trusted users"
39236 .cindex "admin user"
39237 .cindex "privileged user"
39238 .cindex "user" "trusted"
39239 .cindex "user" "admin"
39240 Exim recognizes two sets of users with special privileges. Trusted users are
39241 able to submit new messages to Exim locally, but supply their own sender
39242 addresses and information about a sending host. For other users submitting
39243 local messages, Exim sets up the sender address from the uid, and doesn't
39244 permit a remote host to be specified.
39245
39246 .oindex "&%-f%&"
39247 However, an untrusted user is permitted to use the &%-f%& command line option
39248 in the special form &%-f <>%& to indicate that a delivery failure for the
39249 message should not cause an error report. This affects the message's envelope,
39250 but it does not affect the &'Sender:'& header. Untrusted users may also be
39251 permitted to use specific forms of address with the &%-f%& option by setting
39252 the &%untrusted_set_sender%& option.
39253
39254 Trusted users are used to run processes that receive mail messages from some
39255 other mail domain and pass them on to Exim for delivery either locally, or over
39256 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39257 as any user listed in the &%trusted_users%& configuration option, or under any
39258 group listed in the &%trusted_groups%& option.
39259
39260 Admin users are permitted to do things to the messages on Exim's queue. They
39261 can freeze or thaw messages, cause them to be returned to their senders, remove
39262 them entirely, or modify them in various ways. In addition, admin users can run
39263 the Exim monitor and see all the information it is capable of providing, which
39264 includes the contents of files on the spool.
39265
39266 .oindex "&%-M%&"
39267 .oindex "&%-q%&"
39268 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39269 delivery of messages on its queue is restricted to admin users. This
39270 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39271 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39272 queue is also restricted to admin users. This restriction can be relaxed by
39273 setting &%no_queue_list_requires_admin%&.
39274
39275 Exim recognizes an admin user if the calling process is running as root or as
39276 the Exim user or if any of the groups associated with the calling process is
39277 the Exim group. It is not necessary actually to be running under the Exim
39278 group. However, if admin users who are not root or the Exim user are to access
39279 the contents of files on the spool via the Exim monitor (which runs
39280 unprivileged), Exim must be built to allow group read access to its spool
39281 files.
39282
39283 By default, regular users are trusted to perform basic testing and
39284 introspection commands, as themselves.  This setting can be tightened by
39285 setting the &%commandline_checks_require_admin%& option.
39286 This affects most of the checking options,
39287 such as &%-be%& and anything else &%-b*%&.
39288
39289
39290 .section "Spool files" "SECID275"
39291 .cindex "spool directory" "files"
39292 Exim's spool directory and everything it contains is owned by the Exim user and
39293 set to the Exim group. The mode for spool files is defined in the
39294 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39295 any user who is a member of the Exim group can access these files.
39296
39297
39298
39299 .section "Use of argv[0]" "SECID276"
39300 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39301 of specific strings, Exim assumes certain options. For example, calling Exim
39302 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39303 to calling it with the option &%-bS%&. There are no security implications in
39304 this.
39305
39306
39307
39308 .section "Use of %f formatting" "SECID277"
39309 The only use made of &"%f"& by Exim is in formatting load average values. These
39310 are actually stored in integer variables as 1000 times the load average.
39311 Consequently, their range is limited and so therefore is the length of the
39312 converted output.
39313
39314
39315
39316 .section "Embedded Exim path" "SECID278"
39317 Exim uses its own path name, which is embedded in the code, only when it needs
39318 to re-exec in order to regain root privilege. Therefore, it is not root when it
39319 does so. If some bug allowed the path to get overwritten, it would lead to an
39320 arbitrary program's being run as exim, not as root.
39321
39322
39323
39324 .section "Dynamic module directory" "SECTdynmoddir"
39325 Any dynamically loadable modules must be installed into the directory
39326 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39327 loading it.
39328
39329
39330 .section "Use of sprintf()" "SECID279"
39331 .cindex "&[sprintf()]&"
39332 A large number of occurrences of &"sprintf"& in the code are actually calls to
39333 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39334 The intermediate formatting is done into a large fixed buffer by a function
39335 that runs through the format string itself, and checks the length of each
39336 conversion before performing it, thus preventing buffer overruns.
39337
39338 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39339 the output buffer is known to be sufficiently long to contain the converted
39340 string.
39341
39342
39343
39344 .section "Use of debug_printf() and log_write()" "SECID280"
39345 Arbitrary strings are passed to both these functions, but they do their
39346 formatting by calling the function &'string_vformat()'&, which runs through
39347 the format string itself, and checks the length of each conversion.
39348
39349
39350
39351 .section "Use of strcat() and strcpy()" "SECID281"
39352 These are used only in cases where the output buffer is known to be large
39353 enough to hold the result.
39354 .ecindex IIDsecurcon
39355
39356
39357
39358
39359 . ////////////////////////////////////////////////////////////////////////////
39360 . ////////////////////////////////////////////////////////////////////////////
39361
39362 .chapter "Format of spool files" "CHAPspool"
39363 .scindex IIDforspo1 "format" "spool files"
39364 .scindex IIDforspo2 "spool directory" "format of files"
39365 .scindex IIDforspo3 "spool files" "format of"
39366 .cindex "spool files" "editing"
39367 A message on Exim's queue consists of two files, whose names are the message id
39368 followed by -D and -H, respectively. The data portion of the message is kept in
39369 the -D file on its own. The message's envelope, status, and headers are all
39370 kept in the -H file, whose format is described in this chapter. Each of these
39371 two files contains the final component of its own name as its first line. This
39372 is insurance against disk crashes where the directory is lost but the files
39373 themselves are recoverable.
39374
39375 The file formats may be changed, or new formats added, at any release.
39376 Spool files are not intended as an interface to other programs
39377 and should not be used as such.
39378
39379 Some people are tempted into editing -D files in order to modify messages. You
39380 need to be extremely careful if you do this; it is not recommended and you are
39381 on your own if you do it. Here are some of the pitfalls:
39382
39383 .ilist
39384 You must ensure that Exim does not try to deliver the message while you are
39385 fiddling with it. The safest way is to take out a write lock on the -D file,
39386 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39387 place, the lock will be retained. If you write a new file and rename it, the
39388 lock will be lost at the instant of rename.
39389 .next
39390 .vindex "&$body_linecount$&"
39391 If you change the number of lines in the file, the value of
39392 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39393 cause incomplete transmission of messages or undeliverable messages.
39394 .next
39395 If the message is in MIME format, you must take care not to break it.
39396 .next
39397 If the message is cryptographically signed, any change will invalidate the
39398 signature.
39399 .endlist
39400 All in all, modifying -D files is fraught with danger.
39401
39402 Files whose names end with -J may also be seen in the &_input_& directory (or
39403 its subdirectories when &%split_spool_directory%& is set). These are journal
39404 files, used to record addresses to which the message has been delivered during
39405 the course of a delivery attempt. If there are still undelivered recipients at
39406 the end, the -H file is updated, and the -J file is deleted. If, however, there
39407 is some kind of crash (for example, a power outage) before this happens, the -J
39408 file remains in existence. When Exim next processes the message, it notices the
39409 -J file and uses it to update the -H file before starting the next delivery
39410 attempt.
39411
39412 Files whose names end with -K or .eml may also be seen in the spool.
39413 These are temporaries used for DKIM or malware processing, when that is used.
39414 They should be tidied up by normal operations; any old ones are probably
39415 relics of crashes and can be removed.
39416
39417 .section "Format of the -H file" "SECID282"
39418 .cindex "uid (user id)" "in spool file"
39419 .cindex "gid (group id)" "in spool file"
39420 The second line of the -H file contains the login name for the uid of the
39421 process that called Exim to read the message, followed by the numerical uid and
39422 gid. For a locally generated message, this is normally the user who sent the
39423 message. For a message received over TCP/IP via the daemon, it is
39424 normally the Exim user.
39425
39426 The third line of the file contains the address of the message's sender as
39427 transmitted in the envelope, contained in angle brackets. The sender address is
39428 empty for bounce messages. For incoming SMTP mail, the sender address is given
39429 in the MAIL command. For locally generated mail, the sender address is
39430 created by Exim from the login name of the current user and the configured
39431 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39432 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39433 &"<>"& or an address that matches &%untrusted_set_senders%&.
39434
39435 The fourth line contains two numbers. The first is the time that the message
39436 was received, in the conventional Unix form &-- the number of seconds since the
39437 start of the epoch. The second number is a count of the number of messages
39438 warning of delayed delivery that have been sent to the sender.
39439
39440 There follow a number of lines starting with a hyphen. These can appear in any
39441 order, and are omitted when not relevant:
39442
39443 .vlist
39444 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39445 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39446 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39447 recognized, to provide backward compatibility. In the old format, a line of
39448 this form is present for every ACL variable that is not empty. The number
39449 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39450 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39451 the data string for the variable. The string itself starts at the beginning of
39452 the next line, and is followed by a newline character. It may contain internal
39453 newlines.
39454
39455 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39456 A line of this form is present for every ACL connection variable that is
39457 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39458 The length is the length of the data string for the variable. The string itself
39459 starts at the beginning of the next line, and is followed by a newline
39460 character. It may contain internal newlines.
39461
39462 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39463 A line of this form is present for every ACL message variable that is defined.
39464 Note that there is a space between &%-aclm%& and the rest of the name. The
39465 length is the length of the data string for the variable. The string itself
39466 starts at the beginning of the next line, and is followed by a newline
39467 character. It may contain internal newlines.
39468
39469 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39470 This is present if, when the message was received over SMTP, the value of
39471 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39472
39473 .vitem &%-allow_unqualified_recipient%&
39474 This is present if unqualified recipient addresses are permitted in header
39475 lines (to stop such addresses from being qualified if rewriting occurs at
39476 transport time). Local messages that were input using &%-bnq%& and remote
39477 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39478
39479 .vitem &%-allow_unqualified_sender%&
39480 This is present if unqualified sender addresses are permitted in header lines
39481 (to stop such addresses from being qualified if rewriting occurs at transport
39482 time). Local messages that were input using &%-bnq%& and remote messages from
39483 hosts that match &%sender_unqualified_hosts%& set this flag.
39484
39485 .vitem "&%-auth_id%&&~<&'text'&>"
39486 The id information for a message received on an authenticated SMTP connection
39487 &-- the value of the &$authenticated_id$& variable.
39488
39489 .vitem "&%-auth_sender%&&~<&'address'&>"
39490 The address of an authenticated sender &-- the value of the
39491 &$authenticated_sender$& variable.
39492
39493 .vitem "&%-body_linecount%&&~<&'number'&>"
39494 This records the number of lines in the body of the message, and is
39495 present unless &%-spool_file_wireformat%& is.
39496
39497 .vitem "&%-body_zerocount%&&~<&'number'&>"
39498 This records the number of binary zero bytes in the body of the message, and is
39499 present if the number is greater than zero.
39500
39501 .vitem &%-deliver_firsttime%&
39502 This is written when a new message is first added to the spool. When the spool
39503 file is updated after a deferral, it is omitted.
39504
39505 .vitem "&%-frozen%&&~<&'time'&>"
39506 .cindex "frozen messages" "spool data"
39507 The message is frozen, and the freezing happened at <&'time'&>.
39508
39509 .vitem "&%-helo_name%&&~<&'text'&>"
39510 This records the host name as specified by a remote host in a HELO or EHLO
39511 command.
39512
39513 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39514 This records the IP address of the host from which the message was received and
39515 the remote port number that was used. It is omitted for locally generated
39516 messages.
39517
39518 .vitem "&%-host_auth%&&~<&'text'&>"
39519 If the message was received on an authenticated SMTP connection, this records
39520 the name of the authenticator &-- the value of the
39521 &$sender_host_authenticated$& variable.
39522
39523 .vitem &%-host_lookup_failed%&
39524 This is present if an attempt to look up the sending host's name from its IP
39525 address failed. It corresponds to the &$host_lookup_failed$& variable.
39526
39527 .vitem "&%-host_name%&&~<&'text'&>"
39528 .cindex "reverse DNS lookup"
39529 .cindex "DNS" "reverse lookup"
39530 This records the name of the remote host from which the message was received,
39531 if the host name was looked up from the IP address when the message was being
39532 received. It is not present if no reverse lookup was done.
39533
39534 .vitem "&%-ident%&&~<&'text'&>"
39535 For locally submitted messages, this records the login of the originating user,
39536 unless it was a trusted user and the &%-oMt%& option was used to specify an
39537 ident value. For messages received over TCP/IP, this records the ident string
39538 supplied by the remote host, if any.
39539
39540 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39541 This records the IP address of the local interface and the port number through
39542 which a message was received from a remote host. It is omitted for locally
39543 generated messages.
39544
39545 .vitem &%-local%&
39546 The message is from a local sender.
39547
39548 .vitem &%-localerror%&
39549 The message is a locally-generated bounce message.
39550
39551 .vitem "&%-local_scan%&&~<&'string'&>"
39552 This records the data string that was returned by the &[local_scan()]& function
39553 when the message was received &-- the value of the &$local_scan_data$&
39554 variable. It is omitted if no data was returned.
39555
39556 .vitem &%-manual_thaw%&
39557 The message was frozen but has been thawed manually, that is, by an explicit
39558 Exim command rather than via the auto-thaw process.
39559
39560 .vitem &%-N%&
39561 A testing delivery process was started using the &%-N%& option to suppress any
39562 actual deliveries, but delivery was deferred. At any further delivery attempts,
39563 &%-N%& is assumed.
39564
39565 .vitem &%-received_protocol%&
39566 This records the value of the &$received_protocol$& variable, which contains
39567 the name of the protocol by which the message was received.
39568
39569 .vitem &%-sender_set_untrusted%&
39570 The envelope sender of this message was set by an untrusted local caller (used
39571 to ensure that the caller is displayed in queue listings).
39572
39573 .vitem "&%-spam_score_int%&&~<&'number'&>"
39574 If a message was scanned by SpamAssassin, this is present. It records the value
39575 of &$spam_score_int$&.
39576
39577 .vitem &%-spool_file_wireformat%&
39578 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39579 rather than Unix-format.
39580 The line-ending is CRLF rather than newline.
39581 There is still, however, no leading-dot-stuffing.
39582
39583 .vitem &%-tls_certificate_verified%&
39584 A TLS certificate was received from the client that sent this message, and the
39585 certificate was verified by the server.
39586
39587 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39588 When the message was received over an encrypted connection, this records the
39589 name of the cipher suite that was used.
39590
39591 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39592 When the message was received over an encrypted connection, and a certificate
39593 was received from the client, this records the Distinguished Name from that
39594 certificate.
39595 .endlist
39596
39597 .new
39598 Any of the above may have an extra hyphen prepended, to indicate the the
39599 corresponding data is untrusted.
39600 .wen
39601
39602 Following the options there is a list of those addresses to which the message
39603 is not to be delivered. This set of addresses is initialized from the command
39604 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39605 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39606 the address is added to this set. The addresses are kept internally as a
39607 balanced binary tree, and it is a representation of that tree which is written
39608 to the spool file. If an address is expanded via an alias or forward file, the
39609 original address is added to the tree when deliveries to all its child
39610 addresses are complete.
39611
39612 If the tree is empty, there is a single line in the spool file containing just
39613 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39614 Y or N, followed by an address. The address is the value for the node of the
39615 tree, and the letters indicate whether the node has a left branch and/or a
39616 right branch attached to it, respectively. If branches exist, they immediately
39617 follow. Here is an example of a three-node tree:
39618 .code
39619 YY darcy@austen.fict.example
39620 NN alice@wonderland.fict.example
39621 NN editor@thesaurus.ref.example
39622 .endd
39623 After the non-recipients tree, there is a list of the message's recipients.
39624 This is a simple list, preceded by a count. It includes all the original
39625 recipients of the message, including those to whom the message has already been
39626 delivered. In the simplest case, the list contains one address per line. For
39627 example:
39628 .code
39629 4
39630 editor@thesaurus.ref.example
39631 darcy@austen.fict.example
39632 rdo@foundation
39633 alice@wonderland.fict.example
39634 .endd
39635 However, when a child address has been added to the top-level addresses as a
39636 result of the use of the &%one_time%& option on a &(redirect)& router, each
39637 line is of the following form:
39638 .display
39639 <&'top-level address'&> <&'errors_to address'&> &&&
39640   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39641 .endd
39642 The 01 flag bit indicates the presence of the three other fields that follow
39643 the top-level address. Other bits may be used in future to support additional
39644 fields. The <&'parent number'&> is the offset in the recipients list of the
39645 original parent of the &"one time"& address. The first two fields are the
39646 envelope sender that is associated with this address and its length. If the
39647 length is zero, there is no special envelope sender (there are then two space
39648 characters in the line). A non-empty field can arise from a &(redirect)& router
39649 that has an &%errors_to%& setting.
39650
39651
39652 A blank line separates the envelope and status information from the headers
39653 which follow. A header may occupy several lines of the file, and to save effort
39654 when reading it in, each header is preceded by a number and an identifying
39655 character. The number is the number of characters in the header, including any
39656 embedded newlines and the terminating newline. The character is one of the
39657 following:
39658
39659 .table2 50pt
39660 .row <&'blank'&>         "header in which Exim has no special interest"
39661 .row &`B`&               "&'Bcc:'& header"
39662 .row &`C`&               "&'Cc:'& header"
39663 .row &`F`&               "&'From:'& header"
39664 .row &`I`&               "&'Message-id:'& header"
39665 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39666 .row &`R`&               "&'Reply-To:'& header"
39667 .row &`S`&               "&'Sender:'& header"
39668 .row &`T`&               "&'To:'& header"
39669 .row &`*`&               "replaced or deleted header"
39670 .endtable
39671
39672 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39673 purposes. They are not transmitted when the message is delivered. Here is a
39674 typical set of headers:
39675 .code
39676 111P Received: by hobbit.fict.example with local (Exim 4.00)
39677 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39678 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39679 038* X-rewrote-sender: bb@hobbit.fict.example
39680 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39681 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39682 099* To: alice@wonderland.fict.example, rdo@foundation,
39683 darcy@austen.fict.example, editor@thesaurus.ref.example
39684 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39685 darcy@austen.fict.example, editor@thesaurus.ref.example
39686 038  Date: Fri, 11 May 2001 10:28:59 +0100
39687 .endd
39688 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39689 &'To:'& header have been rewritten, the last one because routing expanded the
39690 unqualified domain &'foundation'&.
39691 .ecindex IIDforspo1
39692 .ecindex IIDforspo2
39693 .ecindex IIDforspo3
39694
39695 .section "Format of the -D file" "SECID282a"
39696 The data file is traditionally in Unix-standard format: lines are ended with
39697 an ASCII newline character.
39698 However, when the &%spool_wireformat%& main option is used some -D files
39699 can have an alternate format.
39700 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39701 The -D file lines (not including the first name-component line) are
39702 suitable for direct copying to the wire when transmitting using the
39703 ESMTP CHUNKING option, meaning lower processing overhead.
39704 Lines are terminated with an ASCII CRLF pair.
39705 There is no dot-stuffing (and no dot-termination).
39706
39707 . ////////////////////////////////////////////////////////////////////////////
39708 . ////////////////////////////////////////////////////////////////////////////
39709
39710 .chapter "DKIM and SPF" "CHAPdkim" &&&
39711          "DKIM and SPF Support"
39712 .cindex "DKIM"
39713
39714 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39715
39716 DKIM is a mechanism by which messages sent by some entity can be provably
39717 linked to a domain which that entity controls.  It permits reputation to
39718 be tracked on a per-domain basis, rather than merely upon source IP address.
39719 DKIM is documented in RFC 6376.
39720
39721 As DKIM relies on the message being unchanged in transit, messages handled
39722 by a mailing-list (which traditionally adds to the message) will not match
39723 any original DKIM signature.
39724
39725 DKIM support is compiled into Exim by default if TLS support is present.
39726 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39727
39728 Exim's DKIM implementation allows for
39729 .olist
39730 Signing outgoing messages: This function is implemented in the SMTP transport.
39731 It can co-exist with all other Exim features
39732 (including transport filters)
39733 except cutthrough delivery.
39734 .next
39735 Verifying signatures in incoming messages: This is implemented by an additional
39736 ACL (acl_smtp_dkim), which can be called several times per message, with
39737 different signature contexts.
39738 .endlist
39739
39740 In typical Exim style, the verification implementation does not include any
39741 default "policy". Instead it enables you to build your own policy using
39742 Exim's standard controls.
39743
39744 Please note that verification of DKIM signatures in incoming mail is turned
39745 on by default for logging (in the <= line) purposes.
39746
39747 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39748 When set, for each signature in incoming email,
39749 exim will log a line displaying the most important signature details, and the
39750 signature status. Here is an example (with line-breaks added for clarity):
39751 .code
39752 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39753     d=facebookmail.com s=q1-2009b
39754     c=relaxed/relaxed a=rsa-sha1
39755     i=@facebookmail.com t=1252484542 [verification succeeded]
39756 .endd
39757
39758 You might want to turn off DKIM verification processing entirely for internal
39759 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39760 control modifier. This should typically be done in the RCPT ACL, at points
39761 where you accept mail from relay sources (internal hosts or authenticated
39762 senders).
39763
39764
39765 .section "Signing outgoing messages" "SECDKIMSIGN"
39766 .cindex "DKIM" "signing"
39767
39768 For signing to be usable you must have published a DKIM record in DNS.
39769 Note that RFC 8301 (which does not cover EC keys) says:
39770 .code
39771 rsa-sha1 MUST NOT be used for signing or verifying.
39772
39773 Signers MUST use RSA keys of at least 1024 bits for all keys.
39774 Signers SHOULD use RSA keys of at least 2048 bits.
39775 .endd
39776
39777 Note also that the key content (the 'p=' field)
39778 in the DNS record is different between RSA and EC keys;
39779 for the former it is the base64 of the ASN.1 for the RSA public key
39780 (equivalent to the private-key .pem with the header/trailer stripped)
39781 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39782
39783 Signing is enabled by setting private options on the SMTP transport.
39784 These options take (expandable) strings as arguments.
39785
39786 .option dkim_domain smtp string list&!! unset
39787 The domain(s) you want to sign with.
39788 After expansion, this can be a list.
39789 Each element in turn,
39790 .new
39791 lowercased,
39792 .wen
39793 is put into the &%$dkim_domain%& expansion variable
39794 while expanding the remaining signing options.
39795 If it is empty after expansion, DKIM signing is not done,
39796 and no error will result even if &%dkim_strict%& is set.
39797
39798 .option dkim_selector smtp string list&!! unset
39799 This sets the key selector string.
39800 After expansion, which can use &$dkim_domain$&, this can be a list.
39801 Each element in turn is put in the expansion
39802 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39803 option along with &%$dkim_domain%&.
39804 If the option is empty after expansion, DKIM signing is not done for this domain,
39805 and no error will result even if &%dkim_strict%& is set.
39806
39807 .option dkim_private_key smtp string&!! unset
39808 This sets the private key to use.
39809 You can use the &%$dkim_domain%& and
39810 &%$dkim_selector%& expansion variables to determine the private key to use.
39811 The result can either
39812 .ilist
39813 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39814 .next
39815 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39816 be a valid Ed25519 private key (same format as above)
39817 .next
39818 start with a slash, in which case it is treated as a file that contains
39819 the private key
39820 .next
39821 be "0", "false" or the empty string, in which case the message will not
39822 be signed. This case will not result in an error, even if &%dkim_strict%&
39823 is set.
39824 .endlist
39825
39826 To generate keys under OpenSSL:
39827 .code
39828 openssl genrsa -out dkim_rsa.private 2048
39829 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39830 .endd
39831 Take the base-64 lines from the output of the second command, concatenated,
39832 for the DNS TXT record.
39833 See section 3.6 of RFC6376 for the record specification.
39834
39835 Under GnuTLS:
39836 .code
39837 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39838 certtool --load-privkey=dkim_rsa.private --pubkey-info
39839 .endd
39840
39841 Note that RFC 8301 says:
39842 .code
39843 Signers MUST use RSA keys of at least 1024 bits for all keys.
39844 Signers SHOULD use RSA keys of at least 2048 bits.
39845 .endd
39846
39847 .new
39848 EC keys for DKIM are defined by RFC 8463.
39849 .wen
39850 They are considerably smaller than RSA keys for equivalent protection.
39851 As they are a recent development, users should consider dual-signing
39852 (by setting a list of selectors, and an expansion for this option)
39853 for some transition period.
39854 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39855 for EC keys.
39856
39857 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39858 .code
39859 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39860 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39861 .endd
39862
39863 To produce the required public key value for a DNS record:
39864 .code
39865 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39866 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39867 .endd
39868
39869 .new
39870 Exim also supports an alternate format
39871 of Ed25519 keys in DNS which was a candidate during development
39872 of the standard, but not adopted.
39873 A future release will probably drop that support.
39874 .wen
39875
39876 .option dkim_hash smtp string&!! sha256
39877 Can be set to any one of the supported hash methods, which are:
39878 .ilist
39879 &`sha1`& &-- should not be used, is old and insecure
39880 .next
39881 &`sha256`& &-- the default
39882 .next
39883 &`sha512`& &-- possibly more secure but less well supported
39884 .endlist
39885
39886 Note that RFC 8301 says:
39887 .code
39888 rsa-sha1 MUST NOT be used for signing or verifying.
39889 .endd
39890
39891 .option dkim_identity smtp string&!! unset
39892 If set after expansion, the value is used to set an "i=" tag in
39893 the signing header.  The DKIM standards restrict the permissible
39894 syntax of this optional tag to a mail address, with possibly-empty
39895 local part, an @, and a domain identical to or subdomain of the "d="
39896 tag value.  Note that Exim does not check the value.
39897
39898 .option dkim_canon smtp string&!! unset
39899 This option sets the canonicalization method used when signing a message.
39900 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39901 The option defaults to "relaxed" when unset. Note: the current implementation
39902 only supports signing with the same canonicalization method for both headers and body.
39903
39904 .option dkim_strict smtp string&!! unset
39905 This  option  defines  how  Exim  behaves  when  signing a message that
39906 should be signed fails for some reason.  When the expansion evaluates to
39907 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39908 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39909 variables here.
39910
39911 .option dkim_sign_headers smtp string&!! "see below"
39912 If set, this option must expand to a colon-separated
39913 list of header names.
39914 Headers with these names, or the absence or such a header, will be included
39915 in the message signature.
39916 When unspecified, the header names listed in RFC4871 will be used,
39917 whether or not each header is present in the message.
39918 The default list is available for the expansion in the macro
39919 "_DKIM_SIGN_HEADERS".
39920
39921 If a name is repeated, multiple headers by that name (or the absence thereof)
39922 will be signed.  The textually later headers in the headers part of the
39923 message are signed first, if there are multiples.
39924
39925 A name can be prefixed with either an '=' or a '+' character.
39926 If an '=' prefix is used, all headers that are present with this name
39927 will be signed.
39928 If a '+' prefix if used, all headers that are present with this name
39929 will be signed, and one signature added for a missing header with the
39930 name will be appended.
39931
39932 .option dkim_timestamps smtp integer&!! unset
39933 This option controls the inclusion of timestamp information in the signature.
39934 If not set, no such information will be included.
39935 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39936 for the expiry tag
39937 (eg. 1209600 for two weeks);
39938 both creation (t=) and expiry (x=) tags will be included.
39939
39940 RFC 6376 lists these tags as RECOMMENDED.
39941
39942
39943 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39944 .cindex "DKIM" "verification"
39945
39946 Verification of DKIM signatures in SMTP incoming email is done for all
39947 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39948 .new
39949 .cindex DKIM "selecting signature algorithms"
39950 Individual classes of signature algorithm can be ignored by changing
39951 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
39952 The &%dkim_verify_minimal%& option can be set to cease verification
39953 processing for a message once the first passing signature is found.
39954 .wen
39955
39956 .cindex authentication "expansion item"
39957 Performing verification sets up information used by the
39958 &$authresults$& expansion item.
39959
39960 .new
39961 For most purposes the default option settings suffice and the remainder
39962 of this section can be ignored.
39963 .wen
39964
39965 The results of verification are made available to the
39966 &%acl_smtp_dkim%& ACL, which can examine and modify them.
39967 A missing ACL definition defaults to accept.
39968 By default, the ACL is called once for each
39969 syntactically(!) correct signature in the incoming message.
39970 If any ACL call does not accept, the message is not accepted.
39971 If a cutthrough delivery was in progress for the message, that is
39972 summarily dropped (having wasted the transmission effort).
39973
39974 To evaluate the verification result in the ACL
39975 a large number of expansion variables
39976 containing the signature status and its details are set up during the
39977 runtime of the ACL.
39978
39979 Calling the ACL only for existing signatures is not sufficient to build
39980 more advanced policies. For that reason, the main option
39981 &%dkim_verify_signers%&, and an expansion variable
39982 &%$dkim_signers%& exist.
39983
39984 The main option &%dkim_verify_signers%& can be set to a colon-separated
39985 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39986 called. It is expanded when the message has been received. At this point,
39987 the expansion variable &%$dkim_signers%& already contains a colon-separated
39988 list of signer domains and identities for the message. When
39989 &%dkim_verify_signers%& is not specified in the main configuration,
39990 it defaults as:
39991 .code
39992 dkim_verify_signers = $dkim_signers
39993 .endd
39994 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39995 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39996 call the ACL for known domains or identities. This would be achieved as follows:
39997 .code
39998 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39999 .endd
40000 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40001 and "ebay.com", plus all domains and identities that have signatures in the message.
40002 You can also be more creative in constructing your policy. For example:
40003 .code
40004 dkim_verify_signers = $sender_address_domain:$dkim_signers
40005 .endd
40006
40007 If a domain or identity is listed several times in the (expanded) value of
40008 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40009
40010 .new
40011 Note that if the option is set using untrustworthy data
40012 (such as the From: header)
40013 care should be taken to force lowercase for domains
40014 and for the domain part if identities.
40015 The default setting can be regarded as trustworthy in this respect.
40016 .wen
40017
40018 If multiple signatures match a domain (or identity), the ACL is called once
40019 for each matching signature.
40020
40021
40022 Inside the DKIM ACL, the following expansion variables are
40023 available (from most to least important):
40024
40025
40026 .vlist
40027 .vitem &%$dkim_cur_signer%&
40028 The signer that is being evaluated in this ACL run. This can be a domain or
40029 an identity. This is one of the list items from the expanded main option
40030 &%dkim_verify_signers%& (see above).
40031
40032 .vitem &%$dkim_verify_status%&
40033 Within the DKIM ACL,
40034 a string describing the general status of the signature. One of
40035 .ilist
40036 &%none%&: There is no signature in the message for the current domain or
40037 identity (as reflected by &%$dkim_cur_signer%&).
40038 .next
40039 &%invalid%&: The signature could not be verified due to a processing error.
40040 More detail is available in &%$dkim_verify_reason%&.
40041 .next
40042 &%fail%&: Verification of the signature failed.  More detail is
40043 available in &%$dkim_verify_reason%&.
40044 .next
40045 &%pass%&: The signature passed verification. It is valid.
40046 .endlist
40047
40048 This variable can be overwritten using an ACL 'set' modifier.
40049 This might, for instance, be done to enforce a policy restriction on
40050 hash-method or key-size:
40051 .code
40052   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40053        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40054        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40055                                   {< {$dkim_key_length}{1024}}}}
40056        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40057        set dkim_verify_status = fail
40058        set dkim_verify_reason = hash too weak or key too short
40059 .endd
40060
40061 So long as a DKIM ACL is defined (it need do no more than accept),
40062 after all the DKIM ACL runs have completed, the value becomes a
40063 colon-separated list of the values after each run.
40064 This is maintained for the mime, prdr and data ACLs.
40065
40066 .vitem &%$dkim_verify_reason%&
40067 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40068 "fail" or "invalid". One of
40069 .ilist
40070 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40071 key for the domain could not be retrieved. This may be a temporary problem.
40072 .next
40073 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40074 record for the domain is syntactically invalid.
40075 .next
40076 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40077 body hash does not match the one specified in the signature header. This
40078 means that the message body was modified in transit.
40079 .next
40080 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40081 could not be verified. This may mean that headers were modified,
40082 re-written or otherwise changed in a way which is incompatible with
40083 DKIM verification. It may of course also mean that the signature is forged.
40084 .endlist
40085
40086 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40087
40088 .vitem &%$dkim_domain%&
40089 The signing domain. IMPORTANT: This variable is only populated if there is
40090 an actual signature in the message for the current domain or identity (as
40091 reflected by &%$dkim_cur_signer%&).
40092
40093 .vitem &%$dkim_identity%&
40094 The signing identity, if present. IMPORTANT: This variable is only populated
40095 if there is an actual signature in the message for the current domain or
40096 identity (as reflected by &%$dkim_cur_signer%&).
40097
40098 .vitem &%$dkim_selector%&
40099 The key record selector string.
40100
40101 .vitem &%$dkim_algo%&
40102 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40103 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40104 may also be 'ed25519-sha256'.
40105 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40106 for EC keys.
40107
40108 Note that RFC 8301 says:
40109 .code
40110 rsa-sha1 MUST NOT be used for signing or verifying.
40111
40112 DKIM signatures identified as having been signed with historic
40113 algorithms (currently, rsa-sha1) have permanently failed evaluation
40114 .endd
40115
40116 To enforce this you must either have a DKIM ACL which checks this variable
40117 and overwrites the &$dkim_verify_status$& variable as discussed above,
40118 .new
40119 or have set the main option &%dkim_verify_hashes%& to exclude
40120 processing of such signatures.
40121 .wen
40122
40123 .vitem &%$dkim_canon_body%&
40124 The body canonicalization method. One of 'relaxed' or 'simple'.
40125
40126 .vitem &%$dkim_canon_headers%&
40127 The header canonicalization method. One of 'relaxed' or 'simple'.
40128
40129 .vitem &%$dkim_copiedheaders%&
40130 A transcript of headers and their values which are included in the signature
40131 (copied from the 'z=' tag of the signature).
40132 Note that RFC6376 requires that verification fail if the From: header is
40133 not included in the signature.  Exim does not enforce this; sites wishing
40134 strict enforcement should code the check explicitly.
40135
40136 .vitem &%$dkim_bodylength%&
40137 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40138 limit was set by the signer, "9999999999999" is returned. This makes sure
40139 that this variable always expands to an integer value.
40140 &*Note:*& The presence of the signature tag specifying a signing body length
40141 is one possible route to spoofing of valid DKIM signatures.
40142 A paranoid implementation might wish to regard signature where this variable
40143 shows less than the "no limit" return as being invalid.
40144
40145 .vitem &%$dkim_created%&
40146 UNIX timestamp reflecting the date and time when the signature was created.
40147 When this was not specified by the signer, "0" is returned.
40148
40149 .vitem &%$dkim_expires%&
40150 UNIX timestamp reflecting the date and time when the signer wants the
40151 signature to be treated as "expired". When this was not specified by the
40152 signer, "9999999999999" is returned. This makes it possible to do useful
40153 integer size comparisons against this value.
40154 Note that Exim does not check this value.
40155
40156 .vitem &%$dkim_headernames%&
40157 A colon-separated list of names of headers included in the signature.
40158
40159 .vitem &%$dkim_key_testing%&
40160 "1" if the key record has the "testing" flag set, "0" if not.
40161
40162 .vitem &%$dkim_key_nosubdomains%&
40163 "1" if the key record forbids subdomaining, "0" otherwise.
40164
40165 .vitem &%$dkim_key_srvtype%&
40166 Service type (tag s=) from the key record. Defaults to "*" if not specified
40167 in the key record.
40168
40169 .vitem &%$dkim_key_granularity%&
40170 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40171 in the key record.
40172
40173 .vitem &%$dkim_key_notes%&
40174 Notes from the key record (tag n=).
40175
40176 .vitem &%$dkim_key_length%&
40177 Number of bits in the key.
40178
40179 Note that RFC 8301 says:
40180 .code
40181 Verifiers MUST NOT consider signatures using RSA keys of
40182 less than 1024 bits as valid signatures.
40183 .endd
40184
40185 To enforce this you must have a DKIM ACL which checks this variable
40186 and overwrites the &$dkim_verify_status$& variable as discussed above.
40187 As EC keys are much smaller, the check should only do this for RSA keys.
40188
40189 .endlist
40190
40191 In addition, two ACL conditions are provided:
40192
40193 .vlist
40194 .vitem &%dkim_signers%&
40195 ACL condition that checks a colon-separated list of domains or identities
40196 for a match against the domain or identity that the ACL is currently verifying
40197 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40198 verb to a group of domains or identities. For example:
40199
40200 .code
40201 # Warn when Mail purportedly from GMail has no gmail signature
40202 warn log_message = GMail sender without gmail.com DKIM signature
40203      sender_domains = gmail.com
40204      dkim_signers = gmail.com
40205      dkim_status = none
40206 .endd
40207
40208 Note that the above does not check for a total lack of DKIM signing;
40209 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40210
40211 .vitem &%dkim_status%&
40212 ACL condition that checks a colon-separated list of possible DKIM verification
40213 results against the actual result of verification. This is typically used
40214 to restrict an ACL verb to a list of verification outcomes, for example:
40215
40216 .code
40217 deny message = Mail from Paypal with invalid/missing signature
40218      sender_domains = paypal.com:paypal.de
40219      dkim_signers = paypal.com:paypal.de
40220      dkim_status = none:invalid:fail
40221 .endd
40222
40223 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40224 see the documentation of the &%$dkim_verify_status%& expansion variable above
40225 for more information of what they mean.
40226 .endlist
40227
40228
40229
40230
40231 .section "SPF (Sender Policy Framework)" SECSPF
40232 .cindex SPF verification
40233
40234 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40235 messages with its domain in the envelope from, documented by RFC 7208.
40236 For more information on SPF see &url(http://www.openspf.org).
40237 . --- 2018-09-07: still not https
40238
40239 Messages sent by a system not authorised will fail checking of such assertions.
40240 This includes retransmissions done by traditional forwarders.
40241
40242 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40243 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40244 &url(https://www.libspf2.org/).
40245 There is no Exim involvement in the transmission of messages;
40246 publishing certain DNS records is all that is required.
40247
40248 For verification, an ACL condition and an expansion lookup are provided.
40249 .cindex authentication "expansion item"
40250 Performing verification sets up information used by the
40251 &$authresults$& expansion item.
40252
40253
40254 .cindex SPF "ACL condition"
40255 .cindex ACL "spf condition"
40256 The ACL condition "spf" can be used at or after the MAIL ACL.
40257 It takes as an argument a list of strings giving the outcome of the SPF check,
40258 and will succeed for any matching outcome.
40259 Valid strings are:
40260 .vlist
40261 .vitem &%pass%&
40262 The SPF check passed, the sending host is positively verified by SPF.
40263
40264 .vitem &%fail%&
40265 The SPF check failed, the sending host is NOT allowed to send mail for the
40266 domain in the envelope-from address.
40267
40268 .vitem &%softfail%&
40269 The SPF check failed, but the queried domain can't absolutely confirm that this
40270 is a forgery.
40271
40272 .vitem &%none%&
40273 The queried domain does not publish SPF records.
40274
40275 .vitem &%neutral%&
40276 The SPF check returned a "neutral" state.  This means the queried domain has
40277 published a SPF record, but wants to allow outside servers to send mail under
40278 its domain as well.  This should be treated like "none".
40279
40280 .vitem &%permerror%&
40281 This indicates a syntax error in the SPF record of the queried domain.
40282 You may deny messages when this occurs.
40283
40284 .vitem &%temperror%&
40285 This indicates a temporary error during all processing, including Exim's
40286 SPF processing.  You may defer messages when this occurs.
40287 .endlist
40288
40289 You can prefix each string with an exclamation mark to  invert
40290 its meaning,  for example  "!fail" will  match all  results but
40291 "fail".  The  string  list is  evaluated  left-to-right,  in a
40292 short-circuit fashion.
40293
40294 Example:
40295 .code
40296 deny spf = fail
40297      message = $sender_host_address is not allowed to send mail from \
40298                ${if def:sender_address_domain \
40299                     {$sender_address_domain}{$sender_helo_name}}.  \
40300                Please see http://www.openspf.org/Why?scope=\
40301                ${if def:sender_address_domain {mfrom}{helo}};\
40302                identity=${if def:sender_address_domain \
40303                              {$sender_address}{$sender_helo_name}};\
40304                ip=$sender_host_address
40305 .endd
40306
40307 When the spf condition has run, it sets up several expansion
40308 variables:
40309
40310 .cindex SPF "verification variables"
40311 .vlist
40312 .vitem &$spf_header_comment$&
40313 .vindex &$spf_header_comment$&
40314   This contains a human-readable string describing the outcome
40315   of the SPF check. You can add it to a custom header or use
40316   it for logging purposes.
40317
40318 .vitem &$spf_received$&
40319 .vindex &$spf_received$&
40320   This contains a complete Received-SPF: header that can be
40321   added to the message. Please note that according to the SPF
40322   draft, this header must be added at the top of the header
40323   list. Please see section 10 on how you can do this.
40324
40325   Note: in case of "Best-guess" (see below), the convention is
40326   to put this string in a header called X-SPF-Guess: instead.
40327
40328 .vitem &$spf_result$&
40329 .vindex &$spf_result$&
40330   This contains the outcome of the SPF check in string form,
40331   one of pass, fail, softfail, none, neutral, permerror or
40332   temperror.
40333
40334 .vitem &$spf_result_guessed$&
40335 .vindex &$spf_result_guessed$&
40336   This boolean is true only if a best-guess operation was used
40337   and required in order to obtain a result.
40338
40339 .vitem &$spf_smtp_comment$&
40340 .vindex &$spf_smtp_comment$&
40341   This contains a string that can be used in a SMTP response
40342   to the calling party. Useful for "fail".
40343 .endlist
40344
40345
40346 .cindex SPF "ACL condition"
40347 .cindex ACL "spf_guess condition"
40348 .cindex SPF "best guess"
40349 In addition to SPF, you can also perform checks for so-called
40350 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40351 SPF, but it is supported by the same framework that enables SPF
40352 capability.
40353 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40354 for a description of what it means.
40355 . --- 2018-09-07: still not https:
40356
40357 To access this feature, simply use the spf_guess condition in place
40358 of the spf one.  For example:
40359
40360 .code
40361 deny spf_guess = fail
40362      message = $sender_host_address doesn't look trustworthy to me
40363 .endd
40364
40365 In case you decide to reject messages based on this check, you
40366 should note that although it uses the same framework, "Best-guess"
40367 is not SPF, and therefore you should not mention SPF at all in your
40368 reject message.
40369
40370 When the spf_guess condition has run, it sets up the same expansion
40371 variables as when spf condition is run, described above.
40372
40373 Additionally, since Best-guess is not standardized, you may redefine
40374 what "Best-guess" means to you by redefining the main configuration
40375 &%spf_guess%& option.
40376 For example, the following:
40377
40378 .code
40379 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40380 .endd
40381
40382 would relax host matching rules to a broader network range.
40383
40384
40385 .cindex SPF "lookup expansion"
40386 .cindex lookup spf
40387 A lookup expansion is also available. It takes an email
40388 address as the key and an IP address
40389 .new
40390 (v4 or v6)
40391 .wen
40392 as the database:
40393
40394 .code
40395   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40396 .endd
40397
40398 The lookup will return the same result strings as can appear in
40399 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40400
40401
40402
40403
40404 . ////////////////////////////////////////////////////////////////////////////
40405 . ////////////////////////////////////////////////////////////////////////////
40406
40407 .chapter "Proxies" "CHAPproxies" &&&
40408          "Proxy support"
40409 .cindex "proxy support"
40410 .cindex "proxy" "access via"
40411
40412 A proxy is an intermediate system through which communication is passed.
40413 Proxies may provide a security, availability or load-distribution function.
40414
40415
40416 .section "Inbound proxies" SECTproxyInbound
40417 .cindex proxy inbound
40418 .cindex proxy "server side"
40419 .cindex proxy "Proxy protocol"
40420 .cindex "Proxy protocol" proxy
40421
40422 Exim has support for receiving inbound SMTP connections via a proxy
40423 that uses &"Proxy Protocol"& to speak to it.
40424 To include this support, include &"SUPPORT_PROXY=yes"&
40425 in Local/Makefile.
40426
40427 It was built on the HAProxy specification, found at
40428 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40429
40430 The purpose of this facility is so that an application load balancer,
40431 such as HAProxy, can sit in front of several Exim servers
40432 to distribute load.
40433 Exim uses the local protocol communication with the proxy to obtain
40434 the remote SMTP system IP address and port information.
40435 There is no logging if a host passes or
40436 fails Proxy Protocol negotiation, but it can easily be determined and
40437 recorded in an ACL (example is below).
40438
40439 Use of a proxy is enabled by setting the &%hosts_proxy%&
40440 main configuration option to a hostlist; connections from these
40441 hosts will use Proxy Protocol.
40442 Exim supports both version 1 and version 2 of the Proxy Protocol and
40443 automatically determines which version is in use.
40444
40445 The Proxy Protocol header is the first data received on a TCP connection
40446 and is inserted before any TLS-on-connect handshake from the client; Exim
40447 negotiates TLS between Exim-as-server and the remote client, not between
40448 Exim and the proxy server.
40449
40450 The following expansion variables are usable
40451 (&"internal"& and &"external"& here refer to the interfaces
40452 of the proxy):
40453 .display
40454 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40455 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40456 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40457 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40458 &'proxy_session            '& boolean: SMTP connection via proxy
40459 .endd
40460 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40461 there was a protocol error.
40462 The variables &$sender_host_address$& and &$sender_host_port$&
40463 will have values for the actual client system, not the proxy.
40464
40465 Since the real connections are all coming from the proxy, and the
40466 per host connection tracking is done before Proxy Protocol is
40467 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40468 handle all of the parallel volume you expect per inbound proxy.
40469 With the option set so high, you lose the ability
40470 to protect your server from many connections from one IP.
40471 In order to prevent your server from overload, you
40472 need to add a per connection ratelimit to your connect ACL.
40473 A possible solution is:
40474 .display
40475   # Set max number of connections per host
40476   LIMIT   = 5
40477   # Or do some kind of IP lookup in a flat file or database
40478   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40479
40480   defer   message        = Too many connections from this IP right now
40481           ratelimit      = LIMIT / 5s / per_conn / strict
40482 .endd
40483
40484
40485
40486 .section "Outbound proxies" SECTproxySOCKS
40487 .cindex proxy outbound
40488 .cindex proxy "client side"
40489 .cindex proxy SOCKS
40490 .cindex SOCKS proxy
40491 Exim has support for sending outbound SMTP via a proxy
40492 using a protocol called SOCKS5 (defined by RFC1928).
40493 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40494 Local/Makefile.
40495
40496 Use of a proxy is enabled by setting the &%socks_proxy%& option
40497 on an smtp transport.
40498 The option value is expanded and should then be a list
40499 (colon-separated by default) of proxy specifiers.
40500 Each proxy specifier is a list
40501 (space-separated by default) where the initial element
40502 is an IP address and any subsequent elements are options.
40503
40504 Options are a string <name>=<value>.
40505 The list of options is in the following table:
40506 .display
40507 &'auth   '& authentication method
40508 &'name   '& authentication username
40509 &'pass   '& authentication password
40510 &'port   '& tcp port
40511 &'tmo    '& connection timeout
40512 &'pri    '& priority
40513 &'weight '& selection bias
40514 .endd
40515
40516 More details on each of these options follows:
40517
40518 .ilist
40519 .cindex authentication "to proxy"
40520 .cindex proxy authentication
40521 &%auth%&: Either &"none"& (default) or &"name"&.
40522 Using &"name"& selects username/password authentication per RFC 1929
40523 for access to the proxy.
40524 Default is &"none"&.
40525 .next
40526 &%name%&: sets the username for the &"name"& authentication method.
40527 Default is empty.
40528 .next
40529 &%pass%&: sets the password for the &"name"& authentication method.
40530 Default is empty.
40531 .next
40532 &%port%&: the TCP port number to use for the connection to the proxy.
40533 Default is 1080.
40534 .next
40535 &%tmo%&: sets a connection timeout in seconds for this proxy.
40536 Default is 5.
40537 .next
40538 &%pri%&: specifies a priority for the proxy within the list,
40539 higher values being tried first.
40540 The default priority is 1.
40541 .next
40542 &%weight%&: specifies a selection bias.
40543 Within a priority set servers are queried in a random fashion,
40544 weighted by this value.
40545 The default value for selection bias is 1.
40546 .endlist
40547
40548 Proxies from the list are tried according to their priority
40549 and weight settings until one responds.  The timeout for the
40550 overall connection applies to the set of proxied attempts.
40551
40552 .section Logging SECTproxyLog
40553 To log the (local) IP of a proxy in the incoming or delivery logline,
40554 add &"+proxy"& to the &%log_selector%& option.
40555 This will add a component tagged with &"PRX="& to the line.
40556
40557 . ////////////////////////////////////////////////////////////////////////////
40558 . ////////////////////////////////////////////////////////////////////////////
40559
40560 .chapter "Internationalisation" "CHAPi18n" &&&
40561          "Internationalisation""
40562 .cindex internationalisation "email address"
40563 .cindex EAI
40564 .cindex i18n
40565 .cindex utf8 "mail name handling"
40566
40567 Exim has support for Internationalised mail names.
40568 To include this it must be built with SUPPORT_I18N and the libidn library.
40569 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40570
40571 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40572 instead of it) then IDNA2008 is supported; this adds an extra library
40573 requirement, upon libidn2.
40574
40575 .section "MTA operations" SECTi18nMTA
40576 .cindex SMTPUTF8 "ESMTP option"
40577 The main configuration option &%smtputf8_advertise_hosts%& specifies
40578 a host list.  If this matches the sending host and
40579 accept_8bitmime is true (the default) then the ESMTP option
40580 SMTPUTF8 will be advertised.
40581
40582 If the sender specifies the SMTPUTF8 option on a MAIL command
40583 international handling for the message is enabled and
40584 the expansion variable &$message_smtputf8$& will have value TRUE.
40585
40586 The option &%allow_utf8_domains%& is set to true for this
40587 message. All DNS lookups are converted to a-label form
40588 whatever the setting of &%allow_utf8_domains%&
40589 when Exim is built with SUPPORT_I18N.
40590
40591 Both localparts and domain are maintained as the original
40592 UTF-8 form internally; any comparison or regular-expression use will
40593 require appropriate care.  Filenames created, eg. by
40594 the appendfile transport, will have UTF-8 names.
40595
40596 HELO names sent by the smtp transport will have any UTF-8
40597 components expanded to a-label form,
40598 and any certificate name checks will be done using the a-label
40599 form of the name.
40600
40601 .cindex log protocol
40602 .cindex SMTPUTF8 logging
40603 .cindex i18n logging
40604 Log lines and Received-by: header lines will acquire a "utf8"
40605 prefix on the protocol element, eg. utf8esmtp.
40606
40607 The following expansion operators can be used:
40608 .code
40609 ${utf8_domain_to_alabel:str}
40610 ${utf8_domain_from_alabel:str}
40611 ${utf8_localpart_to_alabel:str}
40612 ${utf8_localpart_from_alabel:str}
40613 .endd
40614
40615 .cindex utf8 "address downconversion"
40616 .cindex i18n "utf8 address downconversion"
40617 The RCPT ACL
40618 may use the following modifier:
40619 .display
40620 control = utf8_downconvert
40621 control = utf8_downconvert/<value>
40622 .endd
40623 This sets a flag requiring that addresses are converted to
40624 a-label form before smtp delivery, for use in a
40625 Message Submission Agent context.
40626 If a value is appended it may be:
40627 .display
40628 &`1  `& (default) mandatory downconversion
40629 &`0  `& no downconversion
40630 &`-1 `& if SMTPUTF8 not supported by destination host
40631 .endd
40632
40633 If mua_wrapper is set, the utf8_downconvert control
40634 is initially set to -1.
40635
40636 The smtp transport has an option &%utf8_downconvert%&.
40637 If set it must expand to one of the three values described above,
40638 and it overrides any previously set value.
40639
40640
40641 There is no explicit support for VRFY and EXPN.
40642 Configurations supporting these should inspect
40643 &$smtp_command_argument$& for an SMTPUTF8 argument.
40644
40645 There is no support for LMTP on Unix sockets.
40646 Using the "lmtp" protocol option on an smtp transport,
40647 for LMTP over TCP, should work as expected.
40648
40649 There is no support for DSN unitext handling,
40650 and no provision for converting logging from or to UTF-8.
40651
40652
40653
40654 .section "MDA operations" SECTi18nMDA
40655 To aid in constructing names suitable for IMAP folders
40656 the following expansion operator can be used:
40657 .code
40658 ${imapfolder {<string>} {<sep>} {<specials>}}
40659 .endd
40660
40661 The string is converted from the charset specified by
40662 the "headers charset" command (in a filter file)
40663 or &%headers_charset%& main configuration option (otherwise),
40664 to the
40665 modified UTF-7 encoding specified by RFC 2060,
40666 with the following exception: All occurrences of <sep>
40667 (which has to be a single character)
40668 are replaced with periods ("."), and all periods and slashes that are not
40669 <sep> and are not in the <specials> string are BASE64 encoded.
40670
40671 The third argument can be omitted, defaulting to an empty string.
40672 The second argument can be omitted, defaulting to "/".
40673
40674 This is the encoding used by Courier for Maildir names on disk, and followed
40675 by many other IMAP servers.
40676
40677 Examples:
40678 .display
40679 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40680 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40681 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40682 .endd
40683
40684 Note that the source charset setting is vital, and also that characters
40685 must be representable in UTF-16.
40686
40687
40688 . ////////////////////////////////////////////////////////////////////////////
40689 . ////////////////////////////////////////////////////////////////////////////
40690
40691 .chapter "Events" "CHAPevents" &&&
40692          "Events"
40693 .cindex events
40694
40695 The events mechanism in Exim can be used to intercept processing at a number
40696 of points.  It was originally invented to give a way to do customised logging
40697 actions (for example, to a database) but can also be used to modify some
40698 processing actions.
40699
40700 Most installations will never need to use Events.
40701 The support can be left out of a build by defining DISABLE_EVENT=yes
40702 in &_Local/Makefile_&.
40703
40704 There are two major classes of events: main and transport.
40705 The main configuration option &%event_action%& controls reception events;
40706 a transport option &%event_action%& controls delivery events.
40707
40708 Both options are a string which is expanded when the event fires.
40709 An example might look like:
40710 .cindex logging custom
40711 .code
40712 event_action = ${if eq {msg:delivery}{$event_name} \
40713 {${lookup pgsql {SELECT * FROM record_Delivery( \
40714     '${quote_pgsql:$sender_address_domain}',\
40715     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40716     '${quote_pgsql:$domain}', \
40717     '${quote_pgsql:${lc:$local_part}}', \
40718     '${quote_pgsql:$host_address}', \
40719     '${quote_pgsql:${lc:$host}}', \
40720     '${quote_pgsql:$message_exim_id}')}} \
40721 } {}}
40722 .endd
40723
40724 Events have names which correspond to the point in process at which they fire.
40725 The name is placed in the variable &$event_name$& and the event action
40726 expansion must check this, as it will be called for every possible event type.
40727
40728 The current list of events is:
40729 .display
40730 &`dane:fail              after    transport  `& per connection
40731 &`msg:complete           after    main       `& per message
40732 &`msg:delivery           after    transport  `& per recipient
40733 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40734 &`msg:rcpt:defer         after    transport  `& per recipient
40735 &`msg:host:defer         after    transport  `& per attempt
40736 &`msg:fail:delivery      after    transport  `& per recipient
40737 &`msg:fail:internal      after    main       `& per recipient
40738 &`tcp:connect            before   transport  `& per connection
40739 &`tcp:close              after    transport  `& per connection
40740 &`tls:cert               before   both       `& per certificate in verification chain
40741 &`smtp:connect           after    transport  `& per connection
40742 .endd
40743 New event types may be added in future.
40744
40745 The event name is a colon-separated list, defining the type of
40746 event in a tree of possibilities.  It may be used as a list
40747 or just matched on as a whole.  There will be no spaces in the name.
40748
40749 The second column in the table above describes whether the event fires
40750 before or after the action is associates with.  Those which fire before
40751 can be used to affect that action (more on this below).
40752
40753 The third column in the table above says what section of the configuration
40754 should define the event action.
40755
40756 An additional variable, &$event_data$&, is filled with information varying
40757 with the event type:
40758 .display
40759 &`dane:fail            `& failure reason
40760 &`msg:delivery         `& smtp confirmation message
40761 &`msg:fail:internal    `& failure reason
40762 &`msg:fail:delivery    `& smtp error message
40763 &`msg:rcpt:host:defer  `& error string
40764 &`msg:rcpt:defer       `& error string
40765 &`msg:host:defer       `& error string
40766 &`tls:cert             `& verification chain depth
40767 &`smtp:connect         `& smtp banner
40768 .endd
40769
40770 The :defer events populate one extra variable: &$event_defer_errno$&.
40771
40772 For complex operations an ACL expansion can be used in &%event_action%&
40773 however due to the multiple contexts that Exim operates in during
40774 the course of its processing:
40775 .ilist
40776 variables set in transport events will not be visible outside that
40777 transport call
40778 .next
40779 acl_m variables in a server context are lost on a new connection,
40780 and after smtp helo/ehlo/mail/starttls/rset commands
40781 .endlist
40782 Using an ACL expansion with the logwrite modifier can be
40783 a useful way of writing to the main log.
40784
40785 The expansion of the event_action option should normally
40786 return an empty string.  Should it return anything else the
40787 following will be forced:
40788 .display
40789 &`tcp:connect      `&  do not connect
40790 &`tls:cert         `&  refuse verification
40791 &`smtp:connect     `&  close connection
40792 .endd
40793 All other message types ignore the result string, and
40794 no other use is made of it.
40795
40796 For a tcp:connect event, if the connection is being made to a proxy
40797 then the address and port variables will be that of the proxy and not
40798 the target system.
40799
40800 For tls:cert events, if GnuTLS is in use this will trigger only per
40801 chain element received on the connection.
40802 For OpenSSL it will trigger for every chain element including those
40803 loaded locally.
40804
40805 . ////////////////////////////////////////////////////////////////////////////
40806 . ////////////////////////////////////////////////////////////////////////////
40807
40808 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40809          "Adding drivers or lookups"
40810 .cindex "adding drivers"
40811 .cindex "new drivers, adding"
40812 .cindex "drivers" "adding new"
40813 The following actions have to be taken in order to add a new router, transport,
40814 authenticator, or lookup type to Exim:
40815
40816 .olist
40817 Choose a name for the driver or lookup type that does not conflict with any
40818 existing name; I will use &"newdriver"& in what follows.
40819 .next
40820 Add to &_src/EDITME_& the line:
40821 .display
40822 <&'type'&>&`_NEWDRIVER=yes`&
40823 .endd
40824 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40825 code is not to be included in the binary by default, comment this line out. You
40826 should also add any relevant comments about the driver or lookup type.
40827 .next
40828 Add to &_src/config.h.defaults_& the line:
40829 .code
40830 #define <type>_NEWDRIVER
40831 .endd
40832 .next
40833 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40834 and create a table entry as is done for all the other drivers and lookup types.
40835 .next
40836 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40837 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40838 Add your &`NEWDRIVER`& to that list.
40839 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40840 simple form that most lookups have.
40841 .next
40842 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40843 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40844 driver or lookup type and add it to the definition of OBJ.
40845 .next
40846 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
40847 definition of OBJ_MACRO.  Add a set of line to do the compile also.
40848 .next
40849 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40850 &_src_&.
40851 .next
40852 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40853 as for other drivers and lookups.
40854 .endlist
40855
40856 Then all you need to do is write the code! A good way to start is to make a
40857 proforma by copying an existing module of the same type, globally changing all
40858 occurrences of the name, and cutting out most of the code. Note that any
40859 options you create must be listed in alphabetical order, because the tables are
40860 searched using a binary chop procedure.
40861
40862 There is a &_README_& file in each of the sub-directories of &_src_& describing
40863 the interface that is expected.
40864
40865
40866
40867
40868 . ////////////////////////////////////////////////////////////////////////////
40869 . ////////////////////////////////////////////////////////////////////////////
40870
40871 . /////////////////////////////////////////////////////////////////////////////
40872 . These lines are processing instructions for the Simple DocBook Processor that
40873 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40874 . PDFs than using xmlto and fop. They will be ignored by all other XML
40875 . processors.
40876 . /////////////////////////////////////////////////////////////////////////////
40877
40878 .literal xml
40879 <?sdop
40880   format="newpage"
40881   foot_right_recto="&chaptertitle;"
40882   foot_right_verso="&chaptertitle;"
40883 ?>
40884 .literal off
40885
40886 .makeindex "Options index"   "option"
40887 .makeindex "Variables index" "variable"
40888 .makeindex "Concept index"   "concept"
40889
40890
40891 . /////////////////////////////////////////////////////////////////////////////
40892 . /////////////////////////////////////////////////////////////////////////////