394cd0539b66b1b48990bc3aec76275525cf699e
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into 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.94"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
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 . use this for a concept-index entry for a header line
167 .macro chindex
168 .cindex "&'$1'& header line"
169 .cindex "header lines" $1
170 .endmacro
171 . ////////////////////////////////////////////////////////////////////////////
172
173
174 . ////////////////////////////////////////////////////////////////////////////
175 . The <bookinfo> element is removed from the XML before processing for ASCII
176 . output formats.
177 . ////////////////////////////////////////////////////////////////////////////
178
179 .literal xml
180 <bookinfo>
181 <title>Specification of the Exim Mail Transfer Agent</title>
182 <titleabbrev>The Exim MTA</titleabbrev>
183 <date>
184 .fulldate
185 </date>
186 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
187 <authorinitials>EM</authorinitials>
188 <revhistory><revision>
189 .versiondatexml
190   <authorinitials>EM</authorinitials>
191 </revision></revhistory>
192 <copyright><year>
193 .copyyear
194            </year><holder>University of Cambridge</holder></copyright>
195 </bookinfo>
196 .literal off
197
198
199 . /////////////////////////////////////////////////////////////////////////////
200 . This chunk of literal XML implements index entries of the form "x, see y" and
201 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
202 . at the top level, so we have to put the .chapter directive first.
203
204 . These do not turn up in the HTML output, unfortunately.  The PDF does get them.
205 . /////////////////////////////////////////////////////////////////////////////
206
207 .chapter "Introduction" "CHID1"
208 .literal xml
209
210 <indexterm role="variable">
211   <primary>$1, $2, etc.</primary>
212   <see><emphasis>numerical variables</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>address</primary>
216   <secondary>rewriting</secondary>
217   <see><emphasis>rewriting</emphasis></see>
218 </indexterm>
219 <indexterm role="concept">
220   <primary>Bounce Address Tag Validation</primary>
221   <see><emphasis>BATV</emphasis></see>
222 </indexterm>
223 <indexterm role="concept">
224   <primary>Client SMTP Authorization</primary>
225   <see><emphasis>CSA</emphasis></see>
226 </indexterm>
227 <indexterm role="concept">
228   <primary>CR character</primary>
229   <see><emphasis>carriage return</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>CRL</primary>
233   <see><emphasis>certificate revocation list</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>delivery</primary>
237   <secondary>failure report</secondary>
238   <see><emphasis>bounce message</emphasis></see>
239 </indexterm>
240 <indexterm role="concept">
241   <primary>dialup</primary>
242   <see><emphasis>intermittently connected hosts</emphasis></see>
243 </indexterm>
244 <indexterm role="concept">
245   <primary>exiscan</primary>
246   <see><emphasis>content scanning</emphasis></see>
247 </indexterm>
248 <indexterm role="concept">
249   <primary>failover</primary>
250   <see><emphasis>fallback</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>fallover</primary>
254   <see><emphasis>fallback</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>filter</primary>
258   <secondary>Sieve</secondary>
259   <see><emphasis>Sieve filter</emphasis></see>
260 </indexterm>
261 <indexterm role="concept">
262   <primary>ident</primary>
263   <see><emphasis>RFC 1413</emphasis></see>
264 </indexterm>
265 <indexterm role="concept">
266   <primary>LF character</primary>
267   <see><emphasis>linefeed</emphasis></see>
268 </indexterm>
269 <indexterm role="concept">
270   <primary>maximum</primary>
271   <seealso><emphasis>limit</emphasis></seealso>
272 </indexterm>
273 <indexterm role="concept">
274   <primary>monitor</primary>
275   <see><emphasis>Exim monitor</emphasis></see>
276 </indexterm>
277 <indexterm role="concept">
278   <primary>no_<emphasis>xxx</emphasis></primary>
279   <see>entry for xxx</see>
280 </indexterm>
281 <indexterm role="concept">
282   <primary>NUL</primary>
283   <see><emphasis>binary zero</emphasis></see>
284 </indexterm>
285 <indexterm role="concept">
286   <primary>passwd file</primary>
287   <see><emphasis>/etc/passwd</emphasis></see>
288 </indexterm>
289 <indexterm role="concept">
290   <primary>process id</primary>
291   <see><emphasis>pid</emphasis></see>
292 </indexterm>
293 <indexterm role="concept">
294   <primary>RBL</primary>
295   <see><emphasis>DNS list</emphasis></see>
296 </indexterm>
297 <indexterm role="concept">
298   <primary>redirection</primary>
299   <see><emphasis>address redirection</emphasis></see>
300 </indexterm>
301 <indexterm role="concept">
302   <primary>return path</primary>
303   <seealso><emphasis>envelope sender</emphasis></seealso>
304 </indexterm>
305 <indexterm role="concept">
306   <primary>scanning</primary>
307   <see><emphasis>content scanning</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>SSL</primary>
311   <see><emphasis>TLS</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>string</primary>
315   <secondary>expansion</secondary>
316   <see><emphasis>expansion</emphasis></see>
317 </indexterm>
318 <indexterm role="concept">
319   <primary>top bit</primary>
320   <see><emphasis>8-bit characters</emphasis></see>
321 </indexterm>
322 <indexterm role="concept">
323   <primary>variables</primary>
324   <see><emphasis>expansion, variables</emphasis></see>
325 </indexterm>
326 <indexterm role="concept">
327   <primary>zero, binary</primary>
328   <see><emphasis>binary zero</emphasis></see>
329 </indexterm>
330 <indexterm role="concept">
331   <primary>headers</primary>
332   <see><emphasis>header lines</emphasis></see>
333 </indexterm>
334
335 .literal off
336
337
338 . /////////////////////////////////////////////////////////////////////////////
339 . This is the real start of the first chapter. See the comment above as to why
340 . we can't have the .chapter line here.
341 . chapter "Introduction"
342 . /////////////////////////////////////////////////////////////////////////////
343
344 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
345 Unix-like operating systems. It was designed on the assumption that it would be
346 run on hosts that are permanently connected to the Internet. However, it can be
347 used on intermittently connected hosts with suitable configuration adjustments.
348
349 Configuration files currently exist for the following operating systems: AIX,
350 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
351 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
352 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
353 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
354 Some of these operating systems are no longer current and cannot easily be
355 tested, so the configuration files may no longer work in practice.
356
357 There are also configuration files for compiling Exim in the Cygwin environment
358 that can be installed on systems running Windows. However, this document does
359 not contain any information about running Exim in the Cygwin environment.
360
361 The terms and conditions for the use and distribution of Exim are contained in
362 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
363 Public Licence, a copy of which may be found in the file &_LICENCE_&.
364
365 The use, supply, or promotion of Exim for the purpose of sending bulk,
366 unsolicited electronic mail is incompatible with the basic aims of Exim,
367 which revolve around the free provision of a service that enhances the quality
368 of personal communications. The author of Exim regards indiscriminate
369 mass-mailing as an antisocial, irresponsible abuse of the Internet.
370
371 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
372 experience of running and working on the Smail 3 code, I could never have
373 contemplated starting to write a new MTA. Many of the ideas and user interfaces
374 were originally taken from Smail 3, though the actual code of Exim is entirely
375 new, and has developed far beyond the initial concept.
376
377 Many people, both in Cambridge and around the world, have contributed to the
378 development and the testing of Exim, and to porting it to various operating
379 systems. I am grateful to them all. The distribution now contains a file called
380 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
381 contributors.
382
383
384 .section "Exim documentation" "SECID1"
385 . Keep this example change bar when updating the documentation!
386
387 .new
388 .cindex "documentation"
389 This edition of the Exim specification applies to version &version() of Exim.
390 Substantive changes from the &previousversion; edition are marked in some
391 renditions of this document; this paragraph is so marked if the rendition is
392 capable of showing a change indicator.
393 .wen
394
395 This document is very much a reference manual; it is not a tutorial. The reader
396 is expected to have some familiarity with the SMTP mail transfer protocol and
397 with general Unix system administration. Although there are some discussions
398 and examples in places, the information is mostly organized in a way that makes
399 it easy to look up, rather than in a natural order for sequential reading.
400 Furthermore, this manual aims to cover every aspect of Exim in detail, including
401 a number of rarely-used, special-purpose features that are unlikely to be of
402 very wide interest.
403
404 .cindex "books about Exim"
405 An &"easier"& discussion of Exim which provides more in-depth explanatory,
406 introductory, and tutorial material can be found in a book entitled &'The Exim
407 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
408 (&url(https://www.uit.co.uk/exim-book/)).
409
410 The book also contains a chapter that gives a general introduction to SMTP and
411 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
412 with the latest release of Exim. (Note that the earlier book about Exim,
413 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
414
415 .cindex "Debian" "information sources"
416 If you are using a Debian distribution of Exim, you will find information about
417 Debian-specific features in the file
418 &_/usr/share/doc/exim4-base/README.Debian_&.
419 The command &(man update-exim.conf)& is another source of Debian-specific
420 information.
421
422 .cindex "&_doc/NewStuff_&"
423 .cindex "&_doc/ChangeLog_&"
424 .cindex "change log"
425 As Exim develops, there may be features in newer versions that have not
426 yet made it into this document, which is updated only when the most significant
427 digit of the fractional part of the version number changes. Specifications of
428 new features that are not yet in this manual are placed in the file
429 &_doc/NewStuff_& in the Exim distribution.
430
431 Some features may be classified as &"experimental"&. These may change
432 incompatibly while they are developing, or even be withdrawn. For this reason,
433 they are not documented in this manual. Information about experimental features
434 can be found in the file &_doc/experimental.txt_&.
435
436 All changes to Exim (whether new features, bug fixes, or other kinds of
437 change) are noted briefly in the file called &_doc/ChangeLog_&.
438
439 .cindex "&_doc/spec.txt_&"
440 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
441 that it can easily be searched with a text editor. Other files in the &_doc_&
442 directory are:
443
444 .table2 100pt
445 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
446 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
447 .row &_exim.8_&              "a man page of Exim's command line options"
448 .row &_experimental.txt_&    "documentation of experimental features"
449 .row &_filter.txt_&          "specification of the filter language"
450 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
451 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
452 .row &_openssl.txt_&         "installing a current OpenSSL release"
453 .endtable
454
455 The main specification and the specification of the filtering language are also
456 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
457 &<<SECTavail>>& below tells you how to get hold of these.
458
459
460
461 .section "FTP site and websites" "SECID2"
462 .cindex "website"
463 .cindex "FTP site"
464 The primary site for Exim source distributions is the &%exim.org%& FTP site,
465 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
466 website, are hosted at the University of Cambridge.
467
468 .cindex "wiki"
469 .cindex "FAQ"
470 As well as Exim distribution tar files, the Exim website contains a number of
471 differently formatted versions of the documentation. A recent addition to the
472 online information is the Exim wiki (&url(https://wiki.exim.org)),
473 which contains what used to be a separate FAQ, as well as various other
474 examples, tips, and know-how that have been contributed by Exim users.
475 The wiki site should always redirect to the correct place, which is currently
476 provided by GitHub, and is open to editing by anyone with a GitHub account.
477
478 .cindex Bugzilla
479 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
480 this to report bugs, and also to add items to the wish list. Please search
481 first to check that you are not duplicating a previous entry.
482 Please do not ask for configuration help in the bug-tracker.
483
484
485 .section "Mailing lists" "SECID3"
486 .cindex "mailing lists" "for Exim users"
487 The following Exim mailing lists exist:
488
489 .table2 140pt
490 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
491 .row &'exim-users@exim.org'&      "General discussion list"
492 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
493 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
494 .endtable
495
496 You can subscribe to these lists, change your existing subscriptions, and view
497 or search the archives via the mailing lists link on the Exim home page.
498 .cindex "Debian" "mailing list for"
499 If you are using a Debian distribution of Exim, you may wish to subscribe to
500 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
501 via this web page:
502 .display
503 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
504 .endd
505 Please ask Debian-specific questions on that list and not on the general Exim
506 lists.
507
508 .section "Bug reports" "SECID5"
509 .cindex "bug reports"
510 .cindex "reporting bugs"
511 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
512 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
513 whether some behaviour is a bug or not, the best thing to do is to post a
514 message to the &'exim-dev'& mailing list and have it discussed.
515
516
517
518 .section "Where to find the Exim distribution" "SECTavail"
519 .cindex "FTP site"
520 .cindex "HTTPS download site"
521 .cindex "distribution" "FTP site"
522 .cindex "distribution" "https site"
523 The master distribution site for the Exim distribution is
524 .display
525 &url(https://downloads.exim.org/)
526 .endd
527 The service is available over HTTPS, HTTP and FTP.
528 We encourage people to migrate to HTTPS.
529
530 The content served at &url(https://downloads.exim.org/) is identical to the
531 content served at &url(https://ftp.exim.org/pub/exim) and
532 &url(ftp://ftp.exim.org/pub/exim).
533
534 If accessing via a hostname containing &'ftp'&, then the file references that
535 follow are relative to the &_exim_& directories at these sites.
536 If accessing via the hostname &'downloads'& then the subdirectories described
537 here are top-level directories.
538
539 There are now quite a number of independent mirror sites around
540 the world. Those that I know about are listed in the file called &_Mirrors_&.
541
542 Within the top exim directory there are subdirectories called &_exim3_& (for
543 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
544 distributions), and &_Testing_& for testing versions. In the &_exim4_&
545 subdirectory, the current release can always be found in files called
546 .display
547 &_exim-n.nn.tar.xz_&
548 &_exim-n.nn.tar.gz_&
549 &_exim-n.nn.tar.bz2_&
550 .endd
551 where &'n.nn'& is the highest such version number in the directory. The three
552 files contain identical data; the only difference is the type of compression.
553 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
554 most portable to old systems.
555
556 .cindex "distribution" "signing details"
557 .cindex "distribution" "public key"
558 .cindex "public key for signed distribution"
559 The distributions will be PGP signed by an individual key of the Release
560 Coordinator.  This key will have a uid containing an email address in the
561 &'exim.org'& domain and will have signatures from other people, including
562 other Exim maintainers.  We expect that the key will be in the "strong set" of
563 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
564 PGP keys, a version of which can be found in the release directory in the file
565 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
566 such as &'pool.sks-keyservers.net'&.
567
568 At the time of the last update, releases were being made by Jeremy Harris and signed
569 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
570 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
571 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
572
573 The signatures for the tar bundles are in:
574 .display
575 &_exim-n.nn.tar.xz.asc_&
576 &_exim-n.nn.tar.gz.asc_&
577 &_exim-n.nn.tar.bz2.asc_&
578 .endd
579 For each released version, the log of changes is made available in a
580 separate file in the directory &_ChangeLogs_& so that it is possible to
581 find out what has changed without having to download the entire distribution.
582
583 .cindex "documentation" "available formats"
584 The main distribution contains ASCII versions of this specification and other
585 documentation; other formats of the documents are available in separate files
586 inside the &_exim4_& directory of the FTP site:
587 .display
588 &_exim-html-n.nn.tar.gz_&
589 &_exim-pdf-n.nn.tar.gz_&
590 &_exim-postscript-n.nn.tar.gz_&
591 &_exim-texinfo-n.nn.tar.gz_&
592 .endd
593 These tar files contain only the &_doc_& directory, not the complete
594 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
595
596
597 .section "Limitations" "SECID6"
598 .ilist
599 .cindex "limitations of Exim"
600 .cindex "bang paths" "not handled by Exim"
601 Exim is designed for use as an Internet MTA, and therefore handles addresses in
602 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
603 simple two-component bang paths can be converted by a straightforward rewriting
604 configuration. This restriction does not prevent Exim from being interfaced to
605 UUCP as a transport mechanism, provided that domain addresses are used.
606 .next
607 .cindex "domainless addresses"
608 .cindex "address" "without domain"
609 Exim insists that every address it handles has a domain attached. For incoming
610 local messages, domainless addresses are automatically qualified with a
611 configured domain value. Configuration options specify from which remote
612 systems unqualified addresses are acceptable. These are then qualified on
613 arrival.
614 .next
615 .cindex "transport" "external"
616 .cindex "external transports"
617 The only external transport mechanisms that are currently implemented are SMTP
618 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
619 transport is available, and there are facilities for writing messages to files
620 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
621 to send messages to other transport mechanisms such as UUCP, provided they can
622 handle domain-style addresses. Batched SMTP input is also catered for.
623 .next
624 Exim is not designed for storing mail for dial-in hosts. When the volumes of
625 such mail are large, it is better to get the messages &"delivered"& into files
626 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
627 other means.
628 .next
629 Although Exim does have basic facilities for scanning incoming messages, these
630 are not comprehensive enough to do full virus or spam scanning. Such operations
631 are best carried out using additional specialized software packages. If you
632 compile Exim with the content-scanning extension, straightforward interfaces to
633 a number of common scanners are provided.
634 .endlist
635
636
637 .section "Runtime configuration" "SECID7"
638 Exim's runtime configuration is held in a single text file that is divided
639 into a number of sections. The entries in this file consist of keywords and
640 values, in the style of Smail 3 configuration files. A default configuration
641 file which is suitable for simple online installations is provided in the
642 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
643
644
645 .section "Calling interface" "SECID8"
646 .cindex "Sendmail compatibility" "command line interface"
647 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
648 can be a straight replacement for &_/usr/lib/sendmail_& or
649 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
650 about Sendmail in order to run Exim. For actions other than sending messages,
651 Sendmail-compatible options also exist, but those that produce output (for
652 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
653 format. There are also some additional options that are compatible with Smail
654 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
655 documents all Exim's command line options. This information is automatically
656 made into the man page that forms part of the Exim distribution.
657
658 Control of messages in the queue can be done via certain privileged command
659 line options. There is also an optional monitor program called &'eximon'&,
660 which displays current information in an X window, and which contains a menu
661 interface to Exim's command line administration options.
662
663
664
665 .section "Terminology" "SECID9"
666 .cindex "terminology definitions"
667 .cindex "body of message" "definition of"
668 The &'body'& of a message is the actual data that the sender wants to transmit.
669 It is the last part of a message and is separated from the &'header'& (see
670 below) by a blank line.
671
672 .cindex "bounce message" "definition of"
673 When a message cannot be delivered, it is normally returned to the sender in a
674 delivery failure message or a &"non-delivery report"& (NDR). The term
675 &'bounce'& is commonly used for this action, and the error reports are often
676 called &'bounce messages'&. This is a convenient shorthand for &"delivery
677 failure error report"&. Such messages have an empty sender address in the
678 message's &'envelope'& (see below) to ensure that they cannot themselves give
679 rise to further bounce messages.
680
681 The term &'default'& appears frequently in this manual. It is used to qualify a
682 value which is used in the absence of any setting in the configuration. It may
683 also qualify an action which is taken unless a configuration setting specifies
684 otherwise.
685
686 The term &'defer'& is used when the delivery of a message to a specific
687 destination cannot immediately take place for some reason (a remote host may be
688 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
689 until a later time.
690
691 The word &'domain'& is sometimes used to mean all but the first component of a
692 host's name. It is &'not'& used in that sense here, where it normally refers to
693 the part of an email address following the @ sign.
694
695 .cindex "envelope, definition of"
696 .cindex "sender" "definition of"
697 A message in transit has an associated &'envelope'&, as well as a header and a
698 body. The envelope contains a sender address (to which bounce messages should
699 be delivered), and any number of recipient addresses. References to the
700 sender or the recipients of a message usually mean the addresses in the
701 envelope. An MTA uses these addresses for delivery, and for returning bounce
702 messages, not the addresses that appear in the header lines.
703
704 .cindex "message" "header, definition of"
705 .cindex "header section" "definition of"
706 The &'header'& of a message is the first part of a message's text, consisting
707 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
708 &'Subject:'&, etc. Long header lines can be split over several text lines by
709 indenting the continuations. The header is separated from the body by a blank
710 line.
711
712 .cindex "local part" "definition of"
713 .cindex "domain" "definition of"
714 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
715 part of an email address that precedes the @ sign. The part that follows the
716 @ sign is called the &'domain'& or &'mail domain'&.
717
718 .cindex "local delivery" "definition of"
719 .cindex "remote delivery, definition of"
720 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
721 delivery to a file or a pipe on the local host from delivery by SMTP over
722 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
723 host it is running on are &'remote'&.
724
725 .cindex "return path" "definition of"
726 &'Return path'& is another name that is used for the sender address in a
727 message's envelope.
728
729 .cindex "queue" "definition of"
730 The term &'queue'& is used to refer to the set of messages awaiting delivery
731 because this term is in widespread use in the context of MTAs. However, in
732 Exim's case, the reality is more like a pool than a queue, because there is
733 normally no ordering of waiting messages.
734
735 .cindex "queue runner" "definition of"
736 The term &'queue runner'& is used to describe a process that scans the queue
737 and attempts to deliver those messages whose retry times have come. This term
738 is used by other MTAs and also relates to the command &%runq%&, but in Exim
739 the waiting messages are normally processed in an unpredictable order.
740
741 .cindex "spool directory" "definition of"
742 The term &'spool directory'& is used for a directory in which Exim keeps the
743 messages in its queue &-- that is, those that it is in the process of
744 delivering. This should not be confused with the directory in which local
745 mailboxes are stored, which is called a &"spool directory"& by some people. In
746 the Exim documentation, &"spool"& is always used in the first sense.
747
748
749
750
751
752
753 . ////////////////////////////////////////////////////////////////////////////
754 . ////////////////////////////////////////////////////////////////////////////
755
756 .chapter "Incorporated code" "CHID2"
757 .cindex "incorporated code"
758 .cindex "regular expressions" "library"
759 .cindex "PCRE"
760 .cindex "OpenDMARC"
761 A number of pieces of external code are included in the Exim distribution.
762
763 .ilist
764 Regular expressions are supported in the main Exim program and in the
765 Exim monitor using the freely-distributable PCRE library, copyright
766 &copy; University of Cambridge. The source to PCRE is no longer shipped with
767 Exim, so you will need to use the version of PCRE shipped with your system,
768 or obtain and install the full version of the library from
769 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
770 .next
771 .cindex "cdb" "acknowledgment"
772 Support for the cdb (Constant DataBase) lookup method is provided by code
773 contributed by Nigel Metheringham of (at the time he contributed it) Planet
774 Online Ltd. The implementation is completely contained within the code of Exim.
775 It does not link against an external cdb library. The code contains the
776 following statements:
777
778 .blockquote
779 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
780
781 This program is free software; you can redistribute it and/or modify it under
782 the terms of the GNU General Public License as published by the Free Software
783 Foundation; either version 2 of the License, or (at your option) any later
784 version.
785 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
786 the spec and sample code for cdb can be obtained from
787 &url(https://cr.yp.to/cdb.html). This implementation borrows
788 some code from Dan Bernstein's implementation (which has no license
789 restrictions applied to it).
790 .endblockquote
791 .next
792 .cindex "SPA authentication"
793 .cindex "Samba project"
794 .cindex "Microsoft Secure Password Authentication"
795 Client support for Microsoft's &'Secure Password Authentication'& is provided
796 by code contributed by Marc Prud'hommeaux. Server support was contributed by
797 Tom Kistner. This includes code taken from the Samba project, which is released
798 under the Gnu GPL.
799 .next
800 .cindex "Cyrus"
801 .cindex "&'pwcheck'& daemon"
802 .cindex "&'pwauthd'& daemon"
803 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
804 by code taken from the Cyrus-SASL library and adapted by Alexander S.
805 Sabourenkov. The permission notice appears below, in accordance with the
806 conditions expressed therein.
807
808 .blockquote
809 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
810
811 Redistribution and use in source and binary forms, with or without
812 modification, are permitted provided that the following conditions
813 are met:
814
815 .olist
816 Redistributions of source code must retain the above copyright
817 notice, this list of conditions and the following disclaimer.
818 .next
819 Redistributions in binary form must reproduce the above copyright
820 notice, this list of conditions and the following disclaimer in
821 the documentation and/or other materials provided with the
822 distribution.
823 .next
824 The name &"Carnegie Mellon University"& must not be used to
825 endorse or promote products derived from this software without
826 prior written permission. For permission or any other legal
827 details, please contact
828 .display
829               Office of Technology Transfer
830               Carnegie Mellon University
831               5000 Forbes Avenue
832               Pittsburgh, PA  15213-3890
833               (412) 268-4387, fax: (412) 268-7395
834               tech-transfer@andrew.cmu.edu
835 .endd
836 .next
837 Redistributions of any form whatsoever must retain the following
838 acknowledgment:
839
840 &"This product includes software developed by Computing Services
841 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
842
843 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
844 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
845 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
846 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
847 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
848 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
849 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
850 .endlist
851 .endblockquote
852
853 .next
854 .cindex "Exim monitor" "acknowledgment"
855 .cindex "X-windows"
856 .cindex "Athena"
857 The Exim Monitor program, which is an X-Window application, includes
858 modified versions of the Athena StripChart and TextPop widgets.
859 This code is copyright by DEC and MIT, and their permission notice appears
860 below, in accordance with the conditions expressed therein.
861
862 .blockquote
863 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
864 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
865
866 All Rights Reserved
867
868 Permission to use, copy, modify, and distribute this software and its
869 documentation for any purpose and without fee is hereby granted,
870 provided that the above copyright notice appear in all copies and that
871 both that copyright notice and this permission notice appear in
872 supporting documentation, and that the names of Digital or MIT not be
873 used in advertising or publicity pertaining to distribution of the
874 software without specific, written prior permission.
875
876 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
877 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
878 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
879 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
880 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
881 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
882 SOFTWARE.
883 .endblockquote
884
885 .next
886 .cindex "opendmarc" "acknowledgment"
887 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
888 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
889 derived code are indicated in the respective source files. The full OpenDMARC
890 license is provided in the LICENSE.opendmarc file contained in the distributed
891 source code.
892
893 .next
894 Many people have contributed code fragments, some large, some small, that were
895 not covered by any specific license requirements. It is assumed that the
896 contributors are happy to see their code incorporated into Exim under the GPL.
897 .endlist
898
899
900
901
902
903 . ////////////////////////////////////////////////////////////////////////////
904 . ////////////////////////////////////////////////////////////////////////////
905
906 .chapter "How Exim receives and delivers mail" "CHID11" &&&
907          "Receiving and delivering mail"
908
909
910 .section "Overall philosophy" "SECID10"
911 .cindex "design philosophy"
912 Exim is designed to work efficiently on systems that are permanently connected
913 to the Internet and are handling a general mix of mail. In such circumstances,
914 most messages can be delivered immediately. Consequently, Exim does not
915 maintain independent queues of messages for specific domains or hosts, though
916 it does try to send several messages in a single SMTP connection after a host
917 has been down, and it also maintains per-host retry information.
918
919
920 .section "Policy control" "SECID11"
921 .cindex "policy control" "overview"
922 Policy controls are now an important feature of MTAs that are connected to the
923 Internet. Perhaps their most important job is to stop MTAs from being abused as
924 &"open relays"& by misguided individuals who send out vast amounts of
925 unsolicited junk and want to disguise its source. Exim provides flexible
926 facilities for specifying policy controls on incoming mail:
927
928 .ilist
929 .cindex "&ACL;" "introduction"
930 Exim 4 (unlike previous versions of Exim) implements policy controls on
931 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
932 series of statements that may either grant or deny access. ACLs can be used at
933 several places in the SMTP dialogue while receiving a message from a remote
934 host. However, the most common places are after each RCPT command, and at the
935 very end of the message. The sysadmin can specify conditions for accepting or
936 rejecting individual recipients or the entire message, respectively, at these
937 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
938 error code.
939 .next
940 An ACL is also available for locally generated, non-SMTP messages. In this
941 case, the only available actions are to accept or deny the entire message.
942 .next
943 When Exim is compiled with the content-scanning extension, facilities are
944 provided in the ACL mechanism for passing the message to external virus and/or
945 spam scanning software. The result of such a scan is passed back to the ACL,
946 which can then use it to decide what to do with the message.
947 .next
948 When a message has been received, either from a remote host or from the local
949 host, but before the final acknowledgment has been sent, a locally supplied C
950 function called &[local_scan()]& can be run to inspect the message and decide
951 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
952 is accepted, the list of recipients can be modified by the function.
953 .next
954 Using the &[local_scan()]& mechanism is another way of calling external scanner
955 software. The &%SA-Exim%& add-on package works this way. It does not require
956 Exim to be compiled with the content-scanning extension.
957 .next
958 After a message has been accepted, a further checking mechanism is available in
959 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
960 runs at the start of every delivery process.
961 .endlist
962
963
964
965 .section "User filters" "SECID12"
966 .cindex "filter" "introduction"
967 .cindex "Sieve filter"
968 In a conventional Exim configuration, users are able to run private filters by
969 setting up appropriate &_.forward_& files in their home directories. See
970 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
971 configuration needed to support this, and the separate document entitled
972 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
973 of filtering are available:
974
975 .ilist
976 Sieve filters are written in the standard filtering language that is defined
977 by RFC 3028.
978 .next
979 Exim filters are written in a syntax that is unique to Exim, but which is more
980 powerful than Sieve, which it pre-dates.
981 .endlist
982
983 User filters are run as part of the routing process, described below.
984
985
986
987 .section "Message identification" "SECTmessiden"
988 .cindex "message ids" "details of format"
989 .cindex "format" "of message id"
990 .cindex "id of message"
991 .cindex "base62"
992 .cindex "base36"
993 .cindex "Darwin"
994 .cindex "Cygwin"
995 Every message handled by Exim is given a &'message id'& which is sixteen
996 characters long. It is divided into three parts, separated by hyphens, for
997 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
998 normally encoding numbers in base 62. However, in the Darwin operating
999 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
1000 (avoiding the use of lower case letters) is used instead, because the message
1001 id is used to construct filenames, and the names of files in those systems are
1002 not always case-sensitive.
1003
1004 .cindex "pid (process id)" "re-use of"
1005 The detail of the contents of the message id have changed as Exim has evolved.
1006 Earlier versions relied on the operating system not re-using a process id (pid)
1007 within one second. On modern operating systems, this assumption can no longer
1008 be made, so the algorithm had to be changed. To retain backward compatibility,
1009 the format of the message id was retained, which is why the following rules are
1010 somewhat eccentric:
1011
1012 .ilist
1013 The first six characters of the message id are the time at which the message
1014 started to be received, to a granularity of one second. That is, this field
1015 contains the number of seconds since the start of the epoch (the normal Unix
1016 way of representing the date and time of day).
1017 .next
1018 After the first hyphen, the next six characters are the id of the process that
1019 received the message.
1020 .next
1021 There are two different possibilities for the final two characters:
1022 .olist
1023 .oindex "&%localhost_number%&"
1024 If &%localhost_number%& is not set, this value is the fractional part of the
1025 time of reception, normally in units of 1/2000 of a second, but for systems
1026 that must use base 36 instead of base 62 (because of case-insensitive file
1027 systems), the units are 1/1000 of a second.
1028 .next
1029 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1030 the fractional part of the time, which in this case is in units of 1/200
1031 (1/100) of a second.
1032 .endlist
1033 .endlist
1034
1035 After a message has been received, Exim waits for the clock to tick at the
1036 appropriate resolution before proceeding, so that if another message is
1037 received by the same process, or by another process with the same (re-used)
1038 pid, it is guaranteed that the time will be different. In most cases, the clock
1039 will already have ticked while the message was being received.
1040
1041
1042 .section "Receiving mail" "SECID13"
1043 .cindex "receiving mail"
1044 .cindex "message" "reception"
1045 The only way Exim can receive mail from another host is using SMTP over
1046 TCP/IP, in which case the sender and recipient addresses are transferred using
1047 SMTP commands. However, from a locally running process (such as a user's MUA),
1048 there are several possibilities:
1049
1050 .ilist
1051 If the process runs Exim with the &%-bm%& option, the message is read
1052 non-interactively (usually via a pipe), with the recipients taken from the
1053 command line, or from the body of the message if &%-t%& is also used.
1054 .next
1055 If the process runs Exim with the &%-bS%& option, the message is also read
1056 non-interactively, but in this case the recipients are listed at the start of
1057 the message in a series of SMTP RCPT commands, terminated by a DATA
1058 command. This is called &"batch SMTP"& format,
1059 but it isn't really SMTP. The SMTP commands are just another way of passing
1060 envelope addresses in a non-interactive submission.
1061 .next
1062 If the process runs Exim with the &%-bs%& option, the message is read
1063 interactively, using the SMTP protocol. A two-way pipe is normally used for
1064 passing data between the local process and the Exim process.
1065 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1066 example, the ACLs for SMTP commands are used for this form of submission.
1067 .next
1068 A local process may also make a TCP/IP call to the host's loopback address
1069 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1070 does not treat the loopback address specially. It treats all such connections
1071 in the same way as connections from other hosts.
1072 .endlist
1073
1074
1075 .cindex "message sender, constructed by Exim"
1076 .cindex "sender" "constructed by Exim"
1077 In the three cases that do not involve TCP/IP, the sender address is
1078 constructed from the login name of the user that called Exim and a default
1079 qualification domain (which can be set by the &%qualify_domain%& configuration
1080 option). For local or batch SMTP, a sender address that is passed using the
1081 SMTP MAIL command is ignored. However, the system administrator may allow
1082 certain users (&"trusted users"&) to specify a different sender addresses
1083 unconditionally, or all users to specify certain forms of different sender
1084 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1085 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1086 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1087 users to change sender addresses.
1088
1089 Messages received by either of the non-interactive mechanisms are subject to
1090 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1091 (either over TCP/IP or interacting with a local process) can be checked by a
1092 number of ACLs that operate at different times during the SMTP session. Either
1093 individual recipients or the entire message can be rejected if local policy
1094 requirements are not met. The &[local_scan()]& function (see chapter
1095 &<<CHAPlocalscan>>&) is run for all incoming messages.
1096
1097 Exim can be configured not to start a delivery process when a message is
1098 received; this can be unconditional, or depend on the number of incoming SMTP
1099 connections or the system load. In these situations, new messages wait on the
1100 queue until a queue runner process picks them up. However, in standard
1101 configurations under normal conditions, delivery is started as soon as a
1102 message is received.
1103
1104
1105
1106
1107
1108 .section "Handling an incoming message" "SECID14"
1109 .cindex "spool directory" "files that hold a message"
1110 .cindex "file" "how a message is held"
1111 When Exim accepts a message, it writes two files in its spool directory. The
1112 first contains the envelope information, the current status of the message, and
1113 the header lines, and the second contains the body of the message. The names of
1114 the two spool files consist of the message id, followed by &`-H`& for the
1115 file containing the envelope and header, and &`-D`& for the data file.
1116
1117 .cindex "spool directory" "&_input_& sub-directory"
1118 By default, all these message files are held in a single directory called
1119 &_input_& inside the general Exim spool directory. Some operating systems do
1120 not perform very well if the number of files in a directory gets large; to
1121 improve performance in such cases, the &%split_spool_directory%& option can be
1122 used. This causes Exim to split up the input files into 62 sub-directories
1123 whose names are single letters or digits. When this is done, the queue is
1124 processed one sub-directory at a time instead of all at once, which can improve
1125 overall performance even when there are not enough files in each directory to
1126 affect file system performance.
1127
1128 The envelope information consists of the address of the message's sender and
1129 the addresses of the recipients. This information is entirely separate from
1130 any addresses contained in the header lines. The status of the message includes
1131 a list of recipients who have already received the message. The format of the
1132 first spool file is described in chapter &<<CHAPspool>>&.
1133
1134 .cindex "rewriting" "addresses"
1135 Address rewriting that is specified in the rewrite section of the configuration
1136 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1137 both in the header lines and the envelope, at the time the message is accepted.
1138 If during the course of delivery additional addresses are generated (for
1139 example, via aliasing), these new addresses are rewritten as soon as they are
1140 generated. At the time a message is actually delivered (transported) further
1141 rewriting can take place; because this is a transport option, it can be
1142 different for different forms of delivery. It is also possible to specify the
1143 addition or removal of certain header lines at the time the message is
1144 delivered (see chapters &<<CHAProutergeneric>>& and
1145 &<<CHAPtransportgeneric>>&).
1146
1147
1148
1149 .section "Life of a message" "SECID15"
1150 .cindex "message" "life of"
1151 .cindex "message" "frozen"
1152 A message remains in the spool directory until it is completely delivered to
1153 its recipients or to an error address, or until it is deleted by an
1154 administrator or by the user who originally created it. In cases when delivery
1155 cannot proceed &-- for example when a message can neither be delivered to its
1156 recipients nor returned to its sender, the message is marked &"frozen"& on the
1157 spool, and no more deliveries are attempted.
1158
1159 .cindex "frozen messages" "thawing"
1160 .cindex "message" "thawing frozen"
1161 An administrator can &"thaw"& such messages when the problem has been
1162 corrected, and can also freeze individual messages by hand if necessary. In
1163 addition, an administrator can force a delivery error, causing a bounce message
1164 to be sent.
1165
1166 .oindex "&%timeout_frozen_after%&"
1167 .oindex "&%ignore_bounce_errors_after%&"
1168 There are options called &%ignore_bounce_errors_after%& and
1169 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1170 The first applies only to frozen bounces, the second to all frozen messages.
1171
1172 .cindex "message" "log file for"
1173 .cindex "log" "file for each message"
1174 While Exim is working on a message, it writes information about each delivery
1175 attempt to its main log file. This includes successful, unsuccessful, and
1176 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1177 lines are also written to a separate &'message log'& file for each message.
1178 These logs are solely for the benefit of the administrator and are normally
1179 deleted along with the spool files when processing of a message is complete.
1180 The use of individual message logs can be disabled by setting
1181 &%no_message_logs%&; this might give an improvement in performance on very busy
1182 systems.
1183
1184 .cindex "journal file"
1185 .cindex "file" "journal"
1186 All the information Exim itself needs to set up a delivery is kept in the first
1187 spool file, along with the header lines. When a successful delivery occurs, the
1188 address is immediately written at the end of a journal file, whose name is the
1189 message id followed by &`-J`&. At the end of a delivery run, if there are some
1190 addresses left to be tried again later, the first spool file (the &`-H`& file)
1191 is updated to indicate which these are, and the journal file is then deleted.
1192 Updating the spool file is done by writing a new file and renaming it, to
1193 minimize the possibility of data loss.
1194
1195 Should the system or Exim crash after a successful delivery but before
1196 the spool file has been updated, the journal is left lying around. The next
1197 time Exim attempts to deliver the message, it reads the journal file and
1198 updates the spool file before proceeding. This minimizes the chances of double
1199 deliveries caused by crashes.
1200
1201
1202
1203 .section "Processing an address for delivery" "SECTprocaddress"
1204 .cindex "drivers" "definition of"
1205 .cindex "router" "definition of"
1206 .cindex "transport" "definition of"
1207 The main delivery processing elements of Exim are called &'routers'& and
1208 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1209 number of them is provided in the source distribution, and compile-time options
1210 specify which ones are included in the binary. Runtime options specify which
1211 ones are actually used for delivering messages.
1212
1213 .cindex "drivers" "instance definition"
1214 Each driver that is specified in the runtime configuration is an &'instance'&
1215 of that particular driver type. Multiple instances are allowed; for example,
1216 you can set up several different &(smtp)& transports, each with different
1217 option values that might specify different ports or different timeouts. Each
1218 instance has its own identifying name. In what follows we will normally use the
1219 instance name when discussing one particular instance (that is, one specific
1220 configuration of the driver), and the generic driver name when discussing
1221 the driver's features in general.
1222
1223 A &'router'& is a driver that operates on an address, either determining how
1224 its delivery should happen, by assigning it to a specific transport, or
1225 converting the address into one or more new addresses (for example, via an
1226 alias file). A router may also explicitly choose to fail an address, causing it
1227 to be bounced.
1228
1229 A &'transport'& is a driver that transmits a copy of the message from Exim's
1230 spool to some destination. There are two kinds of transport: for a &'local'&
1231 transport, the destination is a file or a pipe on the local host, whereas for a
1232 &'remote'& transport the destination is some other host. A message is passed
1233 to a specific transport as a result of successful routing. If a message has
1234 several recipients, it may be passed to a number of different transports.
1235
1236 .cindex "preconditions" "definition of"
1237 An address is processed by passing it to each configured router instance in
1238 turn, subject to certain preconditions, until a router accepts the address or
1239 specifies that it should be bounced. We will describe this process in more
1240 detail shortly. First, as a simple example, we consider how each recipient
1241 address in a message is processed in a small configuration of three routers.
1242
1243 To make this a more concrete example, it is described in terms of some actual
1244 routers, but remember, this is only an example. You can configure Exim's
1245 routers in many different ways, and there may be any number of routers in a
1246 configuration.
1247
1248 The first router that is specified in a configuration is often one that handles
1249 addresses in domains that are not recognized specifically by the local host.
1250 Typically these are addresses for arbitrary domains on the Internet. A precondition
1251 is set up which looks for the special domains known to the host (for example,
1252 its own domain name), and the router is run for addresses that do &'not'&
1253 match. Typically, this is a router that looks up domains in the DNS in order to
1254 find the hosts to which this address routes. If it succeeds, the address is
1255 assigned to a suitable SMTP transport; if it does not succeed, the router is
1256 configured to fail the address.
1257
1258 The second router is reached only when the domain is recognized as one that
1259 &"belongs"& to the local host. This router does redirection &-- also known as
1260 aliasing and forwarding. When it generates one or more new addresses from the
1261 original, each of them is routed independently from the start. Otherwise, the
1262 router may cause an address to fail, or it may simply decline to handle the
1263 address, in which case the address is passed to the next router.
1264
1265 The final router in many configurations is one that checks to see if the
1266 address belongs to a local mailbox. The precondition may involve a check to
1267 see if the local part is the name of a login account, or it may look up the
1268 local part in a file or a database. If its preconditions are not met, or if
1269 the router declines, we have reached the end of the routers. When this happens,
1270 the address is bounced.
1271
1272
1273
1274 .section "Processing an address for verification" "SECID16"
1275 .cindex "router" "for verification"
1276 .cindex "verifying address" "overview"
1277 As well as being used to decide how to deliver to an address, Exim's routers
1278 are also used for &'address verification'&. Verification can be requested as
1279 one of the checks to be performed in an ACL for incoming messages, on both
1280 sender and recipient addresses, and it can be tested using the &%-bv%& and
1281 &%-bvs%& command line options.
1282
1283 When an address is being verified, the routers are run in &"verify mode"&. This
1284 does not affect the way the routers work, but it is a state that can be
1285 detected. By this means, a router can be skipped or made to behave differently
1286 when verifying. A common example is a configuration in which the first router
1287 sends all messages to a message-scanning program unless they have been
1288 previously scanned. Thus, the first router accepts all addresses without any
1289 checking, making it useless for verifying. Normally, the &%no_verify%& option
1290 would be set for such a router, causing it to be skipped in verify mode.
1291
1292
1293
1294
1295 .section "Running an individual router" "SECTrunindrou"
1296 .cindex "router" "running details"
1297 .cindex "preconditions" "checking"
1298 .cindex "router" "result of running"
1299 As explained in the example above, a number of preconditions are checked before
1300 running a router. If any are not met, the router is skipped, and the address is
1301 passed to the next router. When all the preconditions on a router &'are'& met,
1302 the router is run. What happens next depends on the outcome, which is one of
1303 the following:
1304
1305 .ilist
1306 &'accept'&: The router accepts the address, and either assigns it to a
1307 transport or generates one or more &"child"& addresses. Processing the
1308 original address ceases
1309 .oindex "&%unseen%&"
1310 unless the &%unseen%& option is set on the router. This option
1311 can be used to set up multiple deliveries with different routing (for example,
1312 for keeping archive copies of messages). When &%unseen%& is set, the address is
1313 passed to the next router. Normally, however, an &'accept'& return marks the
1314 end of routing.
1315
1316 Any child addresses generated by the router are processed independently,
1317 starting with the first router by default. It is possible to change this by
1318 setting the &%redirect_router%& option to specify which router to start at for
1319 child addresses. Unlike &%pass_router%& (see below) the router specified by
1320 &%redirect_router%& may be anywhere in the router configuration.
1321 .next
1322 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1323 requests that the address be passed to another router. By default, the address
1324 is passed to the next router, but this can be changed by setting the
1325 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1326 must be below the current router (to avoid loops).
1327 .next
1328 &'decline'&: The router declines to accept the address because it does not
1329 recognize it at all. By default, the address is passed to the next router, but
1330 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1331 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1332 &'decline'& into &'fail'&.
1333 .next
1334 &'fail'&: The router determines that the address should fail, and queues it for
1335 the generation of a bounce message. There is no further processing of the
1336 original address unless &%unseen%& is set on the router.
1337 .next
1338 &'defer'&: The router cannot handle the address at the present time. (A
1339 database may be offline, or a DNS lookup may have timed out.) No further
1340 processing of the address happens in this delivery attempt. It is tried again
1341 next time the message is considered for delivery.
1342 .next
1343 &'error'&: There is some error in the router (for example, a syntax error in
1344 its configuration). The action is as for defer.
1345 .endlist
1346
1347 If an address reaches the end of the routers without having been accepted by
1348 any of them, it is bounced as unrouteable. The default error message in this
1349 situation is &"unrouteable address"&, but you can set your own message by
1350 making use of the &%cannot_route_message%& option. This can be set for any
1351 router; the value from the last router that &"saw"& the address is used.
1352
1353 Sometimes while routing you want to fail a delivery when some conditions are
1354 met but others are not, instead of passing the address on for further routing.
1355 You can do this by having a second router that explicitly fails the delivery
1356 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1357 facility for this purpose.
1358
1359
1360 .section "Duplicate addresses" "SECID17"
1361 .cindex "case of local parts"
1362 .cindex "address duplicate, discarding"
1363 .cindex "duplicate addresses"
1364 Once routing is complete, Exim scans the addresses that are assigned to local
1365 and remote transports and discards any duplicates that it finds. During this
1366 check, local parts are treated case-sensitively. This happens only when
1367 actually delivering a message; when testing routers with &%-bt%&, all the
1368 routed addresses are shown.
1369
1370
1371
1372 .section "Router preconditions" "SECTrouprecon"
1373 .cindex "router" "preconditions, order of processing"
1374 .cindex "preconditions" "order of processing"
1375 The preconditions that are tested for each router are listed below, in the
1376 order in which they are tested. The individual configuration options are
1377 described in more detail in chapter &<<CHAProutergeneric>>&.
1378
1379 .ilist
1380 .cindex affix "router precondition"
1381 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1382 the local parts handled by the router may or must have certain prefixes and/or
1383 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1384 skipped. These conditions are tested first. When an affix is present, it is
1385 removed from the local part before further processing, including the evaluation
1386 of any other conditions.
1387 .next
1388 Routers can be designated for use only when not verifying an address, that is,
1389 only when routing it for delivery (or testing its delivery routing). If the
1390 &%verify%& option is set false, the router is skipped when Exim is verifying an
1391 address.
1392 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1393 &%verify_recipient%&, which independently control the use of the router for
1394 sender and recipient verification. You can set these options directly if
1395 you want a router to be used for only one type of verification.
1396 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1397 .next
1398 If the &%address_test%& option is set false, the router is skipped when Exim is
1399 run with the &%-bt%& option to test an address routing. This can be helpful
1400 when the first router sends all new messages to a scanner of some sort; it
1401 makes it possible to use &%-bt%& to test subsequent delivery routing without
1402 having to simulate the effect of the scanner.
1403 .next
1404 Routers can be designated for use only when verifying an address, as
1405 opposed to routing it for delivery. The &%verify_only%& option controls this.
1406 Again, cutthrough delivery counts as a verification.
1407 .next
1408 Individual routers can be explicitly skipped when running the routers to
1409 check an address given in the SMTP EXPN command (see the &%expn%& option).
1410
1411 .next
1412 If the &%domains%& option is set, the domain of the address must be in the set
1413 of domains that it defines.
1414 .new
1415 .cindex "tainted data" "de-tainting"
1416 A match verifies the variable &$domain$& (which carries tainted data)
1417 and assigns an untainted value to the &$domain_data$& variable.
1418 Such an untainted value is often needed in the transport.
1419 For specifics of the matching operation and the resulting untainted value,
1420 refer to section &<<SECTdomainlist>>&.
1421
1422 When an untainted value is wanted, use this option
1423 rather than the generic &%condition%& option.
1424 .wen
1425
1426 .next
1427 .vindex "&$local_part_prefix$&"
1428 .vindex "&$local_part_prefix_v$&"
1429 .vindex "&$local_part$&"
1430 .vindex "&$local_part_suffix$&"
1431 .vindex "&$local_part_suffix_v$&"
1432 .cindex affix "router precondition"
1433 If the &%local_parts%& option is set, the local part of the address must be in
1434 the set of local parts that it defines.
1435 .new
1436 A match verifies the variable &$local_part$& (which carries tainted data)
1437 and assigns an untainted value to the &$local_part_data$& variable.
1438 Such an untainted value is often needed in the transport.
1439 For specifics of the matching operation and the resulting untainted value,
1440 refer to section &<<SECTlocparlis>>&.
1441
1442 When an untainted value is wanted, use this option
1443 rather than the generic &%condition%& option.
1444 .wen
1445
1446 If &%local_part_prefix%& or
1447 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1448 part before this check. If you want to do precondition tests on local parts
1449 that include affixes, you can do so by using a &%condition%& option (see below)
1450 that uses the variables &$local_part$&, &$local_part_prefix$&,
1451 &$local_part_prefix_v$&, &$local_part_suffix$&
1452 and &$local_part_suffix_v$& as necessary.
1453
1454 .next
1455 .vindex "&$local_user_uid$&"
1456 .vindex "&$local_user_gid$&"
1457 .vindex "&$home$&"
1458 If the &%check_local_user%& option is set, the local part must be the name of
1459 an account on the local host. If this check succeeds, the uid and gid of the
1460 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1461 user's home directory is placed in &$home$&; these values can be used in the
1462 remaining preconditions.
1463
1464 .next
1465 If the &%router_home_directory%& option is set, it is expanded at this point,
1466 because it overrides the value of &$home$&. If this expansion were left till
1467 later, the value of &$home$& as set by &%check_local_user%& would be used in
1468 subsequent tests. Having two different values of &$home$& in the same router
1469 could lead to confusion.
1470
1471 .next
1472 If the &%senders%& option is set, the envelope sender address must be in the
1473 set of addresses that it defines.
1474
1475 .next
1476 If the &%require_files%& option is set, the existence or non-existence of
1477 specified files is tested.
1478
1479 .next
1480 .cindex "customizing" "precondition"
1481 If the &%condition%& option is set, it is evaluated and tested. This option
1482 uses an expanded string to allow you to set up your own custom preconditions.
1483 Expanded strings are described in chapter &<<CHAPexpand>>&.
1484
1485 .new
1486 Note that while using
1487 this option for address matching technically works,
1488 it does not set any de-tainted values.
1489 Such values are often needed, either for router-specific options or
1490 for transport options.
1491 Using the &%domains%& and &%local_parts%& options is usually the most
1492 convenient way to obtain them.
1493 .wen
1494 .endlist
1495
1496
1497 Note that &%require_files%& comes near the end of the list, so you cannot use
1498 it to check for the existence of a file in which to lookup up a domain, local
1499 part, or sender. However, as these options are all expanded, you can use the
1500 &%exists%& expansion condition to make such tests within each condition. The
1501 &%require_files%& option is intended for checking files that the router may be
1502 going to use internally, or which are needed by a specific transport (for
1503 example, &_.procmailrc_&).
1504
1505
1506
1507 .section "Delivery in detail" "SECID18"
1508 .cindex "delivery" "in detail"
1509 When a message is to be delivered, the sequence of events is as follows:
1510
1511 .ilist
1512 If a system-wide filter file is specified, the message is passed to it. The
1513 filter may add recipients to the message, replace the recipients, discard the
1514 message, cause a new message to be generated, or cause the message delivery to
1515 fail. The format of the system filter file is the same as for Exim user filter
1516 files, described in the separate document entitled &'Exim's interfaces to mail
1517 filtering'&.
1518 .cindex "Sieve filter" "not available for system filter"
1519 (&*Note*&: Sieve cannot be used for system filter files.)
1520
1521 Some additional features are available in system filters &-- see chapter
1522 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1523 filter only once per delivery attempt, however many recipients it has. However,
1524 if there are several delivery attempts because one or more addresses could not
1525 be immediately delivered, the system filter is run each time. The filter
1526 condition &%first_delivery%& can be used to detect the first run of the system
1527 filter.
1528 .next
1529 Each recipient address is offered to each configured router, in turn, subject to
1530 its preconditions, until one is able to handle it. If no router can handle the
1531 address, that is, if they all decline, the address is failed. Because routers
1532 can be targeted at particular domains, several locally handled domains can be
1533 processed entirely independently of each other.
1534 .next
1535 .cindex "routing" "loops in"
1536 .cindex "loop" "while routing"
1537 A router that accepts an address may assign it to a local or a remote
1538 transport. However, the transport is not run at this time. Instead, the address
1539 is placed on a list for the particular transport, which will be run later.
1540 Alternatively, the router may generate one or more new addresses (typically
1541 from alias, forward, or filter files). New addresses are fed back into this
1542 process from the top, but in order to avoid loops, a router ignores any address
1543 which has an identically-named ancestor that was processed by itself.
1544 .next
1545 When all the routing has been done, addresses that have been successfully
1546 handled are passed to their assigned transports. When local transports are
1547 doing real local deliveries, they handle only one address at a time, but if a
1548 local transport is being used as a pseudo-remote transport (for example, to
1549 collect batched SMTP messages for transmission by some other means) multiple
1550 addresses can be handled. Remote transports can always handle more than one
1551 address at a time, but can be configured not to do so, or to restrict multiple
1552 addresses to the same domain.
1553 .next
1554 Each local delivery to a file or a pipe runs in a separate process under a
1555 non-privileged uid, and these deliveries are run one at a time. Remote
1556 deliveries also run in separate processes, normally under a uid that is private
1557 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1558 run in parallel. The maximum number of simultaneous remote deliveries for any
1559 one message is set by the &%remote_max_parallel%& option.
1560 The order in which deliveries are done is not defined, except that all local
1561 deliveries happen before any remote deliveries.
1562 .next
1563 .cindex "queue runner"
1564 When it encounters a local delivery during a queue run, Exim checks its retry
1565 database to see if there has been a previous temporary delivery failure for the
1566 address before running the local transport. If there was a previous failure,
1567 Exim does not attempt a new delivery until the retry time for the address is
1568 reached. However, this happens only for delivery attempts that are part of a
1569 queue run. Local deliveries are always attempted when delivery immediately
1570 follows message reception, even if retry times are set for them. This makes for
1571 better behaviour if one particular message is causing problems (for example,
1572 causing quota overflow, or provoking an error in a filter file).
1573 .next
1574 .cindex "delivery" "retry in remote transports"
1575 Remote transports do their own retry handling, since an address may be
1576 deliverable to one of a number of hosts, each of which may have a different
1577 retry time. If there have been previous temporary failures and no host has
1578 reached its retry time, no delivery is attempted, whether in a queue run or
1579 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1580 .next
1581 If there were any permanent errors, a bounce message is returned to an
1582 appropriate address (the sender in the common case), with details of the error
1583 for each failing address. Exim can be configured to send copies of bounce
1584 messages to other addresses.
1585 .next
1586 .cindex "delivery" "deferral"
1587 If one or more addresses suffered a temporary failure, the message is left on
1588 the queue, to be tried again later. Delivery of these addresses is said to be
1589 &'deferred'&.
1590 .next
1591 When all the recipient addresses have either been delivered or bounced,
1592 handling of the message is complete. The spool files and message log are
1593 deleted, though the message log can optionally be preserved if required.
1594 .endlist
1595
1596
1597
1598
1599 .section "Retry mechanism" "SECID19"
1600 .cindex "delivery" "retry mechanism"
1601 .cindex "retry" "description of mechanism"
1602 .cindex "queue runner"
1603 Exim's mechanism for retrying messages that fail to get delivered at the first
1604 attempt is the queue runner process. You must either run an Exim daemon that
1605 uses the &%-q%& option with a time interval to start queue runners at regular
1606 intervals or use some other means (such as &'cron'&) to start them. If you do
1607 not arrange for queue runners to be run, messages that fail temporarily at the
1608 first attempt will remain in your queue forever. A queue runner process works
1609 its way through the queue, one message at a time, trying each delivery that has
1610 passed its retry time.
1611 You can run several queue runners at once.
1612
1613 Exim uses a set of configured rules to determine when next to retry the failing
1614 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1615 should give up trying to deliver to the address, at which point it generates a
1616 bounce message. If no retry rules are set for a particular host, address, and
1617 error combination, no retries are attempted, and temporary errors are treated
1618 as permanent.
1619
1620
1621
1622 .section "Temporary delivery failure" "SECID20"
1623 .cindex "delivery" "temporary failure"
1624 There are many reasons why a message may not be immediately deliverable to a
1625 particular address. Failure to connect to a remote machine (because it, or the
1626 connection to it, is down) is one of the most common. Temporary failures may be
1627 detected during routing as well as during the transport stage of delivery.
1628 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1629 is on a file system where the user is over quota. Exim can be configured to
1630 impose its own quotas on local mailboxes; where system quotas are set they will
1631 also apply.
1632
1633 If a host is unreachable for a period of time, a number of messages may be
1634 waiting for it by the time it recovers, and sending them in a single SMTP
1635 connection is clearly beneficial. Whenever a delivery to a remote host is
1636 deferred,
1637 .cindex "hints database" "deferred deliveries"
1638 Exim makes a note in its hints database, and whenever a successful
1639 SMTP delivery has happened, it looks to see if any other messages are waiting
1640 for the same host. If any are found, they are sent over the same SMTP
1641 connection, subject to a configuration limit as to the maximum number in any
1642 one connection.
1643
1644
1645
1646 .section "Permanent delivery failure" "SECID21"
1647 .cindex "delivery" "permanent failure"
1648 .cindex "bounce message" "when generated"
1649 When a message cannot be delivered to some or all of its intended recipients, a
1650 bounce message is generated. Temporary delivery failures turn into permanent
1651 errors when their timeout expires. All the addresses that fail in a given
1652 delivery attempt are listed in a single message. If the original message has
1653 many recipients, it is possible for some addresses to fail in one delivery
1654 attempt and others to fail subsequently, giving rise to more than one bounce
1655 message. The wording of bounce messages can be customized by the administrator.
1656 See chapter &<<CHAPemsgcust>>& for details.
1657
1658 .cindex "&'X-Failed-Recipients:'& header line"
1659 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1660 failed addresses, for the benefit of programs that try to analyse such messages
1661 automatically.
1662
1663 .cindex "bounce message" "recipient of"
1664 A bounce message is normally sent to the sender of the original message, as
1665 obtained from the message's envelope. For incoming SMTP messages, this is the
1666 address given in the MAIL command. However, when an address is expanded via a
1667 forward or alias file, an alternative address can be specified for delivery
1668 failures of the generated addresses. For a mailing list expansion (see section
1669 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1670 of the list.
1671
1672
1673
1674 .section "Failures to deliver bounce messages" "SECID22"
1675 .cindex "bounce message" "failure to deliver"
1676 If a bounce message (either locally generated or received from a remote host)
1677 itself suffers a permanent delivery failure, the message is left in the queue,
1678 but it is frozen, awaiting the attention of an administrator. There are options
1679 that can be used to make Exim discard such failed messages, or to keep them
1680 for only a short time (see &%timeout_frozen_after%& and
1681 &%ignore_bounce_errors_after%&).
1682
1683
1684
1685
1686
1687 . ////////////////////////////////////////////////////////////////////////////
1688 . ////////////////////////////////////////////////////////////////////////////
1689
1690 .chapter "Building and installing Exim" "CHID3"
1691 .scindex IIDbuex "building Exim"
1692
1693 .section "Unpacking" "SECID23"
1694 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1695 creates a directory with the name of the current release (for example,
1696 &_exim-&version()_&) into which the following files are placed:
1697
1698 .table2 140pt
1699 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1700 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1701   documented"
1702 .irow &_LICENCE_&         "the GNU General Public Licence"
1703 .irow &_Makefile_&        "top-level make file"
1704 .irow &_NOTICE_&          "conditions for the use of Exim"
1705 .irow &_README_&          "list of files, directories and simple build &&&
1706   instructions"
1707 .endtable
1708
1709 Other files whose names begin with &_README_& may also be present. The
1710 following subdirectories are created:
1711
1712 .table2 140pt
1713 .irow &_Local_&           "an empty directory for local configuration files"
1714 .irow &_OS_&              "OS-specific files"
1715 .irow &_doc_&             "documentation files"
1716 .irow &_exim_monitor_&    "source files for the Exim monitor"
1717 .irow &_scripts_&         "scripts used in the build process"
1718 .irow &_src_&             "remaining source files"
1719 .irow &_util_&            "independent utilities"
1720 .endtable
1721
1722 The main utility programs are contained in the &_src_& directory and are built
1723 with the Exim binary. The &_util_& directory contains a few optional scripts
1724 that may be useful to some sites.
1725
1726
1727 .section "Multiple machine architectures and operating systems" "SECID24"
1728 .cindex "building Exim" "multiple OS/architectures"
1729 The building process for Exim is arranged to make it easy to build binaries for
1730 a number of different architectures and operating systems from the same set of
1731 source files. Compilation does not take place in the &_src_& directory.
1732 Instead, a &'build directory'& is created for each architecture and operating
1733 system.
1734 .cindex "symbolic link" "to build directory"
1735 Symbolic links to the sources are installed in this directory, which is where
1736 the actual building takes place. In most cases, Exim can discover the machine
1737 architecture and operating system for itself, but the defaults can be
1738 overridden if necessary.
1739 .cindex compiler requirements
1740 .cindex compiler version
1741 A C99-capable compiler will be required for the build.
1742
1743
1744 .section "PCRE library" "SECTpcre"
1745 .cindex "PCRE library"
1746 Exim no longer has an embedded PCRE library as the vast majority of
1747 modern systems include PCRE as a system library, although you may need to
1748 install the PCRE package or the PCRE development package for your operating
1749 system. If your system has a normal PCRE installation the Exim build
1750 process will need no further configuration. If the library or the
1751 headers are in an unusual location you will need to either set the PCRE_LIBS
1752 and INCLUDE directives appropriately,
1753 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1754 If your operating system has no
1755 PCRE support then you will need to obtain and build the current PCRE
1756 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1757 More information on PCRE is available at &url(https://www.pcre.org/).
1758
1759 .section "DBM libraries" "SECTdb"
1760 .cindex "DBM libraries" "discussion of"
1761 .cindex "hints database" "DBM files used for"
1762 Even if you do not use any DBM files in your configuration, Exim still needs a
1763 DBM library in order to operate, because it uses indexed files for its hints
1764 databases. Unfortunately, there are a number of DBM libraries in existence, and
1765 different operating systems often have different ones installed.
1766
1767 .cindex "Solaris" "DBM library for"
1768 .cindex "IRIX, DBM library for"
1769 .cindex "BSD, DBM library for"
1770 .cindex "Linux, DBM library for"
1771 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1772 Linux distribution, the DBM configuration should happen automatically, and you
1773 may be able to ignore this section. Otherwise, you may have to learn more than
1774 you would like about DBM libraries from what follows.
1775
1776 .cindex "&'ndbm'& DBM library"
1777 Licensed versions of Unix normally contain a library of DBM functions operating
1778 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1779 versions of Unix seem to vary in what they contain as standard. In particular,
1780 some early versions of Linux have no default DBM library, and different
1781 distributors have chosen to bundle different libraries with their packaged
1782 versions. However, the more recent releases seem to have standardized on the
1783 Berkeley DB library.
1784
1785 Different DBM libraries have different conventions for naming the files they
1786 use. When a program opens a file called &_dbmfile_&, there are several
1787 possibilities:
1788
1789 .olist
1790 A traditional &'ndbm'& implementation, such as that supplied as part of
1791 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1792 .next
1793 .cindex "&'gdbm'& DBM library"
1794 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1795 compatibility interface it makes two different hard links to it with names
1796 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1797 filename is used unmodified.
1798 .next
1799 .cindex "Berkeley DB library"
1800 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1801 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1802 programmer exactly the same as the traditional &'ndbm'& implementation.
1803 .next
1804 If the Berkeley package is used in its native mode, it operates on a single
1805 file called &_dbmfile_&; the programmer's interface is somewhat different to
1806 the traditional &'ndbm'& interface.
1807 .next
1808 To complicate things further, there are several very different versions of the
1809 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1810 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1811 Maintenance of some of the earlier releases has ceased. All versions of
1812 Berkeley DB could be obtained from
1813 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1814 page with far newer versions listed.
1815 It is probably wise to plan to move your storage configurations away from
1816 Berkeley DB format, as today there are smaller and simpler alternatives more
1817 suited to Exim's usage model.
1818 .next
1819 .cindex "&'tdb'& DBM library"
1820 Yet another DBM library, called &'tdb'&, is available from
1821 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1822 operates on a single file.
1823 .endlist
1824
1825 .cindex "USE_DB"
1826 .cindex "DBM libraries" "configuration for building"
1827 Exim and its utilities can be compiled to use any of these interfaces. In order
1828 to use any version of the Berkeley DB package in native mode, you must set
1829 USE_DB in an appropriate configuration file (typically
1830 &_Local/Makefile_&). For example:
1831 .code
1832 USE_DB=yes
1833 .endd
1834 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1835 error is diagnosed if you set more than one of these.
1836
1837 At the lowest level, the build-time configuration sets none of these options,
1838 thereby assuming an interface of type (1). However, some operating system
1839 configuration files (for example, those for the BSD operating systems and
1840 Linux) assume type (4) by setting USE_DB as their default, and the
1841 configuration files for Cygwin set USE_GDBM. Anything you set in
1842 &_Local/Makefile_&, however, overrides these system defaults.
1843
1844 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1845 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1846 in one of these lines:
1847 .code
1848 DBMLIB = -ldb
1849 DBMLIB = -ltdb
1850 .endd
1851 Settings like that will work if the DBM library is installed in the standard
1852 place. Sometimes it is not, and the library's header file may also not be in
1853 the default path. You may need to set INCLUDE to specify where the header
1854 file is, and to specify the path to the library more fully in DBMLIB, as in
1855 this example:
1856 .code
1857 INCLUDE=-I/usr/local/include/db-4.1
1858 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1859 .endd
1860 There is further detailed discussion about the various DBM libraries in the
1861 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1862
1863
1864
1865 .section "Pre-building configuration" "SECID25"
1866 .cindex "building Exim" "pre-building configuration"
1867 .cindex "configuration for building Exim"
1868 .cindex "&_Local/Makefile_&"
1869 .cindex "&_src/EDITME_&"
1870 Before building Exim, a local configuration file that specifies options
1871 independent of any operating system has to be created with the name
1872 &_Local/Makefile_&. A template for this file is supplied as the file
1873 &_src/EDITME_&, and it contains full descriptions of all the option settings
1874 therein. These descriptions are therefore not repeated here. If you are
1875 building Exim for the first time, the simplest thing to do is to copy
1876 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1877
1878 There are three settings that you must supply, because Exim will not build
1879 without them. They are the location of the runtime configuration file
1880 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1881 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1882 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1883 a colon-separated list of filenames; Exim uses the first of them that exists.
1884
1885 There are a few other parameters that can be specified either at build time or
1886 at runtime, to enable the same binary to be used on a number of different
1887 machines. However, if the locations of Exim's spool directory and log file
1888 directory (if not within the spool directory) are fixed, it is recommended that
1889 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1890 detected early in Exim's execution (such as a malformed configuration file) can
1891 be logged.
1892
1893 .cindex "content scanning" "specifying at build time"
1894 Exim's interfaces for calling virus and spam scanning software directly from
1895 access control lists are not compiled by default. If you want to include these
1896 facilities, you need to set
1897 .code
1898 WITH_CONTENT_SCAN=yes
1899 .endd
1900 in your &_Local/Makefile_&. For details of the facilities themselves, see
1901 chapter &<<CHAPexiscan>>&.
1902
1903
1904 .cindex "&_Local/eximon.conf_&"
1905 .cindex "&_exim_monitor/EDITME_&"
1906 If you are going to build the Exim monitor, a similar configuration process is
1907 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1908 your installation and saved under the name &_Local/eximon.conf_&. If you are
1909 happy with the default settings described in &_exim_monitor/EDITME_&,
1910 &_Local/eximon.conf_& can be empty, but it must exist.
1911
1912 This is all the configuration that is needed in straightforward cases for known
1913 operating systems. However, the building process is set up so that it is easy
1914 to override options that are set by default or by operating-system-specific
1915 configuration files, for example, to change the C compiler, which
1916 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1917 do this.
1918
1919
1920
1921 .section "Support for iconv()" "SECID26"
1922 .cindex "&[iconv()]& support"
1923 .cindex "RFC 2047"
1924 The contents of header lines in messages may be encoded according to the rules
1925 described RFC 2047. This makes it possible to transmit characters that are not
1926 in the ASCII character set, and to label them as being in a particular
1927 character set. When Exim is inspecting header lines by means of the &%$h_%&
1928 mechanism, it decodes them, and translates them into a specified character set
1929 (default is set at build time). The translation is possible only if the operating system
1930 supports the &[iconv()]& function.
1931
1932 However, some of the operating systems that supply &[iconv()]& do not support
1933 very many conversions. The GNU &%libiconv%& library (available from
1934 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1935 systems to remedy this deficiency, as well as on systems that do not supply
1936 &[iconv()]& at all. After installing &%libiconv%&, you should add
1937 .code
1938 HAVE_ICONV=yes
1939 .endd
1940 to your &_Local/Makefile_& and rebuild Exim.
1941
1942
1943
1944 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1945 .cindex "TLS" "including support for TLS"
1946 .cindex "encryption" "including support for"
1947 .cindex "OpenSSL" "building Exim with"
1948 .cindex "GnuTLS" "building Exim with"
1949 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1950 command as per RFC 2487. It can also support clients that expect to
1951 start a TLS session immediately on connection to a non-standard port (see the
1952 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1953 line option).
1954
1955 If you want to build Exim with TLS support, you must first install either the
1956 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1957 implementing SSL.
1958
1959 If you do not want TLS support you should set
1960 .code
1961 DISABLE_TLS=yes
1962 .endd
1963 in &_Local/Makefile_&.
1964
1965 If OpenSSL is installed, you should set
1966 .code
1967 USE_OPENSL=yes
1968 TLS_LIBS=-lssl -lcrypto
1969 .endd
1970 in &_Local/Makefile_&. You may also need to specify the locations of the
1971 OpenSSL library and include files. For example:
1972 .code
1973 USE_OPENSSL=yes
1974 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1975 TLS_INCLUDE=-I/usr/local/openssl/include/
1976 .endd
1977 .cindex "pkg-config" "OpenSSL"
1978 If you have &'pkg-config'& available, then instead you can just use:
1979 .code
1980 USE_OPENSSL=yes
1981 USE_OPENSSL_PC=openssl
1982 .endd
1983 .cindex "USE_GNUTLS"
1984 If GnuTLS is installed, you should set
1985 .code
1986 USE_GNUTLS=yes
1987 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1988 .endd
1989 in &_Local/Makefile_&, and again you may need to specify the locations of the
1990 library and include files. For example:
1991 .code
1992 USE_GNUTLS=yes
1993 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1994 TLS_INCLUDE=-I/usr/gnu/include
1995 .endd
1996 .cindex "pkg-config" "GnuTLS"
1997 If you have &'pkg-config'& available, then instead you can just use:
1998 .code
1999 USE_GNUTLS=yes
2000 USE_GNUTLS_PC=gnutls
2001 .endd
2002
2003 You do not need to set TLS_INCLUDE if the relevant directory is already
2004 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
2005 given in chapter &<<CHAPTLS>>&.
2006
2007
2008
2009
2010 .section "Use of tcpwrappers" "SECID27"
2011
2012 .cindex "tcpwrappers, building Exim to support"
2013 .cindex "USE_TCP_WRAPPERS"
2014 .cindex "TCP_WRAPPERS_DAEMON_NAME"
2015 .cindex "tcp_wrappers_daemon_name"
2016 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
2017 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
2018 alternative to Exim's own checking facilities for installations that are
2019 already making use of &'tcpwrappers'& for other purposes. To do this, you
2020 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
2021 &_tcpd.h_& to be available at compile time, and also ensure that the library
2022 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
2023 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
2024 you might have
2025 .code
2026 USE_TCP_WRAPPERS=yes
2027 CFLAGS=-O -I/usr/local/include
2028 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
2029 .endd
2030 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
2031 files is &"exim"&. For example, the line
2032 .code
2033 exim : LOCAL  192.168.1.  .friendly.domain.example
2034 .endd
2035 in your &_/etc/hosts.allow_& file allows connections from the local host, from
2036 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
2037 All other connections are denied. The daemon name used by &'tcpwrappers'&
2038 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
2039 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
2040 configure file. Consult the &'tcpwrappers'& documentation for
2041 further details.
2042
2043
2044 .section "Including support for IPv6" "SECID28"
2045 .cindex "IPv6" "including support for"
2046 Exim contains code for use on systems that have IPv6 support. Setting
2047 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
2048 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
2049 where the IPv6 support is not fully integrated into the normal include and
2050 library files.
2051
2052 Two different types of DNS record for handling IPv6 addresses have been
2053 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2054 currently seen as the mainstream. Another record type called A6 was proposed
2055 as better than AAAA because it had more flexibility. However, it was felt to be
2056 over-complex, and its status was reduced to &"experimental"&.
2057 Exim used to
2058 have a compile option for including A6 record support but this has now been
2059 withdrawn.
2060
2061
2062
2063 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2064 .cindex "lookup modules"
2065 .cindex "dynamic modules"
2066 .cindex ".so building"
2067 On some platforms, Exim supports not compiling all lookup types directly into
2068 the main binary, instead putting some into external modules which can be loaded
2069 on demand.
2070 This permits packagers to build Exim with support for lookups with extensive
2071 library dependencies without requiring all users to install all of those
2072 dependencies.
2073 Most, but not all, lookup types can be built this way.
2074
2075 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2076 installed; Exim will only load modules from that directory, as a security
2077 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2078 for your OS; see &_OS/Makefile-Linux_& for an example.
2079 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2080 see &_src/EDITME_& for details.
2081
2082 Then, for each module to be loaded dynamically, define the relevant
2083 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2084 For example, this will build in lsearch but load sqlite and mysql support
2085 on demand:
2086 .code
2087 LOOKUP_LSEARCH=yes
2088 LOOKUP_SQLITE=2
2089 LOOKUP_MYSQL=2
2090 .endd
2091
2092
2093 .section "The building process" "SECID29"
2094 .cindex "build directory"
2095 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2096 created, run &'make'& at the top level. It determines the architecture and
2097 operating system types, and creates a build directory if one does not exist.
2098 For example, on a Sun system running Solaris 8, the directory
2099 &_build-SunOS5-5.8-sparc_& is created.
2100 .cindex "symbolic link" "to source files"
2101 Symbolic links to relevant source files are installed in the build directory.
2102
2103 If this is the first time &'make'& has been run, it calls a script that builds
2104 a make file inside the build directory, using the configuration files from the
2105 &_Local_& directory. The new make file is then passed to another instance of
2106 &'make'&. This does the real work, building a number of utility scripts, and
2107 then compiling and linking the binaries for the Exim monitor (if configured), a
2108 number of utility programs, and finally Exim itself. The command &`make
2109 makefile`& can be used to force a rebuild of the make file in the build
2110 directory, should this ever be necessary.
2111
2112 If you have problems building Exim, check for any comments there may be in the
2113 &_README_& file concerning your operating system, and also take a look at the
2114 FAQ, where some common problems are covered.
2115
2116
2117
2118 .section 'Output from &"make"&' "SECID283"
2119 The output produced by the &'make'& process for compile lines is often very
2120 unreadable, because these lines can be very long. For this reason, the normal
2121 output is suppressed by default, and instead output similar to that which
2122 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2123 each module that is being compiled or linked. However, it is still possible to
2124 get the full output, by calling &'make'& like this:
2125 .code
2126 FULLECHO='' make -e
2127 .endd
2128 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2129 command reflection in &'make'&. When you ask for the full output, it is
2130 given in addition to the short output.
2131
2132
2133
2134 .section "Overriding build-time options for Exim" "SECToverride"
2135 .cindex "build-time options, overriding"
2136 The main make file that is created at the beginning of the building process
2137 consists of the concatenation of a number of files which set configuration
2138 values, followed by a fixed set of &'make'& instructions. If a value is set
2139 more than once, the last setting overrides any previous ones. This provides a
2140 convenient way of overriding defaults. The files that are concatenated are, in
2141 order:
2142 .display
2143 &_OS/Makefile-Default_&
2144 &_OS/Makefile-_&<&'ostype'&>
2145 &_Local/Makefile_&
2146 &_Local/Makefile-_&<&'ostype'&>
2147 &_Local/Makefile-_&<&'archtype'&>
2148 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2149 &_OS/Makefile-Base_&
2150 .endd
2151 .cindex "&_Local/Makefile_&"
2152 .cindex "building Exim" "operating system type"
2153 .cindex "building Exim" "architecture type"
2154 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2155 architecture type. &_Local/Makefile_& is required to exist, and the building
2156 process fails if it is absent. The other three &_Local_& files are optional,
2157 and are often not needed.
2158
2159 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2160 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2161 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2162 values are used, thereby providing a means of forcing particular settings.
2163 Otherwise, the scripts try to get values from the &%uname%& command. If this
2164 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2165 of &'ad hoc'& transformations are then applied, to produce the standard names
2166 that Exim expects. You can run these scripts directly from the shell in order
2167 to find out what values are being used on your system.
2168
2169
2170 &_OS/Makefile-Default_& contains comments about the variables that are set
2171 therein. Some (but not all) are mentioned below. If there is something that
2172 needs changing, review the contents of this file and the contents of the make
2173 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2174 default values are.
2175
2176
2177 .cindex "building Exim" "overriding default settings"
2178 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2179 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2180 need to change the original files. Instead, you should make the changes by
2181 putting the new values in an appropriate &_Local_& file. For example,
2182 .cindex "Tru64-Unix build-time settings"
2183 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2184 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2185 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2186 called with the option &%-std1%&, to make it recognize some of the features of
2187 Standard C that Exim uses. (Most other compilers recognize Standard C by
2188 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2189 containing the lines
2190 .code
2191 CC=cc
2192 CFLAGS=-std1
2193 .endd
2194 If you are compiling for just one operating system, it may be easier to put
2195 these lines directly into &_Local/Makefile_&.
2196
2197 Keeping all your local configuration settings separate from the distributed
2198 files makes it easy to transfer them to new versions of Exim simply by copying
2199 the contents of the &_Local_& directory.
2200
2201
2202 .cindex "NIS lookup type" "including support for"
2203 .cindex "NIS+ lookup type" "including support for"
2204 .cindex "LDAP" "including support for"
2205 .cindex "lookup" "inclusion in binary"
2206 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2207 lookup, but not all systems have these components installed, so the default is
2208 not to include the relevant code in the binary. All the different kinds of file
2209 and database lookup that Exim supports are implemented as separate code modules
2210 which are included only if the relevant compile-time options are set. In the
2211 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2212 .code
2213 LOOKUP_LDAP=yes
2214 LOOKUP_NIS=yes
2215 LOOKUP_NISPLUS=yes
2216 .endd
2217 and similar settings apply to the other lookup types. They are all listed in
2218 &_src/EDITME_&. In many cases the relevant include files and interface
2219 libraries need to be installed before compiling Exim.
2220 .cindex "cdb" "including support for"
2221 However, there are some optional lookup types (such as cdb) for which
2222 the code is entirely contained within Exim, and no external include
2223 files or libraries are required. When a lookup type is not included in the
2224 binary, attempts to configure Exim to use it cause runtime configuration
2225 errors.
2226
2227 .cindex "pkg-config" "lookups"
2228 .cindex "pkg-config" "authenticators"
2229 Many systems now use a tool called &'pkg-config'& to encapsulate information
2230 about how to compile against a library; Exim has some initial support for
2231 being able to use pkg-config for lookups and authenticators.  For any given
2232 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2233 variable with the &`_PC`& suffix in the name and assign as the value the
2234 name of the package to be queried.  The results of querying via the
2235 &'pkg-config'& command will be added to the appropriate Makefile variables
2236 with &`+=`& directives, so your version of &'make'& will need to support that
2237 syntax.  For instance:
2238 .code
2239 LOOKUP_SQLITE=yes
2240 LOOKUP_SQLITE_PC=sqlite3
2241 AUTH_GSASL=yes
2242 AUTH_GSASL_PC=libgsasl
2243 AUTH_HEIMDAL_GSSAPI=yes
2244 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2245 .endd
2246
2247 .cindex "Perl" "including support for"
2248 Exim can be linked with an embedded Perl interpreter, allowing Perl
2249 subroutines to be called during string expansion. To enable this facility,
2250 .code
2251 EXIM_PERL=perl.o
2252 .endd
2253 must be defined in &_Local/Makefile_&. Details of this facility are given in
2254 chapter &<<CHAPperl>>&.
2255
2256 .cindex "X11 libraries, location of"
2257 The location of the X11 libraries is something that varies a lot between
2258 operating systems, and there may be different versions of X11 to cope
2259 with. Exim itself makes no use of X11, but if you are compiling the Exim
2260 monitor, the X11 libraries must be available.
2261 The following three variables are set in &_OS/Makefile-Default_&:
2262 .code
2263 X11=/usr/X11R6
2264 XINCLUDE=-I$(X11)/include
2265 XLFLAGS=-L$(X11)/lib
2266 .endd
2267 These are overridden in some of the operating-system configuration files. For
2268 example, in &_OS/Makefile-SunOS5_& there is
2269 .code
2270 X11=/usr/openwin
2271 XINCLUDE=-I$(X11)/include
2272 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2273 .endd
2274 If you need to override the default setting for your operating system, place a
2275 definition of all three of these variables into your
2276 &_Local/Makefile-<ostype>_& file.
2277
2278 .cindex "EXTRALIBS"
2279 If you need to add any extra libraries to the link steps, these can be put in a
2280 variable called EXTRALIBS, which appears in all the link commands, but by
2281 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2282 command for linking the main Exim binary, and not for any associated utilities.
2283
2284 .cindex "DBM libraries" "configuration for building"
2285 There is also DBMLIB, which appears in the link commands for binaries that
2286 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2287 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2288 binary, and which can be used, for example, to include additional X11
2289 libraries.
2290
2291 .cindex "configuration file" "editing"
2292 The make file copes with rebuilding Exim correctly if any of the configuration
2293 files are edited. However, if an optional configuration file is deleted, it is
2294 necessary to touch the associated non-optional file (that is,
2295 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2296
2297
2298 .section "OS-specific header files" "SECID30"
2299 .cindex "&_os.h_&"
2300 .cindex "building Exim" "OS-specific C header files"
2301 The &_OS_& directory contains a number of files with names of the form
2302 &_os.h-<ostype>_&. These are system-specific C header files that should not
2303 normally need to be changed. There is a list of macro settings that are
2304 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2305 are porting Exim to a new operating system.
2306
2307
2308
2309 .section "Overriding build-time options for the monitor" "SECID31"
2310 .cindex "building Eximon"
2311 A similar process is used for overriding things when building the Exim monitor,
2312 where the files that are involved are
2313 .display
2314 &_OS/eximon.conf-Default_&
2315 &_OS/eximon.conf-_&<&'ostype'&>
2316 &_Local/eximon.conf_&
2317 &_Local/eximon.conf-_&<&'ostype'&>
2318 &_Local/eximon.conf-_&<&'archtype'&>
2319 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2320 .endd
2321 .cindex "&_Local/eximon.conf_&"
2322 As with Exim itself, the final three files need not exist, and in this case the
2323 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2324 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2325 variables of the same name, preceded by EXIMON_. For example, setting
2326 EXIMON_LOG_DEPTH in the environment overrides the value of
2327 LOG_DEPTH at runtime.
2328 .ecindex IIDbuex
2329
2330
2331 .section "Installing Exim binaries and scripts" "SECID32"
2332 .cindex "installing Exim"
2333 .cindex "BIN_DIRECTORY"
2334 The command &`make install`& runs the &(exim_install)& script with no
2335 arguments. The script copies binaries and utility scripts into the directory
2336 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2337 .cindex "setuid" "installing Exim with"
2338 The install script copies files only if they are newer than the files they are
2339 going to replace. The Exim binary is required to be owned by root and have the
2340 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2341 install`& as root so that it can set up the Exim binary in this way. However, in
2342 some special situations (for example, if a host is doing no local deliveries)
2343 it may be possible to run Exim without making the binary setuid root (see
2344 chapter &<<CHAPsecurity>>& for details).
2345
2346 .cindex "CONFIGURE_FILE"
2347 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2348 in &_Local/Makefile_&. If this names a single file, and the file does not
2349 exist, the default configuration file &_src/configure.default_& is copied there
2350 by the installation script. If a runtime configuration file already exists, it
2351 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2352 alternative files, no default is installed.
2353
2354 .cindex "system aliases file"
2355 .cindex "&_/etc/aliases_&"
2356 One change is made to the default configuration file when it is installed: the
2357 default configuration contains a router that references a system aliases file.
2358 The path to this file is set to the value specified by
2359 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2360 If the system aliases file does not exist, the installation script creates it,
2361 and outputs a comment to the user.
2362
2363 The created file contains no aliases, but it does contain comments about the
2364 aliases a site should normally have. Mail aliases have traditionally been
2365 kept in &_/etc/aliases_&. However, some operating systems are now using
2366 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2367 Exim's configuration if necessary.
2368
2369 The default configuration uses the local host's name as the only local domain,
2370 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2371 running as the local user. System aliases and &_.forward_& files in users' home
2372 directories are supported, but no NIS or NIS+ support is configured. Domains
2373 other than the name of the local host are routed using the DNS, with delivery
2374 over SMTP.
2375
2376 It is possible to install Exim for special purposes (such as building a binary
2377 distribution) in a private part of the file system. You can do this by a
2378 command such as
2379 .code
2380 make DESTDIR=/some/directory/ install
2381 .endd
2382 This has the effect of pre-pending the specified directory to all the file
2383 paths, except the name of the system aliases file that appears in the default
2384 configuration. (If a default alias file is created, its name &'is'& modified.)
2385 For backwards compatibility, ROOT is used if DESTDIR is not set,
2386 but this usage is deprecated.
2387
2388 .cindex "installing Exim" "what is not installed"
2389 Running &'make install'& does not copy the Exim 4 conversion script
2390 &'convert4r4'&. You will probably run this only once if you are
2391 upgrading from Exim 3. None of the documentation files in the &_doc_&
2392 directory are copied, except for the info files when you have set
2393 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2394
2395 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2396 to their names. The Exim binary itself, however, is handled differently. It is
2397 installed under a name that includes the version number and the compile number,
2398 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2399 called &_exim_& to point to the binary. If you are updating a previous version
2400 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2401 from the directory (as seen by other processes).
2402
2403 .cindex "installing Exim" "testing the script"
2404 If you want to see what the &'make install'& will do before running it for
2405 real, you can pass the &%-n%& option to the installation script by this
2406 command:
2407 .code
2408 make INSTALL_ARG=-n install
2409 .endd
2410 The contents of the variable INSTALL_ARG are passed to the installation
2411 script. You do not need to be root to run this test. Alternatively, you can run
2412 the installation script directly, but this must be from within the build
2413 directory. For example, from the top-level Exim directory you could use this
2414 command:
2415 .code
2416 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2417 .endd
2418 .cindex "installing Exim" "install script options"
2419 There are two other options that can be supplied to the installation script.
2420
2421 .ilist
2422 &%-no_chown%& bypasses the call to change the owner of the installed binary
2423 to root, and the call to make it a setuid binary.
2424 .next
2425 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2426 installed binary.
2427 .endlist
2428
2429 INSTALL_ARG can be used to pass these options to the script. For example:
2430 .code
2431 make INSTALL_ARG=-no_symlink install
2432 .endd
2433 The installation script can also be given arguments specifying which files are
2434 to be copied. For example, to install just the Exim binary, and nothing else,
2435 without creating the symbolic link, you could use:
2436 .code
2437 make INSTALL_ARG='-no_symlink exim' install
2438 .endd
2439
2440
2441
2442 .section "Installing info documentation" "SECTinsinfdoc"
2443 .cindex "installing Exim" "&'info'& documentation"
2444 Not all systems use the GNU &'info'& system for documentation, and for this
2445 reason, the Texinfo source of Exim's documentation is not included in the main
2446 distribution. Instead it is available separately from the FTP site (see section
2447 &<<SECTavail>>&).
2448
2449 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2450 source of the documentation is found in the source tree, running &`make
2451 install`& automatically builds the info files and installs them.
2452
2453
2454
2455 .section "Setting up the spool directory" "SECID33"
2456 .cindex "spool directory" "creating"
2457 When it starts up, Exim tries to create its spool directory if it does not
2458 exist. The Exim uid and gid are used for the owner and group of the spool
2459 directory. Sub-directories are automatically created in the spool directory as
2460 necessary.
2461
2462
2463
2464
2465 .section "Testing" "SECID34"
2466 .cindex "testing" "installation"
2467 Having installed Exim, you can check that the runtime configuration file is
2468 syntactically valid by running the following command, which assumes that the
2469 Exim binary directory is within your PATH environment variable:
2470 .code
2471 exim -bV
2472 .endd
2473 If there are any errors in the configuration file, Exim outputs error messages.
2474 Otherwise it outputs the version number and build date,
2475 the DBM library that is being used, and information about which drivers and
2476 other optional code modules are included in the binary.
2477 Some simple routing tests can be done by using the address testing option. For
2478 example,
2479 .display
2480 &`exim -bt`& <&'local username'&>
2481 .endd
2482 should verify that it recognizes a local mailbox, and
2483 .display
2484 &`exim -bt`& <&'remote address'&>
2485 .endd
2486 a remote one. Then try getting it to deliver mail, both locally and remotely.
2487 This can be done by passing messages directly to Exim, without going through a
2488 user agent. For example:
2489 .code
2490 exim -v postmaster@your.domain.example
2491 From: user@your.domain.example
2492 To: postmaster@your.domain.example
2493 Subject: Testing Exim
2494
2495 This is a test message.
2496 ^D
2497 .endd
2498 The &%-v%& option causes Exim to output some verification of what it is doing.
2499 In this case you should see copies of three log lines, one for the message's
2500 arrival, one for its delivery, and one containing &"Completed"&.
2501
2502 .cindex "delivery" "problems with"
2503 If you encounter problems, look at Exim's log files (&'mainlog'& and
2504 &'paniclog'&) to see if there is any relevant information there. Another source
2505 of information is running Exim with debugging turned on, by specifying the
2506 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2507 with debugging turned on by a command of the form
2508 .display
2509 &`exim -d -M`& <&'exim-message-id'&>
2510 .endd
2511 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2512 produces rather a lot of output, but you can cut this down to specific areas.
2513 For example, if you use &%-d-all+route%& only the debugging information
2514 relevant to routing is included. (See the &%-d%& option in chapter
2515 &<<CHAPcommandline>>& for more details.)
2516
2517 .cindex '&"sticky"& bit'
2518 .cindex "lock files"
2519 One specific problem that has shown up on some sites is the inability to do
2520 local deliveries into a shared mailbox directory, because it does not have the
2521 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2522 writing to a mailbox file, and if it cannot create the lock file, the delivery
2523 is deferred. You can get round this either by setting the &"sticky bit"& on the
2524 directory, or by setting a specific group for local deliveries and allowing
2525 that group to create files in the directory (see the comments above the
2526 &(local_delivery)& transport in the default configuration file). Another
2527 approach is to configure Exim not to use lock files, but just to rely on
2528 &[fcntl()]& locking instead. However, you should do this only if all user
2529 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2530 see chapter &<<CHAPappendfile>>&.
2531
2532 One thing that cannot be tested on a system that is already running an MTA is
2533 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2534 &%-oX%& option can be used to run an Exim daemon that listens on some other
2535 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2536 &'exim_checkaccess'& utility can be used to check out policy controls on
2537 incoming SMTP mail.
2538
2539 Testing a new version on a system that is already running Exim can most easily
2540 be done by building a binary with a different CONFIGURE_FILE setting. From
2541 within the runtime configuration, all other file and directory names
2542 that Exim uses can be altered, in order to keep it entirely clear of the
2543 production version.
2544
2545
2546 .section "Replacing another MTA with Exim" "SECID35"
2547 .cindex "replacing another MTA"
2548 Building and installing Exim for the first time does not of itself put it in
2549 general use. The name by which the system's MTA is called by mail user agents
2550 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2551 operating system), and it is necessary to make this name point to the &'exim'&
2552 binary in order to get the user agents to pass messages to Exim. This is
2553 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2554 or &_/usr/lib/sendmail_&
2555 .cindex "symbolic link" "to &'exim'& binary"
2556 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2557 privilege and executable status from the old MTA. It is then necessary to stop
2558 and restart the mailer daemon, if one is running.
2559
2560 .cindex "FreeBSD, MTA indirection"
2561 .cindex "&_/etc/mail/mailer.conf_&"
2562 Some operating systems have introduced alternative ways of switching MTAs. For
2563 example, if you are running FreeBSD, you need to edit the file
2564 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2565 described. A typical example of the contents of this file for running Exim is
2566 as follows:
2567 .code
2568 sendmail            /usr/exim/bin/exim
2569 send-mail           /usr/exim/bin/exim
2570 mailq               /usr/exim/bin/exim -bp
2571 newaliases          /usr/bin/true
2572 .endd
2573 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2574 your Exim installation is &"live"&. Check it by sending a message from your
2575 favourite user agent.
2576
2577 You should consider what to tell your users about the change of MTA. Exim may
2578 have different capabilities to what was previously running, and there are
2579 various operational differences such as the text of messages produced by
2580 command line options and in bounce messages. If you allow your users to make
2581 use of Exim's filtering capabilities, you should make the document entitled
2582 &'Exim's interface to mail filtering'& available to them.
2583
2584
2585
2586 .section "Upgrading Exim" "SECID36"
2587 .cindex "upgrading Exim"
2588 If you are already running Exim on your host, building and installing a new
2589 version automatically makes it available to MUAs, or any other programs that
2590 call the MTA directly. However, if you are running an Exim daemon, you do need
2591 .cindex restart "on HUP signal"
2592 .cindex signal "HUP, to restart"
2593 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2594 new binary. You do not need to stop processing mail in order to install a new
2595 version of Exim. The install script does not modify an existing runtime
2596 configuration file.
2597
2598
2599
2600
2601 .section "Stopping the Exim daemon on Solaris" "SECID37"
2602 .cindex "Solaris" "stopping Exim on"
2603 The standard command for stopping the mailer daemon on Solaris is
2604 .code
2605 /etc/init.d/sendmail stop
2606 .endd
2607 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2608 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2609 for the text &"sendmail"&; this is not present because the actual program name
2610 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2611 solution is to replace the line that finds the process id with something like
2612 .code
2613 pid=`cat /var/spool/exim/exim-daemon.pid`
2614 .endd
2615 to obtain the daemon's pid directly from the file that Exim saves it in.
2616
2617 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2618 still be received from local processes, and if automatic delivery is configured
2619 (the normal case), deliveries will still occur.
2620
2621
2622
2623
2624 . ////////////////////////////////////////////////////////////////////////////
2625 . ////////////////////////////////////////////////////////////////////////////
2626
2627 .chapter "The Exim command line" "CHAPcommandline"
2628 .scindex IIDclo1 "command line" "options"
2629 .scindex IIDclo2 "options" "command line"
2630 Exim's command line takes the standard Unix form of a sequence of options,
2631 each starting with a hyphen character, followed by a number of arguments. The
2632 options are compatible with the main options of Sendmail, and there are also
2633 some additional options, some of which are compatible with Smail 3. Certain
2634 combinations of options do not make sense, and provoke an error if used.
2635 The form of the arguments depends on which options are set.
2636
2637
2638 .section "Setting options by program name" "SECID38"
2639 .cindex "&'mailq'&"
2640 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2641 were present before any other options.
2642 The &%-bp%& option requests a listing of the contents of the mail queue on the
2643 standard output.
2644 This feature is for compatibility with some systems that contain a command of
2645 that name in one of the standard libraries, symbolically linked to
2646 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2647
2648 .cindex "&'rsmtp'&"
2649 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2650 were present before any other options, for compatibility with Smail. The
2651 &%-bS%& option is used for reading in a number of messages in batched SMTP
2652 format.
2653
2654 .cindex "&'rmail'&"
2655 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2656 &%-oee%& options were present before any other options, for compatibility with
2657 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2658
2659 .cindex "&'runq'&"
2660 .cindex "queue runner"
2661 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2662 were present before any other options, for compatibility with Smail. The &%-q%&
2663 option causes a single queue runner process to be started.
2664
2665 .cindex "&'newaliases'&"
2666 .cindex "alias file" "building"
2667 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2668 If Exim is called under the name &'newaliases'& it behaves as if the option
2669 &%-bi%& were present before any other options, for compatibility with Sendmail.
2670 This option is used for rebuilding Sendmail's alias file. Exim does not have
2671 the concept of a single alias file, but can be configured to run a given
2672 command if called with the &%-bi%& option.
2673
2674
2675 .section "Trusted and admin users" "SECTtrustedadmin"
2676 Some Exim options are available only to &'trusted users'& and others are
2677 available only to &'admin users'&. In the description below, the phrases &"Exim
2678 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2679 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2680 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2681
2682 .ilist
2683 .cindex "trusted users" "definition of"
2684 .cindex "user" "trusted definition of"
2685 The trusted users are root, the Exim user, any user listed in the
2686 &%trusted_users%& configuration option, and any user whose current group or any
2687 supplementary group is one of those listed in the &%trusted_groups%&
2688 configuration option. Note that the Exim group is not automatically trusted.
2689
2690 .cindex '&"From"& line'
2691 .cindex "envelope from"
2692 .cindex "envelope sender"
2693 Trusted users are always permitted to use the &%-f%& option or a leading
2694 &"From&~"& line to specify the envelope sender of a message that is passed to
2695 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2696 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2697 users to set envelope senders.
2698
2699 .chindex From:
2700 .chindex Sender:
2701 For a trusted user, there is never any check on the contents of the &'From:'&
2702 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2703 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2704
2705 Trusted users may also specify a host name, host address, interface address,
2706 protocol name, ident value, and authentication data when submitting a message
2707 locally. Thus, they are able to insert messages into Exim's queue locally that
2708 have the characteristics of messages received from a remote host. Untrusted
2709 users may in some circumstances use &%-f%&, but can never set the other values
2710 that are available to trusted users.
2711 .next
2712 .cindex "user" "admin definition of"
2713 .cindex "admin user" "definition of"
2714 The admin users are root, the Exim user, and any user that is a member of the
2715 Exim group or of any group listed in the &%admin_groups%& configuration option.
2716 The current group does not have to be one of these groups.
2717
2718 Admin users are permitted to list the queue, and to carry out certain
2719 operations on messages, for example, to force delivery failures. It is also
2720 necessary to be an admin user in order to see the full information provided by
2721 the Exim monitor, and full debugging output.
2722
2723 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2724 Exim to attempt delivery of messages on its queue is restricted to admin users.
2725 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2726 option false (that is, specifying &%no_prod_requires_admin%&).
2727
2728 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2729 is restricted to admin users unless &%queue_list_requires_admin%& is set
2730 false.
2731 .endlist
2732
2733
2734 &*Warning*&: If you configure your system so that admin users are able to
2735 edit Exim's configuration file, you are giving those users an easy way of
2736 getting root. There is further discussion of this issue at the start of chapter
2737 &<<CHAPconf>>&.
2738
2739
2740
2741
2742 .section "Command line options" "SECID39"
2743 Exim's command line options are described in alphabetical order below. If none
2744 of the options that specifies a specific action (such as starting the daemon or
2745 a queue runner, or testing an address, or receiving a message in a specific
2746 format, or listing the queue) are present, and there is at least one argument
2747 on the command line, &%-bm%& (accept a local message on the standard input,
2748 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2749 outputs a brief message about itself and exits.
2750
2751 . ////////////////////////////////////////////////////////////////////////////
2752 . Insert a stylized XML comment here, to identify the start of the command line
2753 . options. This is for the benefit of the Perl script that automatically
2754 . creates a man page for the options.
2755 . ////////////////////////////////////////////////////////////////////////////
2756
2757 .literal xml
2758 <!-- === Start of command line options === -->
2759 .literal off
2760
2761
2762 .vlist
2763 .vitem &%--%&
2764 .oindex "--"
2765 .cindex "options" "command line; terminating"
2766 This is a pseudo-option whose only purpose is to terminate the options and
2767 therefore to cause subsequent command line items to be treated as arguments
2768 rather than options, even if they begin with hyphens.
2769
2770 .vitem &%--help%&
2771 .oindex "&%--help%&"
2772 This option causes Exim to output a few sentences stating what it is.
2773 The same output is generated if the Exim binary is called with no options and
2774 no arguments.
2775
2776 .vitem &%--version%&
2777 .oindex "&%--version%&"
2778 This option is an alias for &%-bV%& and causes version information to be
2779 displayed.
2780
2781 .vitem &%-Ac%& &&&
2782        &%-Am%&
2783 .oindex "&%-Ac%&"
2784 .oindex "&%-Am%&"
2785 These options are used by Sendmail for selecting configuration files and are
2786 ignored by Exim.
2787
2788 .vitem &%-B%&<&'type'&>
2789 .oindex "&%-B%&"
2790 .cindex "8-bit characters"
2791 .cindex "Sendmail compatibility" "8-bit characters"
2792 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2793 clean; it ignores this option.
2794
2795 .vitem &%-bd%&
2796 .oindex "&%-bd%&"
2797 .cindex "daemon"
2798 .cindex "SMTP" "listener"
2799 .cindex "queue runner"
2800 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2801 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2802 that the daemon should also initiate periodic queue runs.
2803
2804 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2805 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2806 disconnect from the controlling terminal. When running this way, it can be
2807 stopped by pressing ctrl-C.
2808
2809 By default, Exim listens for incoming connections to the standard SMTP port on
2810 all the host's running interfaces. However, it is possible to listen on other
2811 ports, on multiple ports, and only on specific interfaces. Chapter
2812 &<<CHAPinterfaces>>& contains a description of the options that control this.
2813
2814 When a listening daemon
2815 .cindex "daemon" "process id (pid)"
2816 .cindex "pid (process id)" "of daemon"
2817 is started without the use of &%-oX%& (that is, without overriding the normal
2818 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2819 in Exim's spool directory. This location can be overridden by setting
2820 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2821 running as root.
2822
2823 When &%-oX%& is used on the command line to start a listening daemon, the
2824 process id is not written to the normal pid file path. However, &%-oP%& can be
2825 used to specify a path on the command line if a pid file is required.
2826
2827 The SIGHUP signal
2828 .cindex "SIGHUP"
2829 .cindex restart "on HUP signal"
2830 .cindex signal "HUP, to restart"
2831 .cindex "daemon" "restarting"
2832 .cindex signal "to reload configuration"
2833 .cindex daemon "reload configuration"
2834 .cindex reload configuration
2835 can be used to cause the daemon to re-execute itself. This should be done
2836 whenever Exim's configuration file, or any file that is incorporated into it by
2837 means of the &%.include%& facility, is changed, and also whenever a new version
2838 of Exim is installed. It is not necessary to do this when other files that are
2839 referenced from the configuration (for example, alias files) are changed,
2840 because these are reread each time they are used.
2841
2842 .vitem &%-bdf%&
2843 .oindex "&%-bdf%&"
2844 This option has the same effect as &%-bd%& except that it never disconnects
2845 from the controlling terminal, even when no debugging is specified.
2846
2847 .vitem &%-be%&
2848 .oindex "&%-be%&"
2849 .cindex "testing" "string expansion"
2850 .cindex "expansion" "testing"
2851 Run Exim in expansion testing mode. Exim discards its root privilege, to
2852 prevent ordinary users from using this mode to read otherwise inaccessible
2853 files. If no arguments are given, Exim runs interactively, prompting for lines
2854 of data. Otherwise, it processes each argument in turn.
2855
2856 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2857 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2858 used without command line arguments. If successful, it uses the &[readline()]&
2859 function, which provides extensive line-editing facilities, for reading the
2860 test data. A line history is supported.
2861
2862 Long expansion expressions can be split over several lines by using backslash
2863 continuations. As in Exim's runtime configuration, white space at the start of
2864 continuation lines is ignored. Each argument or data line is passed through the
2865 string expansion mechanism, and the result is output. Variable values from the
2866 configuration file (for example, &$qualify_domain$&) are available, but no
2867 message-specific values (such as &$message_exim_id$&) are set, because no message
2868 is being processed (but see &%-bem%& and &%-Mset%&).
2869
2870 &*Note*&: If you use this mechanism to test lookups, and you change the data
2871 files or databases you are using, you must exit and restart Exim before trying
2872 the same lookup again. Otherwise, because each Exim process caches the results
2873 of lookups, you will just get the same result as before.
2874
2875 Macro processing is done on lines before string-expansion: new macros can be
2876 defined and macros will be expanded.
2877 Because macros in the config file are often used for secrets, those are only
2878 available to admin users.
2879
2880 .vitem &%-bem%&&~<&'filename'&>
2881 .oindex "&%-bem%&"
2882 .cindex "testing" "string expansion"
2883 .cindex "expansion" "testing"
2884 This option operates like &%-be%& except that it must be followed by the name
2885 of a file. For example:
2886 .code
2887 exim -bem /tmp/testmessage
2888 .endd
2889 The file is read as a message (as if receiving a locally-submitted non-SMTP
2890 message) before any of the test expansions are done. Thus, message-specific
2891 variables such as &$message_size$& and &$header_from:$& are available. However,
2892 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2893 recipients are read from the headers in the normal way, and are shown in the
2894 &$recipients$& variable. Note that recipients cannot be given on the command
2895 line, because further arguments are taken as strings to expand (just like
2896 &%-be%&).
2897
2898 .vitem &%-bF%&&~<&'filename'&>
2899 .oindex "&%-bF%&"
2900 .cindex "system filter" "testing"
2901 .cindex "testing" "system filter"
2902 This option is the same as &%-bf%& except that it assumes that the filter being
2903 tested is a system filter. The additional commands that are available only in
2904 system filters are recognized.
2905
2906 .vitem &%-bf%&&~<&'filename'&>
2907 .oindex "&%-bf%&"
2908 .cindex "filter" "testing"
2909 .cindex "testing" "filter file"
2910 .cindex "forward file" "testing"
2911 .cindex "testing" "forward file"
2912 .cindex "Sieve filter" "testing"
2913 This option runs Exim in user filter testing mode; the file is the filter file
2914 to be tested, and a test message must be supplied on the standard input. If
2915 there are no message-dependent tests in the filter, an empty file can be
2916 supplied.
2917
2918 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2919 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2920 filter and a user filter in the same run. For example:
2921 .code
2922 exim -bF /system/filter -bf /user/filter </test/message
2923 .endd
2924 This is helpful when the system filter adds header lines or sets filter
2925 variables that are used by the user filter.
2926
2927 If the test filter file does not begin with one of the special lines
2928 .code
2929 # Exim filter
2930 # Sieve filter
2931 .endd
2932 it is taken to be a normal &_.forward_& file, and is tested for validity under
2933 that interpretation. See sections &<<SECTitenonfilred>>& to
2934 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2935 redirection lists.
2936
2937 The result of an Exim command that uses &%-bf%&, provided no errors are
2938 detected, is a list of the actions that Exim would try to take if presented
2939 with the message for real. More details of filter testing are given in the
2940 separate document entitled &'Exim's interfaces to mail filtering'&.
2941
2942 When testing a filter file,
2943 .cindex "&""From""& line"
2944 .cindex "envelope from"
2945 .cindex "envelope sender"
2946 .oindex "&%-f%&" "for filter testing"
2947 the envelope sender can be set by the &%-f%& option,
2948 or by a &"From&~"& line at the start of the test message. Various parameters
2949 that would normally be taken from the envelope recipient address of the message
2950 can be set by means of additional command line options (see the next four
2951 options).
2952
2953 .vitem &%-bfd%&&~<&'domain'&>
2954 .oindex "&%-bfd%&"
2955 .vindex "&$qualify_domain$&"
2956 This sets the domain of the recipient address when a filter file is being
2957 tested by means of the &%-bf%& option. The default is the value of
2958 &$qualify_domain$&.
2959
2960 .vitem &%-bfl%&&~<&'local&~part'&>
2961 .oindex "&%-bfl%&"
2962 This sets the local part of the recipient address when a filter file is being
2963 tested by means of the &%-bf%& option. The default is the username of the
2964 process that calls Exim. A local part should be specified with any prefix or
2965 suffix stripped, because that is how it appears to the filter when a message is
2966 actually being delivered.
2967
2968 .vitem &%-bfp%&&~<&'prefix'&>
2969 .oindex "&%-bfp%&"
2970 .cindex affix "filter testing"
2971 This sets the prefix of the local part of the recipient address when a filter
2972 file is being tested by means of the &%-bf%& option. The default is an empty
2973 prefix.
2974
2975 .vitem &%-bfs%&&~<&'suffix'&>
2976 .oindex "&%-bfs%&"
2977 .cindex affix "filter testing"
2978 This sets the suffix of the local part of the recipient address when a filter
2979 file is being tested by means of the &%-bf%& option. The default is an empty
2980 suffix.
2981
2982 .vitem &%-bh%&&~<&'IP&~address'&>
2983 .oindex "&%-bh%&"
2984 .cindex "testing" "incoming SMTP"
2985 .cindex "SMTP" "testing incoming"
2986 .cindex "testing" "relay control"
2987 .cindex "relaying" "testing configuration"
2988 .cindex "policy control" "testing"
2989 .cindex "debugging" "&%-bh%& option"
2990 This option runs a fake SMTP session as if from the given IP address, using the
2991 standard input and output. The IP address may include a port number at the end,
2992 after a full stop. For example:
2993 .code
2994 exim -bh 10.9.8.7.1234
2995 exim -bh fe80::a00:20ff:fe86:a061.5678
2996 .endd
2997 When an IPv6 address is given, it is converted into canonical form. In the case
2998 of the second example above, the value of &$sender_host_address$& after
2999 conversion to the canonical form is
3000 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
3001
3002 Comments as to what is going on are written to the standard error file. These
3003 include lines beginning with &"LOG"& for anything that would have been logged.
3004 This facility is provided for testing configuration options for incoming
3005 messages, to make sure they implement the required policy. For example, you can
3006 test your relay controls using &%-bh%&.
3007
3008 &*Warning 1*&:
3009 .cindex "RFC 1413"
3010 You can test features of the configuration that rely on ident (RFC 1413)
3011 information by using the &%-oMt%& option. However, Exim cannot actually perform
3012 an ident callout when testing using &%-bh%& because there is no incoming SMTP
3013 connection.
3014
3015 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
3016 are also skipped when testing using &%-bh%&. If you want these callouts to
3017 occur, use &%-bhc%& instead.
3018
3019 Messages supplied during the testing session are discarded, and nothing is
3020 written to any of the real log files. There may be pauses when DNS (and other)
3021 lookups are taking place, and of course these may time out. The &%-oMi%& option
3022 can be used to specify a specific IP interface and port if this is important,
3023 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
3024 session were authenticated.
3025
3026 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
3027 output just states whether a given recipient address from a given host is
3028 acceptable or not. See section &<<SECTcheckaccess>>&.
3029
3030 Features such as authentication and encryption, where the client input is not
3031 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
3032 specialized SMTP test program such as
3033 &url(https://www.jetmore.org/john/code/swaks/,swaks).
3034
3035 .vitem &%-bhc%&&~<&'IP&~address'&>
3036 .oindex "&%-bhc%&"
3037 This option operates in the same way as &%-bh%&, except that address
3038 verification callouts are performed if required. This includes consulting and
3039 updating the callout cache database.
3040
3041 .vitem &%-bi%&
3042 .oindex "&%-bi%&"
3043 .cindex "alias file" "building"
3044 .cindex "building alias file"
3045 .cindex "Sendmail compatibility" "&%-bi%& option"
3046 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
3047 Exim does not have the concept of a single alias file, and so it cannot mimic
3048 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
3049 tend to appear in various scripts such as NIS make files, so the option must be
3050 recognized.
3051
3052 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3053 configuration option is run, under the uid and gid of the caller of Exim. If
3054 the &%-oA%& option is used, its value is passed to the command as an argument.
3055 The command set by &%bi_command%& may not contain arguments. The command can
3056 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3057 if this is required. If the &%bi_command%& option is not set, calling Exim with
3058 &%-bi%& is a no-op.
3059
3060 . // Keep :help first, then the rest in alphabetical order
3061 .vitem &%-bI:help%&
3062 .oindex "&%-bI:help%&"
3063 .cindex "querying exim information"
3064 We shall provide various options starting &`-bI:`& for querying Exim for
3065 information.  The output of many of these will be intended for machine
3066 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3067 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3068 options shall cause Exim to exit after producing the requested output.
3069
3070 .vitem &%-bI:dscp%&
3071 .oindex "&%-bI:dscp%&"
3072 .cindex "DSCP" "values"
3073 This option causes Exim to emit an alphabetically sorted list of all
3074 recognised DSCP names.
3075
3076 .vitem &%-bI:sieve%&
3077 .oindex "&%-bI:sieve%&"
3078 .cindex "Sieve filter" "capabilities"
3079 This option causes Exim to emit an alphabetically sorted list of all supported
3080 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3081 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3082 &`SIEVE`& capability response line.  As the precise list may depend upon
3083 compile-time build options, which this option will adapt to, this is the only
3084 way to guarantee a correct response.
3085
3086 .vitem &%-bm%&
3087 .oindex "&%-bm%&"
3088 .cindex "local message reception"
3089 This option runs an Exim receiving process that accepts an incoming,
3090 locally-generated message on the standard input. The recipients are given as the
3091 command arguments (except when &%-t%& is also present &-- see below). Each
3092 argument can be a comma-separated list of RFC 2822 addresses. This is the
3093 default option for selecting the overall action of an Exim call; it is assumed
3094 if no other conflicting option is present.
3095
3096 If any addresses in the message are unqualified (have no domain), they are
3097 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3098 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3099 suppressing this for special cases.
3100
3101 Policy checks on the contents of local messages can be enforced by means of
3102 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3103
3104 .cindex "return code" "for &%-bm%&"
3105 The return code is zero if the message is successfully accepted. Otherwise, the
3106 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3107
3108 The format
3109 .cindex "message" "format"
3110 .cindex "format" "message"
3111 .cindex "&""From""& line"
3112 .cindex "UUCP" "&""From""& line"
3113 .cindex "Sendmail compatibility" "&""From""& line"
3114 of the message must be as defined in RFC 2822, except that, for
3115 compatibility with Sendmail and Smail, a line in one of the forms
3116 .code
3117 From sender Fri Jan  5 12:55 GMT 1997
3118 From sender Fri, 5 Jan 97 12:55:01
3119 .endd
3120 (with the weekday optional, and possibly with additional text after the date)
3121 is permitted to appear at the start of the message. There appears to be no
3122 authoritative specification of the format of this line. Exim recognizes it by
3123 matching against the regular expression defined by the &%uucp_from_pattern%&
3124 option, which can be changed if necessary.
3125
3126 .oindex "&%-f%&" "overriding &""From""& line"
3127 The specified sender is treated as if it were given as the argument to the
3128 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3129 preference to the address taken from the message. The caller of Exim must be a
3130 trusted user for the sender of a message to be set in this way.
3131
3132 .vitem &%-bmalware%&&~<&'filename'&>
3133 .oindex "&%-bmalware%&"
3134 .cindex "testing", "malware"
3135 .cindex "malware scan test"
3136 This debugging option causes Exim to scan the given file or directory
3137 (depending on the used scanner interface),
3138 using the malware scanning framework.  The option of &%av_scanner%& influences
3139 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3140 the expansion should have defaults which apply to this invocation.  ACLs are
3141 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3142 will never be populated and &%-bmalware%& will fail.
3143
3144 Exim will have changed working directory before resolving the filename, so
3145 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3146 user when it tries to open the file, rather than as the invoking user.
3147 This option requires admin privileges.
3148
3149 The &%-bmalware%& option will not be extended to be more generally useful,
3150 there are better tools for file-scanning.  This option exists to help
3151 administrators verify their Exim and AV scanner configuration.
3152
3153 .vitem &%-bnq%&
3154 .oindex "&%-bnq%&"
3155 .cindex "address qualification, suppressing"
3156 By default, Exim automatically qualifies unqualified addresses (those
3157 without domains) that appear in messages that are submitted locally (that
3158 is, not over TCP/IP). This qualification applies both to addresses in
3159 envelopes, and addresses in header lines. Sender addresses are qualified using
3160 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3161 defaults to the value of &%qualify_domain%&).
3162
3163 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3164 being used to re-submit messages that originally came from remote hosts after
3165 content scanning, you probably do not want to qualify unqualified addresses in
3166 header lines. (Such lines will be present only if you have not enabled a header
3167 syntax check in the appropriate ACL.)
3168
3169 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3170 messages that originate on the local host. When this is used, unqualified
3171 addresses in the envelope provoke errors (causing message rejection) and
3172 unqualified addresses in header lines are left alone.
3173
3174
3175 .vitem &%-bP%&
3176 .oindex "&%-bP%&"
3177 .cindex "configuration options" "extracting"
3178 .cindex "options" "configuration &-- extracting"
3179 If this option is given with no arguments, it causes the values of all Exim's
3180 main configuration options to be written to the standard output. The values
3181 of one or more specific options can be requested by giving their names as
3182 arguments, for example:
3183 .code
3184 exim -bP qualify_domain hold_domains
3185 .endd
3186 .cindex "hiding configuration option values"
3187 .cindex "configuration options" "hiding value of"
3188 .cindex "options" "hiding value of"
3189 However, any option setting that is preceded by the word &"hide"& in the
3190 configuration file is not shown in full, except to an admin user. For other
3191 users, the output is as in this example:
3192 .code
3193 mysql_servers = <value not displayable>
3194 .endd
3195 If &%config%& is given as an argument, the config is
3196 output, as it was parsed, any include file resolved, any comment removed.
3197
3198 If &%config_file%& is given as an argument, the name of the runtime
3199 configuration file is output. (&%configure_file%& works too, for
3200 backward compatibility.)
3201 If a list of configuration files was supplied, the value that is output here
3202 is the name of the file that was actually used.
3203
3204 .cindex "options" "hiding name of"
3205 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3206 name will not be output.
3207
3208 .cindex "daemon" "process id (pid)"
3209 .cindex "pid (process id)" "of daemon"
3210 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3211 directories where log files and daemon pid files are written are output,
3212 respectively. If these values are unset, log files are written in a
3213 sub-directory of the spool directory called &%log%&, and the pid file is
3214 written directly into the spool directory.
3215
3216 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3217 .code
3218 exim -bP +local_domains
3219 .endd
3220 it searches for a matching named list of any type (domain, host, address, or
3221 local part) and outputs what it finds.
3222
3223 .cindex "options" "router &-- extracting"
3224 .cindex "options" "transport &-- extracting"
3225 .cindex "options" "authenticator &-- extracting"
3226 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3227 followed by the name of an appropriate driver instance, the option settings for
3228 that driver are output. For example:
3229 .code
3230 exim -bP transport local_delivery
3231 .endd
3232 The generic driver options are output first, followed by the driver's private
3233 options. A list of the names of drivers of a particular type can be obtained by
3234 using one of the words &%router_list%&, &%transport_list%&, or
3235 &%authenticator_list%&, and a complete list of all drivers with their option
3236 settings can be obtained by using &%routers%&, &%transports%&, or
3237 &%authenticators%&.
3238
3239 .cindex "environment"
3240 If &%environment%& is given as an argument, the set of environment
3241 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3242 variables.
3243
3244 .cindex "options" "macro &-- extracting"
3245 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3246 are available, similarly to the drivers.  Because macros are sometimes used
3247 for storing passwords, this option is restricted.
3248 The output format is one item per line.
3249 For the "-bP macro <name>" form, if no such macro is found
3250 the exit status will be nonzero.
3251
3252 .vitem &%-bp%&
3253 .oindex "&%-bp%&"
3254 .cindex "queue" "listing messages in"
3255 .cindex "listing" "messages in the queue"
3256 This option requests a listing of the contents of the mail queue on the
3257 standard output. If the &%-bp%& option is followed by a list of message ids,
3258 just those messages are listed. By default, this option can be used only by an
3259 admin user. However, the &%queue_list_requires_admin%& option can be set false
3260 to allow any user to see the queue.
3261
3262 Each message in the queue is displayed as in the following example:
3263 .code
3264 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3265           red.king@looking-glass.fict.example
3266           <other addresses>
3267 .endd
3268 .cindex "message" "size in queue listing"
3269 .cindex "size" "of message"
3270 The first line contains the length of time the message has been in the queue
3271 (in this case 25 minutes), the size of the message (2.9K), the unique local
3272 identifier for the message, and the message sender, as contained in the
3273 envelope. For bounce messages, the sender address is empty, and appears as
3274 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3275 the default sender address, the user's login name is shown in parentheses
3276 before the sender address.
3277
3278 .cindex "frozen messages" "in queue listing"
3279 If the message is frozen (attempts to deliver it are suspended) then the text
3280 &"*** frozen ***"& is displayed at the end of this line.
3281
3282 The recipients of the message (taken from the envelope, not the headers) are
3283 displayed on subsequent lines. Those addresses to which the message has already
3284 been delivered are marked with the letter D. If an original address gets
3285 expanded into several addresses via an alias or forward file, the original is
3286 displayed with a D only when deliveries for all of its child addresses are
3287 complete.
3288
3289
3290 .vitem &%-bpa%&
3291 .oindex "&%-bpa%&"
3292 This option operates like &%-bp%&, but in addition it shows delivered addresses
3293 that were generated from the original top level address(es) in each message by
3294 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3295 of just &"D"&.
3296
3297
3298 .vitem &%-bpc%&
3299 .oindex "&%-bpc%&"
3300 .cindex "queue" "count of messages on"
3301 This option counts the number of messages in the queue, and writes the total
3302 to the standard output. It is restricted to admin users, unless
3303 &%queue_list_requires_admin%& is set false.
3304
3305
3306 .vitem &%-bpr%&
3307 .oindex "&%-bpr%&"
3308 This option operates like &%-bp%&, but the output is not sorted into
3309 chronological order of message arrival. This can speed it up when there are
3310 lots of messages in the queue, and is particularly useful if the output is
3311 going to be post-processed in a way that doesn't need the sorting.
3312
3313 .vitem &%-bpra%&
3314 .oindex "&%-bpra%&"
3315 This option is a combination of &%-bpr%& and &%-bpa%&.
3316
3317 .vitem &%-bpru%&
3318 .oindex "&%-bpru%&"
3319 This option is a combination of &%-bpr%& and &%-bpu%&.
3320
3321
3322 .vitem &%-bpu%&
3323 .oindex "&%-bpu%&"
3324 This option operates like &%-bp%& but shows only undelivered top-level
3325 addresses for each message displayed. Addresses generated by aliasing or
3326 forwarding are not shown, unless the message was deferred after processing by a
3327 router with the &%one_time%& option set.
3328
3329
3330 .vitem &%-brt%&
3331 .oindex "&%-brt%&"
3332 .cindex "testing" "retry configuration"
3333 .cindex "retry" "configuration testing"
3334 This option is for testing retry rules, and it must be followed by up to three
3335 arguments. It causes Exim to look for a retry rule that matches the values
3336 and to write it to the standard output. For example:
3337 .code
3338 exim -brt bach.comp.mus.example
3339 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3340 .endd
3341 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3342 argument, which is required, can be a complete address in the form
3343 &'local_part@domain'&, or it can be just a domain name. If the second argument
3344 contains a dot, it is interpreted as an optional second domain name; if no
3345 retry rule is found for the first argument, the second is tried. This ties in
3346 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3347 rule is found that matches the host, one that matches the mail domain is
3348 sought. Finally, an argument that is the name of a specific delivery error, as
3349 used in setting up retry rules, can be given. For example:
3350 .code
3351 exim -brt haydn.comp.mus.example quota_3d
3352 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3353 .endd
3354
3355 .vitem &%-brw%&
3356 .oindex "&%-brw%&"
3357 .cindex "testing" "rewriting"
3358 .cindex "rewriting" "testing"
3359 This option is for testing address rewriting rules, and it must be followed by
3360 a single argument, consisting of either a local part without a domain, or a
3361 complete address with a fully qualified domain. Exim outputs how this address
3362 would be rewritten for each possible place it might appear. See chapter
3363 &<<CHAPrewrite>>& for further details.
3364
3365 .vitem &%-bS%&
3366 .oindex "&%-bS%&"
3367 .cindex "SMTP" "batched incoming"
3368 .cindex "batched SMTP input"
3369 This option is used for batched SMTP input, which is an alternative interface
3370 for non-interactive local message submission. A number of messages can be
3371 submitted in a single run. However, despite its name, this is not really SMTP
3372 input. Exim reads each message's envelope from SMTP commands on the standard
3373 input, but generates no responses. If the caller is trusted, or
3374 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3375 believed; otherwise the sender is always the caller of Exim.
3376
3377 The message itself is read from the standard input, in SMTP format (leading
3378 dots doubled), terminated by a line containing just a single dot. An error is
3379 provoked if the terminating dot is missing. A further message may then follow.
3380
3381 As for other local message submissions, the contents of incoming batch SMTP
3382 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3383 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3384 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3385
3386 Some other SMTP commands are recognized in the input. HELO and EHLO act
3387 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3388 QUIT quits, ignoring the rest of the standard input.
3389
3390 .cindex "return code" "for &%-bS%&"
3391 If any error is encountered, reports are written to the standard output and
3392 error streams, and Exim gives up immediately. The return code is 0 if no error
3393 was detected; it is 1 if one or more messages were accepted before the error
3394 was detected; otherwise it is 2.
3395
3396 More details of input using batched SMTP are given in section
3397 &<<SECTincomingbatchedSMTP>>&.
3398
3399 .vitem &%-bs%&
3400 .oindex "&%-bs%&"
3401 .cindex "SMTP" "local input"
3402 .cindex "local SMTP input"
3403 This option causes Exim to accept one or more messages by reading SMTP commands
3404 on the standard input, and producing SMTP replies on the standard output. SMTP
3405 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3406 Some user agents use this interface as a way of passing locally-generated
3407 messages to the MTA.
3408
3409 In
3410 .cindex "sender" "source of"
3411 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3412 set, the senders of messages are taken from the SMTP MAIL commands.
3413 Otherwise the content of these commands is ignored and the sender is set up as
3414 the calling user. Unqualified addresses are automatically qualified using
3415 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3416 &%-bnq%& option is used.
3417
3418 .cindex "inetd"
3419 The
3420 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3421 using a listening daemon. Exim can distinguish the two cases by checking
3422 whether the standard input is a TCP/IP socket. When Exim is called from
3423 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3424 above concerning senders and qualification do not apply. In this situation,
3425 Exim behaves in exactly the same way as it does when receiving a message via
3426 the listening daemon.
3427
3428 .vitem &%-bt%&
3429 .oindex "&%-bt%&"
3430 .cindex "testing" "addresses"
3431 .cindex "address" "testing"
3432 This option runs Exim in address testing mode, in which each argument is taken
3433 as a recipient address to be tested for deliverability. The results are
3434 written to the standard output. If a test fails, and the caller is not an admin
3435 user, no details of the failure are output, because these might contain
3436 sensitive information such as usernames and passwords for database lookups.
3437
3438 If no arguments are given, Exim runs in an interactive manner, prompting with a
3439 right angle bracket for addresses to be tested.
3440
3441 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3442 &[readline()]& function, because it is running as &'root'& and there are
3443 security issues.
3444
3445 Each address is handled as if it were the recipient address of a message
3446 (compare the &%-bv%& option). It is passed to the routers and the result is
3447 written to the standard output. However, any router that has
3448 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3449 genuine routing tests if your first router passes everything to a scanner
3450 program.
3451
3452 .cindex "return code" "for &%-bt%&"
3453 The return code is 2 if any address failed outright; it is 1 if no address
3454 failed outright but at least one could not be resolved for some reason. Return
3455 code 0 is given only when all addresses succeed.
3456
3457 .cindex "duplicate addresses"
3458 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3459 addresses after routing is complete, so that only one delivery takes place.
3460 This does not happen when testing with &%-bt%&; the full results of routing are
3461 always shown.
3462
3463 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3464 routers in the configuration makes any tests on the sender address of a
3465 message,
3466 .oindex "&%-f%&" "for address testing"
3467 you can use the &%-f%& option to set an appropriate sender when running
3468 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3469 default qualifying domain. However, if you have set up (for example) routers
3470 whose behaviour depends on the contents of an incoming message, you cannot test
3471 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3472 doing such tests.
3473
3474 .vitem &%-bV%&
3475 .oindex "&%-bV%&"
3476 .cindex "version number of Exim"
3477 This option causes Exim to write the current version number, compilation
3478 number, and compilation date of the &'exim'& binary to the standard output.
3479 It also lists the DBM library that is being used, the optional modules (such as
3480 specific lookup types), the drivers that are included in the binary, and the
3481 name of the runtime configuration file that is in use.
3482
3483 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3484 configuration file. However, this is a static check only. It cannot check
3485 values that are to be expanded. For example, although a misspelt ACL verb is
3486 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3487 alone to discover (for example) all the typos in the configuration; some
3488 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3489 dynamic testing facilities.
3490
3491 .vitem &%-bv%&
3492 .oindex "&%-bv%&"
3493 .cindex "verifying address" "using &%-bv%&"
3494 .cindex "address" "verification"
3495 This option runs Exim in address verification mode, in which each argument is
3496 taken as a recipient address to be verified by the routers. (This does
3497 not involve any verification callouts). During normal operation, verification
3498 happens mostly as a consequence processing a &%verify%& condition in an ACL
3499 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3500 including callouts, see the &%-bh%& and &%-bhc%& options.
3501
3502 If verification fails, and the caller is not an admin user, no details of the
3503 failure are output, because these might contain sensitive information such as
3504 usernames and passwords for database lookups.
3505
3506 If no arguments are given, Exim runs in an interactive manner, prompting with a
3507 right angle bracket for addresses to be verified.
3508
3509 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3510 &[readline()]& function, because it is running as &'exim'& and there are
3511 security issues.
3512
3513 Verification differs from address testing (the &%-bt%& option) in that routers
3514 that have &%no_verify%& set are skipped, and if the address is accepted by a
3515 router that has &%fail_verify%& set, verification fails. The address is
3516 verified as a recipient if &%-bv%& is used; to test verification for a sender
3517 address, &%-bvs%& should be used.
3518
3519 If the &%-v%& option is not set, the output consists of a single line for each
3520 address, stating whether it was verified or not, and giving a reason in the
3521 latter case. Without &%-v%&, generating more than one address by redirection
3522 causes verification to end successfully, without considering the generated
3523 addresses. However, if just one address is generated, processing continues,
3524 and the generated address must verify successfully for the overall verification
3525 to succeed.
3526
3527 When &%-v%& is set, more details are given of how the address has been handled,
3528 and in the case of address redirection, all the generated addresses are also
3529 considered. Verification may succeed for some and fail for others.
3530
3531 The
3532 .cindex "return code" "for &%-bv%&"
3533 return code is 2 if any address failed outright; it is 1 if no address
3534 failed outright but at least one could not be resolved for some reason. Return
3535 code 0 is given only when all addresses succeed.
3536
3537 If any of the routers in the configuration makes any tests on the sender
3538 address of a message, you should use the &%-f%& option to set an appropriate
3539 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3540 calling user at the default qualifying domain.
3541
3542 .vitem &%-bvs%&
3543 .oindex "&%-bvs%&"
3544 This option acts like &%-bv%&, but verifies the address as a sender rather
3545 than a recipient address. This affects any rewriting and qualification that
3546 might happen.
3547
3548 .vitem &%-bw%&
3549 .oindex "&%-bw%&"
3550 .cindex "daemon"
3551 .cindex "inetd"
3552 .cindex "inetd" "wait mode"
3553 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3554 similarly to the &%-bd%& option.  All port specifications on the command-line
3555 and in the configuration file are ignored.  Queue-running may not be specified.
3556
3557 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3558 listening for connections.  This permits the system to start up and have
3559 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3560 each port only when the first connection is received.
3561
3562 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3563 which the daemon will exit, which should cause inetd to listen once more.
3564
3565 .vitem &%-C%&&~<&'filelist'&>
3566 .oindex "&%-C%&"
3567 .cindex "configuration file" "alternate"
3568 .cindex "CONFIGURE_FILE"
3569 .cindex "alternate configuration file"
3570 This option causes Exim to find the runtime configuration file from the given
3571 list instead of from the list specified by the CONFIGURE_FILE
3572 compile-time setting. Usually, the list will consist of just a single filename,
3573 but it can be a colon-separated list of names. In this case, the first
3574 file that exists is used. Failure to open an existing file stops Exim from
3575 proceeding any further along the list, and an error is generated.
3576
3577 When this option is used by a caller other than root, and the list is different
3578 from the compiled-in list, Exim gives up its root privilege immediately, and
3579 runs with the real and effective uid and gid set to those of the caller.
3580 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3581 file contains a list of full pathnames, one per line, for configuration files
3582 which are trusted. Root privilege is retained for any configuration file so
3583 listed, as long as the caller is the Exim user (or the user specified in the
3584 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3585 not writeable by inappropriate users or groups.
3586
3587 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3588 configuration using &%-C%& right through message reception and delivery,
3589 even if the caller is root. The reception works, but by that time, Exim is
3590 running as the Exim user, so when it re-executes to regain privilege for the
3591 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3592 test reception and delivery using two separate commands (one to put a message
3593 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3594
3595 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3596 prefix string with which any file named in a &%-C%& command line option
3597 must start. In addition, the filename must not contain the sequence &`/../`&.
3598 However, if the value of the &%-C%& option is identical to the value of
3599 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3600 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3601 unset, any filename can be used with &%-C%&.
3602
3603 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3604 to a directory to which only root has access. This prevents someone who has
3605 broken into the Exim account from running a privileged Exim with an arbitrary
3606 configuration file.
3607
3608 The &%-C%& facility is useful for ensuring that configuration files are
3609 syntactically correct, but cannot be used for test deliveries, unless the
3610 caller is privileged, or unless it is an exotic configuration that does not
3611 require privilege. No check is made on the owner or group of the files
3612 specified by this option.
3613
3614
3615 .vitem &%-D%&<&'macro'&>=<&'value'&>
3616 .oindex "&%-D%&"
3617 .cindex "macro" "setting on command line"
3618 This option can be used to override macro definitions in the configuration file
3619 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3620 unprivileged caller, it causes Exim to give up its root privilege.
3621 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3622 completely disabled, and its use causes an immediate error exit.
3623
3624 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3625 colon-separated list of macros which are considered safe and, if &%-D%& only
3626 supplies macros from this list, and the values are acceptable, then Exim will
3627 not give up root privilege if the caller is root, the Exim run-time user, or
3628 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3629 to be removed in the future.  Acceptable values for the macros satisfy the
3630 regexp: &`^[A-Za-z0-9_/.-]*$`&
3631
3632 The entire option (including equals sign if present) must all be within one
3633 command line item. &%-D%& can be used to set the value of a macro to the empty
3634 string, in which case the equals sign is optional. These two commands are
3635 synonymous:
3636 .code
3637 exim -DABC  ...
3638 exim -DABC= ...
3639 .endd
3640 To include spaces in a macro definition item, quotes must be used. If you use
3641 quotes, spaces are permitted around the macro name and the equals sign. For
3642 example:
3643 .code
3644 exim '-D ABC = something' ...
3645 .endd
3646 &%-D%& may be repeated up to 10 times on a command line.
3647 Only macro names up to 22 letters long can be set.
3648
3649
3650 .vitem &%-d%&<&'debug&~options'&>
3651 .oindex "&%-d%&"
3652 .cindex "debugging" "list of selectors"
3653 .cindex "debugging" "&%-d%& option"
3654 This option causes debugging information to be written to the standard
3655 error stream. It is restricted to admin users because debugging output may show
3656 database queries that contain password information. Also, the details of users'
3657 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3658 writes an error message to the standard error stream and exits with a non-zero
3659 return code.
3660
3661 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3662 standard debugging data is output. This can be reduced, or increased to include
3663 some more rarely needed information, by directly following &%-d%& with a string
3664 made up of names preceded by plus or minus characters. These add or remove sets
3665 of debugging data, respectively. For example, &%-d+filter%& adds filter
3666 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3667 no spaces are allowed in the debug setting. The available debugging categories
3668 are:
3669 .display
3670 &`acl            `& ACL interpretation
3671 &`auth           `& authenticators
3672 &`deliver        `& general delivery logic
3673 &`dns            `& DNS lookups (see also resolver)
3674 &`dnsbl          `& DNS black list (aka RBL) code
3675 &`exec           `& arguments for &[execv()]& calls
3676 &`expand         `& detailed debugging for string expansions
3677 &`filter         `& filter handling
3678 &`hints_lookup   `& hints data lookups
3679 &`host_lookup    `& all types of name-to-IP address handling
3680 &`ident          `& ident lookup
3681 &`interface      `& lists of local interfaces
3682 &`lists          `& matching things in lists
3683 &`load           `& system load checks
3684 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3685                     &<<CHAPlocalscan>>&)
3686 &`lookup         `& general lookup code and all lookups
3687 &`memory         `& memory handling
3688 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3689 &`pid            `& modifier: add pid to debug output lines
3690 &`process_info   `& setting info for the process log
3691 &`queue_run      `& queue runs
3692 &`receive        `& general message reception logic
3693 &`resolver       `& turn on the DNS resolver's debugging output
3694 &`retry          `& retry handling
3695 &`rewrite        `& address rewriting
3696 &`route          `& address routing
3697 &`timestamp      `& modifier: add timestamp to debug output lines
3698 &`tls            `& TLS logic
3699 &`transport      `& transports
3700 &`uid            `& changes of uid/gid and looking up uid/gid
3701 &`verify         `& address verification logic
3702 &`all            `& almost all of the above (see below), and also &%-v%&
3703 .endd
3704 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3705 for &`-all`&. The reason for this is that &`+all`& is something that people
3706 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3707 is included, an awful lot of output that is very rarely of interest is
3708 generated, so it now has to be explicitly requested. However, &`-all`& does
3709 turn everything off.
3710
3711 .cindex "resolver, debugging output"
3712 .cindex "DNS resolver, debugging output"
3713 The &`resolver`& option produces output only if the DNS resolver was compiled
3714 with DEBUG enabled. This is not the case in some operating systems. Also,
3715 unfortunately, debugging output from the DNS resolver is written to stdout
3716 rather than stderr.
3717
3718 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3719 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3720 However, the &`pid`& selector is forced when debugging is turned on for a
3721 daemon, which then passes it on to any re-executed Exims. Exim also
3722 automatically adds the pid to debug lines when several remote deliveries are
3723 run in parallel.
3724
3725 The &`timestamp`& selector causes the current time to be inserted at the start
3726 of all debug output lines. This can be useful when trying to track down delays
3727 in processing.
3728
3729 .cindex debugging "UTF-8 in"
3730 .cindex UTF-8 "in debug output"
3731 The &`noutf8`& selector disables the use of
3732 UTF-8 line-drawing characters to group related information.
3733 When disabled. ascii-art is used instead.
3734 Using the &`+all`& option does not set this modifier,
3735
3736 If the &%debug_print%& option is set in any driver, it produces output whenever
3737 any debugging is selected, or if &%-v%& is used.
3738
3739 .vitem &%-dd%&<&'debug&~options'&>
3740 .oindex "&%-dd%&"
3741 This option behaves exactly like &%-d%& except when used on a command that
3742 starts a daemon process. In that case, debugging is turned off for the
3743 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3744 behaviour of the daemon without creating as much output as full debugging does.
3745
3746 .vitem &%-dropcr%&
3747 .oindex "&%-dropcr%&"
3748 This is an obsolete option that is now a no-op. It used to affect the way Exim
3749 handled CR and LF characters in incoming messages. What happens now is
3750 described in section &<<SECTlineendings>>&.
3751
3752 .vitem &%-E%&
3753 .oindex "&%-E%&"
3754 .cindex "bounce message" "generating"
3755 This option specifies that an incoming message is a locally-generated delivery
3756 failure report. It is used internally by Exim when handling delivery failures
3757 and is not intended for external use. Its only effect is to stop Exim
3758 generating certain messages to the postmaster, as otherwise message cascades
3759 could occur in some situations. As part of the same option, a message id may
3760 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3761 new message contains the id, following &"R="&, as a cross-reference.
3762
3763 .vitem &%-e%&&'x'&
3764 .oindex "&%-e%&&'x'&"
3765 There are a number of Sendmail options starting with &%-oe%& which seem to be
3766 called by various programs without the leading &%o%& in the option. For
3767 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3768 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3769
3770 .vitem &%-F%&&~<&'string'&>
3771 .oindex "&%-F%&"
3772 .cindex "sender" "name"
3773 .cindex "name" "of sender"
3774 This option sets the sender's full name for use when a locally-generated
3775 message is being accepted. In the absence of this option, the user's &'gecos'&
3776 entry from the password data is used. As users are generally permitted to alter
3777 their &'gecos'& entries, no security considerations are involved. White space
3778 between &%-F%& and the <&'string'&> is optional.
3779
3780 .vitem &%-f%&&~<&'address'&>
3781 .oindex "&%-f%&"
3782 .cindex "sender" "address"
3783 .cindex "address" "sender"
3784 .cindex "trusted users"
3785 .cindex "envelope from"
3786 .cindex "envelope sender"
3787 .cindex "user" "trusted"
3788 This option sets the address of the envelope sender of a locally-generated
3789 message (also known as the return path). The option can normally be used only
3790 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3791 users to use it.
3792
3793 Processes running as root or the Exim user are always trusted. Other
3794 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3795 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3796 of a local message is set to the caller's login name at the default qualify
3797 domain.
3798
3799 There is one exception to the restriction on the use of &%-f%&: an empty sender
3800 can be specified by any user, trusted or not, to create a message that can
3801 never provoke a bounce. An empty sender can be specified either as an empty
3802 string, or as a pair of angle brackets with nothing between them, as in these
3803 examples of shell commands:
3804 .code
3805 exim -f '<>' user@domain
3806 exim -f "" user@domain
3807 .endd
3808 In addition, the use of &%-f%& is not restricted when testing a filter file
3809 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3810 &%-bv%& options.
3811
3812 Allowing untrusted users to change the sender address does not of itself make
3813 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3814 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3815 though this can be overridden by setting &%no_local_from_check%&.
3816
3817 White
3818 .cindex "&""From""& line"
3819 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3820 given as two arguments or one combined argument). The sender of a
3821 locally-generated message can also be set (when permitted) by an initial
3822 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3823 if &%-f%& is also present, it overrides &"From&~"&.
3824
3825 .vitem &%-G%&
3826 .oindex "&%-G%&"
3827 .cindex "submission fixups, suppressing (command-line)"
3828 This option is equivalent to an ACL applying:
3829 .code
3830 control = suppress_local_fixups
3831 .endd
3832 for every message received.  Note that Sendmail will complain about such
3833 bad formatting, where Exim silently just does not fix it up.  This may change
3834 in future.
3835
3836 As this affects audit information, the caller must be a trusted user to use
3837 this option.
3838
3839 .vitem &%-h%&&~<&'number'&>
3840 .oindex "&%-h%&"
3841 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3842 This option is accepted for compatibility with Sendmail, but has no effect. (In
3843 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3844 headers.)
3845
3846 .vitem &%-i%&
3847 .oindex "&%-i%&"
3848 .cindex "Solaris" "&'mail'& command"
3849 .cindex "dot" "in incoming non-SMTP message"
3850 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3851 line by itself should not terminate an incoming, non-SMTP message. I can find
3852 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3853 command in Solaris 2.4 uses it. See also &%-ti%&.
3854
3855 .vitem &%-L%&&~<&'tag'&>
3856 .oindex "&%-L%&"
3857 .cindex "syslog" "process name; set with flag"
3858 This option is equivalent to setting &%syslog_processname%& in the config
3859 file and setting &%log_file_path%& to &`syslog`&.
3860 Its use is restricted to administrators.  The configuration file has to be
3861 read and parsed, to determine access rights, before this is set and takes
3862 effect, so early configuration file errors will not honour this flag.
3863
3864 The tag should not be longer than 32 characters.
3865
3866 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3867 .oindex "&%-M%&"
3868 .cindex "forcing delivery"
3869 .cindex "delivery" "forcing attempt"
3870 .cindex "frozen messages" "forcing delivery"
3871 This option requests Exim to run a delivery attempt on each message in turn. If
3872 any of the messages are frozen, they are automatically thawed before the
3873 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3874 and &%hold_domains%& are ignored.
3875
3876 Retry
3877 .cindex "hints database" "overriding retry hints"
3878 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3879 the normal retry time has not yet been reached. This option requires the caller
3880 to be an admin user. However, there is an option called &%prod_requires_admin%&
3881 which can be set false to relax this restriction (and also the same requirement
3882 for the &%-q%&, &%-R%&, and &%-S%& options).
3883
3884 The deliveries happen synchronously, that is, the original Exim process does
3885 not terminate until all the delivery attempts have finished. No output is
3886 produced unless there is a serious error. If you want to see what is happening,
3887 use the &%-v%& option as well, or inspect Exim's main log.
3888
3889 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3890 .oindex "&%-Mar%&"
3891 .cindex "message" "adding recipients"
3892 .cindex "recipient" "adding"
3893 This option requests Exim to add the addresses to the list of recipients of the
3894 message (&"ar"& for &"add recipients"&). The first argument must be a message
3895 id, and the remaining ones must be email addresses. However, if the message is
3896 active (in the middle of a delivery attempt), it is not altered. This option
3897 can be used only by an admin user.
3898
3899 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&&&
3900         &~<&'host&~IP'&>&&&
3901         &~<&'sequence&~number'&>&&&
3902         &~<&'message&~id'&>"
3903 .oindex "&%-MC%&"
3904 .cindex "SMTP" "passed connection"
3905 .cindex "SMTP" "multiple deliveries"
3906 .cindex "multiple SMTP deliveries"
3907 This option is not intended for use by external callers. It is used internally
3908 by Exim to invoke another instance of itself to deliver a waiting message using
3909 an existing SMTP connection, which is passed as the standard input. Details are
3910 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3911 must be root or the Exim user in order to use it.
3912
3913 .vitem &%-MCA%&
3914 .oindex "&%-MCA%&"
3915 This option is not intended for use by external callers. It is used internally
3916 by Exim in conjunction with the &%-MC%& option. It signifies that the
3917 connection to the remote host has been authenticated.
3918
3919 .vitem &%-MCD%&
3920 .oindex "&%-MCD%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option. It signifies that the
3923 remote host supports the ESMTP &_DSN_& extension.
3924
3925 .vitem &%-MCd%&
3926 .oindex "&%-MCd%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-d%& option
3929 to pass on an information string on the purpose of the process.
3930
3931 .vitem &%-MCG%&&~<&'queue&~name'&>
3932 .oindex "&%-MCG%&"
3933 This option is not intended for use by external callers. It is used internally
3934 by Exim in conjunction with the &%-MC%& option. It signifies that an
3935 alternate queue is used, named by the following argument.
3936
3937 .vitem &%-MCK%&
3938 .oindex "&%-MCK%&"
3939 This option is not intended for use by external callers. It is used internally
3940 by Exim in conjunction with the &%-MC%& option. It signifies that a
3941 remote host supports the ESMTP &_CHUNKING_& extension.
3942
3943 .vitem &%-MCP%&
3944 .oindex "&%-MCP%&"
3945 This option is not intended for use by external callers. It is used internally
3946 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3947 which Exim is connected supports pipelining.
3948
3949 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3950 .oindex "&%-MCQ%&"
3951 This option is not intended for use by external callers. It is used internally
3952 by Exim in conjunction with the &%-MC%& option when the original delivery was
3953 started by a queue runner. It passes on the process id of the queue runner,
3954 together with the file descriptor number of an open pipe. Closure of the pipe
3955 signals the final completion of the sequence of processes that are passing
3956 messages through the same SMTP connection.
3957
3958 .new
3959 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3960 .oindex "&%-MCq%&"
3961 This option is not intended for use by external callers. It is used internally
3962 by Exim to implement quota checking for local users.
3963 .wen
3964
3965 .vitem &%-MCS%&
3966 .oindex "&%-MCS%&"
3967 This option is not intended for use by external callers. It is used internally
3968 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3969 ESMTP SIZE option should be used on messages delivered down the existing
3970 connection.
3971
3972 .vitem &%-MCT%&
3973 .oindex "&%-MCT%&"
3974 This option is not intended for use by external callers. It is used internally
3975 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3976 host to which Exim is connected supports TLS encryption.
3977
3978 .new
3979 .vitem &%-MCr%&&~<&'SNI'&> &&&
3980        &%-MCs%&&~<&'SNI'&>
3981 .oindex "&%-MCs%&"
3982 .oindex "&%-MCr%&"
3983 These options are not intended for use by external callers. It is used internally
3984 by Exim in conjunction with the &%-MCt%& option, and passes on the fact that
3985 a TLS Server Name Indication was sent as part of the channel establishment.
3986 The argument gives the SNI string.
3987 The "r" variant indicates a DANE-verified connection.
3988 .wen
3989
3990 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3991 .oindex "&%-MCt%&"
3992 This option is not intended for use by external callers. It is used internally
3993 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3994 connection is being proxied by a parent process for handling TLS encryption.
3995 The arguments give the local address and port being proxied, and the TLS cipher.
3996
3997 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3998 .oindex "&%-Mc%&"
3999 .cindex "hints database" "not overridden by &%-Mc%&"
4000 .cindex "delivery" "manually started &-- not forced"
4001 This option requests Exim to run a delivery attempt on each message, in turn,
4002 but unlike the &%-M%& option, it does check for retry hints, and respects any
4003 that are found. This option is not very useful to external callers. It is
4004 provided mainly for internal use by Exim when it needs to re-invoke itself in
4005 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
4006 However, &%-Mc%& can be useful when testing, in order to run a delivery that
4007 respects retry times and other options such as &%hold_domains%& that are
4008 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
4009 If you want to run a specific delivery as if in a queue run, you should use
4010 &%-q%& with a message id argument. A distinction between queue run deliveries
4011 and other deliveries is made in one or two places.
4012
4013 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
4014 .oindex "&%-Mes%&"
4015 .cindex "message" "changing sender"
4016 .cindex "sender" "changing"
4017 This option requests Exim to change the sender address in the message to the
4018 given address, which must be a fully qualified address or &"<>"& (&"es"& for
4019 &"edit sender"&). There must be exactly two arguments. The first argument must
4020 be a message id, and the second one an email address. However, if the message
4021 is active (in the middle of a delivery attempt), its status is not altered.
4022 This option can be used only by an admin user.
4023
4024 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4025 .oindex "&%-Mf%&"
4026 .cindex "freezing messages"
4027 .cindex "message" "manually freezing"
4028 This option requests Exim to mark each listed message as &"frozen"&. This
4029 prevents any delivery attempts taking place until the message is &"thawed"&,
4030 either manually or as a result of the &%auto_thaw%& configuration option.
4031 However, if any of the messages are active (in the middle of a delivery
4032 attempt), their status is not altered. This option can be used only by an admin
4033 user.
4034
4035 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4036 .oindex "&%-Mg%&"
4037 .cindex "giving up on messages"
4038 .cindex "message" "abandoning delivery attempts"
4039 .cindex "delivery" "abandoning further attempts"
4040 This option requests Exim to give up trying to deliver the listed messages,
4041 including any that are frozen. However, if any of the messages are active,
4042 their status is not altered. For non-bounce messages, a delivery error message
4043 is sent to the sender, containing the text &"cancelled by administrator"&.
4044 Bounce messages are just discarded. This option can be used only by an admin
4045 user.
4046
4047 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
4048 .oindex "&%-MG%&"
4049 .cindex queue named
4050 .cindex "named queues" "moving messages"
4051 .cindex "queue" "moving messages"
4052 This option requests that each listed message be moved from its current
4053 queue to the given named queue.
4054 The destination queue name argument is required, but can be an empty
4055 string to define the default queue.
4056 If the messages are not currently located in the default queue,
4057 a &%-qG<name>%& option will be required to define the source queue.
4058
4059 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4060 .oindex "&%-Mmad%&"
4061 .cindex "delivery" "cancelling all"
4062 This option requests Exim to mark all the recipient addresses in the messages
4063 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
4064 message is active (in the middle of a delivery attempt), its status is not
4065 altered. This option can be used only by an admin user.
4066
4067 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4068 .oindex "&%-Mmd%&"
4069 .cindex "delivery" "cancelling by address"
4070 .cindex "recipient" "removing"
4071 .cindex "removing recipients"
4072 This option requests Exim to mark the given addresses as already delivered
4073 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4074 the remaining ones must be email addresses. These are matched to recipient
4075 addresses in the message in a case-sensitive manner. If the message is active
4076 (in the middle of a delivery attempt), its status is not altered. This option
4077 can be used only by an admin user.
4078
4079 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4080 .oindex "&%-Mrm%&"
4081 .cindex "removing messages"
4082 .cindex "abandoning mail"
4083 .cindex "message" "manually discarding"
4084 This option requests Exim to remove the given messages from the queue. No
4085 bounce messages are sent; each message is simply forgotten. However, if any of
4086 the messages are active, their status is not altered. This option can be used
4087 only by an admin user or by the user who originally caused the message to be
4088 placed in the queue.
4089
4090 . .new
4091 . .vitem &%-MS%&
4092 . .oindex "&%-MS%&"
4093 . .cindex REQUIRETLS
4094 . This option is used to request REQUIRETLS processing on the message.
4095 . It is used internally by Exim in conjunction with -E when generating
4096 . a bounce message.
4097 . .wen
4098
4099 .vitem &%-Mset%&&~<&'message&~id'&>
4100 .oindex "&%-Mset%&"
4101 .cindex "testing" "string expansion"
4102 .cindex "expansion" "testing"
4103 This option is useful only in conjunction with &%-be%& (that is, when testing
4104 string expansions). Exim loads the given message from its spool before doing
4105 the test expansions, thus setting message-specific variables such as
4106 &$message_size$& and the header variables. The &$recipients$& variable is made
4107 available. This feature is provided to make it easier to test expansions that
4108 make use of these variables. However, this option can be used only by an admin
4109 user. See also &%-bem%&.
4110
4111 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4112 .oindex "&%-Mt%&"
4113 .cindex "thawing messages"
4114 .cindex "unfreezing messages"
4115 .cindex "frozen messages" "thawing"
4116 .cindex "message" "thawing frozen"
4117 This option requests Exim to &"thaw"& any of the listed messages that are
4118 &"frozen"&, so that delivery attempts can resume. However, if any of the
4119 messages are active, their status is not altered. This option can be used only
4120 by an admin user.
4121
4122 .vitem &%-Mvb%&&~<&'message&~id'&>
4123 .oindex "&%-Mvb%&"
4124 .cindex "listing" "message body"
4125 .cindex "message" "listing body of"
4126 This option causes the contents of the message body (-D) spool file to be
4127 written to the standard output. This option can be used only by an admin user.
4128
4129 .vitem &%-Mvc%&&~<&'message&~id'&>
4130 .oindex "&%-Mvc%&"
4131 .cindex "message" "listing in RFC 2822 format"
4132 .cindex "listing" "message in RFC 2822 format"
4133 This option causes a copy of the complete message (header lines plus body) to
4134 be written to the standard output in RFC 2822 format. This option can be used
4135 only by an admin user.
4136
4137 .vitem &%-Mvh%&&~<&'message&~id'&>
4138 .oindex "&%-Mvh%&"
4139 .cindex "listing" "message headers"
4140 .cindex "header lines" "listing"
4141 .cindex "message" "listing header lines"
4142 This option causes the contents of the message headers (-H) spool file to be
4143 written to the standard output. This option can be used only by an admin user.
4144
4145 .vitem &%-Mvl%&&~<&'message&~id'&>
4146 .oindex "&%-Mvl%&"
4147 .cindex "listing" "message log"
4148 .cindex "message" "listing message log"
4149 This option causes the contents of the message log spool file to be written to
4150 the standard output. This option can be used only by an admin user.
4151
4152 .vitem &%-m%&
4153 .oindex "&%-m%&"
4154 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4155 treats it that way too.
4156
4157 .vitem &%-N%&
4158 .oindex "&%-N%&"
4159 .cindex "debugging" "&%-N%& option"
4160 .cindex "debugging" "suppressing delivery"
4161 This is a debugging option that inhibits delivery of a message at the transport
4162 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4163 it just doesn't actually transport the message, but instead behaves as if it
4164 had successfully done so. However, it does not make any updates to the retry
4165 database, and the log entries for deliveries are flagged with &"*>"& rather
4166 than &"=>"&.
4167
4168 Because &%-N%& discards any message to which it applies, only root or the Exim
4169 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4170 words, an ordinary user can use it only when supplying an incoming message to
4171 which it will apply. Although transportation never fails when &%-N%& is set, an
4172 address may be deferred because of a configuration problem on a transport, or a
4173 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4174 the message, and applies to any subsequent delivery attempts that may happen
4175 for that message.
4176
4177 .vitem &%-n%&
4178 .oindex "&%-n%&"
4179 This option is interpreted by Sendmail to mean &"no aliasing"&.
4180 For normal modes of operation, it is ignored by Exim.
4181 When combined with &%-bP%& it makes the output more terse (suppresses
4182 option names, environment values and config pretty printing).
4183
4184 .vitem &%-O%&&~<&'data'&>
4185 .oindex "&%-O%&"
4186 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4187 Exim.
4188
4189 .vitem &%-oA%&&~<&'file&~name'&>
4190 .oindex "&%-oA%&"
4191 .cindex "Sendmail compatibility" "&%-oA%& option"
4192 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4193 alternative alias filename. Exim handles &%-bi%& differently; see the
4194 description above.
4195
4196 .vitem &%-oB%&&~<&'n'&>
4197 .oindex "&%-oB%&"
4198 .cindex "SMTP" "passed connection"
4199 .cindex "SMTP" "multiple deliveries"
4200 .cindex "multiple SMTP deliveries"
4201 This is a debugging option which limits the maximum number of messages that can
4202 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4203 transport. If <&'n'&> is omitted, the limit is set to 1.
4204
4205 .vitem &%-odb%&
4206 .oindex "&%-odb%&"
4207 .cindex "background delivery"
4208 .cindex "delivery" "in the background"
4209 This option applies to all modes in which Exim accepts incoming messages,
4210 including the listening daemon. It requests &"background"& delivery of such
4211 messages, which means that the accepting process automatically starts a
4212 delivery process for each message received, but does not wait for the delivery
4213 processes to finish.
4214
4215 When all the messages have been received, the reception process exits,
4216 leaving the delivery processes to finish in their own time. The standard output
4217 and error streams are closed at the start of each delivery process.
4218 This is the default action if none of the &%-od%& options are present.
4219
4220 If one of the queueing options in the configuration file
4221 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4222 overrides it if &%queue_only_override%& is set true, which is the default
4223 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4224
4225 .vitem &%-odf%&
4226 .oindex "&%-odf%&"
4227 .cindex "foreground delivery"
4228 .cindex "delivery" "in the foreground"
4229 This option requests &"foreground"& (synchronous) delivery when Exim has
4230 accepted a locally-generated message. (For the daemon it is exactly the same as
4231 &%-odb%&.) A delivery process is automatically started to deliver the message,
4232 and Exim waits for it to complete before proceeding.
4233
4234 The original Exim reception process does not finish until the delivery
4235 process for the final message has ended. The standard error stream is left open
4236 during deliveries.
4237
4238 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4239 false and one of the queueing options in the configuration file is in effect.
4240
4241 If there is a temporary delivery error during foreground delivery, the
4242 message is left in the queue for later delivery, and the original reception
4243 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4244 restricted configuration that never queues messages.
4245
4246
4247 .vitem &%-odi%&
4248 .oindex "&%-odi%&"
4249 This option is synonymous with &%-odf%&. It is provided for compatibility with
4250 Sendmail.
4251
4252 .vitem &%-odq%&
4253 .oindex "&%-odq%&"
4254 .cindex "non-immediate delivery"
4255 .cindex "delivery" "suppressing immediate"
4256 .cindex "queueing incoming messages"
4257 This option applies to all modes in which Exim accepts incoming messages,
4258 including the listening daemon. It specifies that the accepting process should
4259 not automatically start a delivery process for each message received. Messages
4260 are placed in the queue, and remain there until a subsequent queue runner
4261 process encounters them. There are several configuration options (such as
4262 &%queue_only%&) that can be used to queue incoming messages under certain
4263 conditions. This option overrides all of them and also &%-odqs%&. It always
4264 forces queueing.
4265
4266 .vitem &%-odqs%&
4267 .oindex "&%-odqs%&"
4268 .cindex "SMTP" "delaying delivery"
4269 .cindex "first pass routing"
4270 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4271 However, like &%-odb%& and &%-odi%&, this option has no effect if
4272 &%queue_only_override%& is false and one of the queueing options in the
4273 configuration file is in effect.
4274
4275 When &%-odqs%& does operate, a delivery process is started for each incoming
4276 message, in the background by default, but in the foreground if &%-odi%& is
4277 also present. The recipient addresses are routed, and local deliveries are done
4278 in the normal way. However, if any SMTP deliveries are required, they are not
4279 done at this time, so the message remains in the queue until a subsequent queue
4280 runner process encounters it. Because routing was done, Exim knows which
4281 messages are waiting for which hosts, and so a number of messages for the same
4282 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4283 configuration option has the same effect for specific domains. See also the
4284 &%-qq%& option.
4285
4286 .vitem &%-oee%&
4287 .oindex "&%-oee%&"
4288 .cindex "error" "reporting"
4289 If an error is detected while a non-SMTP message is being received (for
4290 example, a malformed address), the error is reported to the sender in a mail
4291 message.
4292
4293 .cindex "return code" "for &%-oee%&"
4294 Provided
4295 this error message is successfully sent, the Exim receiving process
4296 exits with a return code of zero. If not, the return code is 2 if the problem
4297 is that the original message has no recipients, or 1 for any other error.
4298 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4299
4300 .vitem &%-oem%&
4301 .oindex "&%-oem%&"
4302 .cindex "error" "reporting"
4303 .cindex "return code" "for &%-oem%&"
4304 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4305 return code, whether or not the error message was successfully sent.
4306 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4307
4308 .vitem &%-oep%&
4309 .oindex "&%-oep%&"
4310 .cindex "error" "reporting"
4311 If an error is detected while a non-SMTP message is being received, the
4312 error is reported by writing a message to the standard error file (stderr).
4313 .cindex "return code" "for &%-oep%&"
4314 The return code is 1 for all errors.
4315
4316 .vitem &%-oeq%&
4317 .oindex "&%-oeq%&"
4318 .cindex "error" "reporting"
4319 This option is supported for compatibility with Sendmail, but has the same
4320 effect as &%-oep%&.
4321
4322 .vitem &%-oew%&
4323 .oindex "&%-oew%&"
4324 .cindex "error" "reporting"
4325 This option is supported for compatibility with Sendmail, but has the same
4326 effect as &%-oem%&.
4327
4328 .vitem &%-oi%&
4329 .oindex "&%-oi%&"
4330 .cindex "dot" "in incoming non-SMTP message"
4331 This option, which has the same effect as &%-i%&, specifies that a dot on a
4332 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4333 single dot does terminate, though Exim does no special processing for other
4334 lines that start with a dot. This option is set by default if Exim is called as
4335 &'rmail'&. See also &%-ti%&.
4336
4337 .vitem &%-oitrue%&
4338 .oindex "&%-oitrue%&"
4339 This option is treated as synonymous with &%-oi%&.
4340
4341 .vitem &%-oMa%&&~<&'host&~address'&>
4342 .oindex "&%-oMa%&"
4343 .cindex "sender" "host address, specifying for local message"
4344 A number of options starting with &%-oM%& can be used to set values associated
4345 with remote hosts on locally-submitted messages (that is, messages not received
4346 over TCP/IP). These options can be used by any caller in conjunction with the
4347 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4348 other circumstances, they are ignored unless the caller is trusted.
4349
4350 The &%-oMa%& option sets the sender host address. This may include a port
4351 number at the end, after a full stop (period). For example:
4352 .code
4353 exim -bs -oMa 10.9.8.7.1234
4354 .endd
4355 An alternative syntax is to enclose the IP address in square brackets,
4356 followed by a colon and the port number:
4357 .code
4358 exim -bs -oMa [10.9.8.7]:1234
4359 .endd
4360 The IP address is placed in the &$sender_host_address$& variable, and the
4361 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4362 are present on the command line, the sender host IP address is taken from
4363 whichever one is last.
4364
4365 .vitem &%-oMaa%&&~<&'name'&>
4366 .oindex "&%-oMaa%&"
4367 .cindex "authentication" "name, specifying for local message"
4368 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4369 option sets the value of &$sender_host_authenticated$& (the authenticator
4370 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4371 This option can be used with &%-bh%& and &%-bs%& to set up an
4372 authenticated SMTP session without actually using the SMTP AUTH command.
4373
4374 .vitem &%-oMai%&&~<&'string'&>
4375 .oindex "&%-oMai%&"
4376 .cindex "authentication" "id, specifying for local message"
4377 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4378 option sets the value of &$authenticated_id$& (the id that was authenticated).
4379 This overrides the default value (the caller's login id, except with &%-bh%&,
4380 where there is no default) for messages from local sources. See chapter
4381 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4382
4383 .vitem &%-oMas%&&~<&'address'&>
4384 .oindex "&%-oMas%&"
4385 .cindex "authentication" "sender, specifying for local message"
4386 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4387 option sets the authenticated sender value in &$authenticated_sender$&. It
4388 overrides the sender address that is created from the caller's login id for
4389 messages from local sources, except when &%-bh%& is used, when there is no
4390 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4391 specified on a MAIL command overrides this value. See chapter
4392 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4393
4394 .vitem &%-oMi%&&~<&'interface&~address'&>
4395 .oindex "&%-oMi%&"
4396 .cindex "interface" "address, specifying for local message"
4397 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4398 option sets the IP interface address value. A port number may be included,
4399 using the same syntax as for &%-oMa%&. The interface address is placed in
4400 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4401
4402 .vitem &%-oMm%&&~<&'message&~reference'&>
4403 .oindex "&%-oMm%&"
4404 .cindex "message reference" "message reference, specifying for local message"
4405 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4406 option sets the message reference, e.g. message-id, and is logged during
4407 delivery. This is useful when some kind of audit trail is required to tie
4408 messages together. The format of the message reference is checked and will
4409 abort if the format is invalid. The option will only be accepted if exim is
4410 running in trusted mode, not as any regular user.
4411
4412 The best example of a message reference is when Exim sends a bounce message.
4413 The message reference is the message-id of the original message for which Exim
4414 is sending the bounce.
4415
4416 .vitem &%-oMr%&&~<&'protocol&~name'&>
4417 .oindex "&%-oMr%&"
4418 .cindex "protocol, specifying for local message"
4419 .vindex "&$received_protocol$&"
4420 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4421 option sets the received protocol value that is stored in
4422 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4423 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4424 SMTP protocol names (see the description of &$received_protocol$& in section
4425 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4426 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4427 be set by &%-oMr%&. Repeated use of this option is not supported.
4428
4429 .vitem &%-oMs%&&~<&'host&~name'&>
4430 .oindex "&%-oMs%&"
4431 .cindex "sender" "host name, specifying for local message"
4432 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4433 option sets the sender host name in &$sender_host_name$&. When this option is
4434 present, Exim does not attempt to look up a host name from an IP address; it
4435 uses the name it is given.
4436
4437 .vitem &%-oMt%&&~<&'ident&~string'&>
4438 .oindex "&%-oMt%&"
4439 .cindex "sender" "ident string, specifying for local message"
4440 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4441 option sets the sender ident value in &$sender_ident$&. The default setting for
4442 local callers is the login id of the calling process, except when &%-bh%& is
4443 used, when there is no default.
4444
4445 .vitem &%-om%&
4446 .oindex "&%-om%&"
4447 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4448 In Sendmail, this option means &"me too"&, indicating that the sender of a
4449 message should receive a copy of the message if the sender appears in an alias
4450 expansion. Exim always does this, so the option does nothing.
4451
4452 .vitem &%-oo%&
4453 .oindex "&%-oo%&"
4454 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4455 This option is ignored. In Sendmail it specifies &"old style headers"&,
4456 whatever that means.
4457
4458 .vitem &%-oP%&&~<&'path'&>
4459 .oindex "&%-oP%&"
4460 .cindex "pid (process id)" "of daemon"
4461 .cindex "daemon" "process id (pid)"
4462 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4463 value. The option specifies the file to which the process id of the daemon is
4464 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4465 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4466 because in those cases, the normal pid file is not used.
4467
4468 .vitem &%-oPX%&
4469 .oindex "&%-oPX%&"
4470 .cindex "pid (process id)" "of daemon"
4471 .cindex "daemon" "process id (pid)"
4472 This option is not intended for general use.
4473 The daemon uses it when terminating due to a SIGTEM, possibly in
4474 combination with &%-oP%&&~<&'path'&>.
4475 It causes the pid file to be removed.
4476
4477 .vitem &%-or%&&~<&'time'&>
4478 .oindex "&%-or%&"
4479 .cindex "timeout" "for non-SMTP input"
4480 This option sets a timeout value for incoming non-SMTP messages. If it is not
4481 set, Exim will wait forever for the standard input. The value can also be set
4482 by the &%receive_timeout%& option. The format used for specifying times is
4483 described in section &<<SECTtimeformat>>&.
4484
4485 .vitem &%-os%&&~<&'time'&>
4486 .oindex "&%-os%&"
4487 .cindex "timeout" "for SMTP input"
4488 .cindex "SMTP" "input timeout"
4489 This option sets a timeout value for incoming SMTP messages. The timeout
4490 applies to each SMTP command and block of data. The value can also be set by
4491 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4492 for specifying times is described in section &<<SECTtimeformat>>&.
4493
4494 .vitem &%-ov%&
4495 .oindex "&%-ov%&"
4496 This option has exactly the same effect as &%-v%&.
4497
4498 .vitem &%-oX%&&~<&'number&~or&~string'&>
4499 .oindex "&%-oX%&"
4500 .cindex "TCP/IP" "setting listening ports"
4501 .cindex "TCP/IP" "setting listening interfaces"
4502 .cindex "port" "receiving TCP/IP"
4503 This option is relevant only when the &%-bd%& (start listening daemon) option
4504 is also given. It controls which ports and interfaces the daemon uses. Details
4505 of the syntax, and how it interacts with configuration file options, are given
4506 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4507 file is written unless &%-oP%& is also present to specify a pid filename.
4508
4509 .new
4510 .vitem &%-oY%&
4511 .oindex &%-oY%&
4512 .cindex "daemon notifier socket"
4513 This option controls the creation of an inter-process communications endpoint
4514 by the Exim daemon.
4515 It is only relevant when the &%-bd%& (start listening daemon) option is also
4516 given.
4517 Normally the daemon creates this socket, unless a &%-oX%& and &*no*& &%-oP%&
4518 option is also present.
4519 If this option is given then the socket will not be created.  This could be
4520 required if the system is running multiple daemons.
4521
4522 The socket is currently used for
4523 .ilist
4524 fast ramp-up of queue runner processes
4525 .next
4526 obtaining a current queue size
4527 .endlist
4528 .wen
4529
4530 .vitem &%-pd%&
4531 .oindex "&%-pd%&"
4532 .cindex "Perl" "starting the interpreter"
4533 This option applies when an embedded Perl interpreter is linked with Exim (see
4534 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4535 option, forcing the starting of the interpreter to be delayed until it is
4536 needed.
4537
4538 .vitem &%-ps%&
4539 .oindex "&%-ps%&"
4540 .cindex "Perl" "starting the interpreter"
4541 This option applies when an embedded Perl interpreter is linked with Exim (see
4542 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4543 option, forcing the starting of the interpreter to occur as soon as Exim is
4544 started.
4545
4546 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4547 .oindex "&%-p%&"
4548 For compatibility with Sendmail, this option is equivalent to
4549 .display
4550 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4551 .endd
4552 It sets the incoming protocol and host name (for trusted callers). The
4553 host name and its colon can be omitted when only the protocol is to be set.
4554 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4555 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4556 or &`s`& using this option (but that does not seem a real limitation).
4557 Repeated use of this option is not supported.
4558
4559 .vitem &%-q%&
4560 .oindex "&%-q%&"
4561 .cindex "queue runner" "starting manually"
4562 This option is normally restricted to admin users. However, there is a
4563 configuration option called &%prod_requires_admin%& which can be set false to
4564 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4565 and &%-S%& options).
4566
4567 .cindex "queue runner" "description of operation"
4568 If other commandline options do not specify an action,
4569 the &%-q%& option starts one queue runner process. This scans the queue of
4570 waiting messages, and runs a delivery process for each one in turn. It waits
4571 for each delivery process to finish before starting the next one. A delivery
4572 process may not actually do any deliveries if the retry times for the addresses
4573 have not been reached. Use &%-qf%& (see below) if you want to override this.
4574
4575 If
4576 .cindex "SMTP" "passed connection"
4577 .cindex "SMTP" "multiple deliveries"
4578 .cindex "multiple SMTP deliveries"
4579 the delivery process spawns other processes to deliver other messages down
4580 passed SMTP connections, the queue runner waits for these to finish before
4581 proceeding.
4582
4583 When all the queued messages have been considered, the original queue runner
4584 process terminates. In other words, a single pass is made over the waiting
4585 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4586 this to be repeated periodically.
4587
4588 Exim processes the waiting messages in an unpredictable order. It isn't very
4589 random, but it is likely to be different each time, which is all that matters.
4590 If one particular message screws up a remote MTA, other messages to the same
4591 MTA have a chance of getting through if they get tried first.
4592
4593 It is possible to cause the messages to be processed in lexical message id
4594 order, which is essentially the order in which they arrived, by setting the
4595 &%queue_run_in_order%& option, but this is not recommended for normal use.
4596
4597 .vitem &%-q%&<&'qflags'&>
4598 The &%-q%& option may be followed by one or more flag letters that change its
4599 behaviour. They are all optional, but if more than one is present, they must
4600 appear in the correct order. Each flag is described in a separate item below.
4601
4602 .vitem &%-qq...%&
4603 .oindex "&%-qq%&"
4604 .cindex "queue" "double scanning"
4605 .cindex "queue" "routing"
4606 .cindex "routing" "whole queue before delivery"
4607 .cindex "first pass routing"
4608 .cindex "queue runner" "two phase"
4609 An option starting with &%-qq%& requests a two-stage queue run. In the first
4610 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4611 every domain. Addresses are routed, local deliveries happen, but no remote
4612 transports are run.
4613
4614 Performance will be best if the &%queue_run_in_order%& option is false.
4615 If that is so and the &%queue_fast_ramp%& option is true then
4616 in the first phase of the run,
4617 once a threshold number of messages are routed for a given host,
4618 a delivery process is forked in parallel with the rest of the scan.
4619
4620 .cindex "hints database" "remembering routing"
4621 The hints database that remembers which messages are waiting for specific hosts
4622 is updated, as if delivery to those hosts had been deferred. After this is
4623 complete, a second, normal queue scan happens, with routing and delivery taking
4624 place as normal. Messages that are routed to the same host should mostly be
4625 delivered down a single SMTP
4626 .cindex "SMTP" "passed connection"
4627 .cindex "SMTP" "multiple deliveries"
4628 .cindex "multiple SMTP deliveries"
4629 connection because of the hints that were set up during the first queue scan.
4630 This option may be useful for hosts that are connected to the Internet
4631 intermittently.
4632
4633 .vitem &%-q[q]i...%&
4634 .oindex "&%-qi%&"
4635 .cindex "queue" "initial delivery"
4636 If the &'i'& flag is present, the queue runner runs delivery processes only for
4637 those messages that haven't previously been tried. (&'i'& stands for &"initial
4638 delivery"&.) This can be helpful if you are putting messages in the queue using
4639 &%-odq%& and want a queue runner just to process the new messages.
4640
4641 .vitem &%-q[q][i]f...%&
4642 .oindex "&%-qf%&"
4643 .cindex "queue" "forcing delivery"
4644 .cindex "delivery" "forcing in queue run"
4645 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4646 message, whereas without &'f'& only those non-frozen addresses that have passed
4647 their retry times are tried.
4648
4649 .vitem &%-q[q][i]ff...%&
4650 .oindex "&%-qff%&"
4651 .cindex "frozen messages" "forcing delivery"
4652 If &'ff'& is present, a delivery attempt is forced for every message, whether
4653 frozen or not.
4654
4655 .vitem &%-q[q][i][f[f]]l%&
4656 .oindex "&%-ql%&"
4657 .cindex "queue" "local deliveries only"
4658 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4659 be done. If a message requires any remote deliveries, it remains in the queue
4660 for later delivery.
4661
4662 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4663 .oindex "&%-qG%&"
4664 .cindex queue named
4665 .cindex "named queues"  "deliver from"
4666 .cindex "queue" "delivering specific messages"
4667 If the &'G'& flag and a name is present, the queue runner operates on the
4668 queue with the given name rather than the default queue.
4669 The name should not contain a &'/'& character.
4670 For a periodic queue run (see below)
4671 append to the name a slash and a time value.
4672
4673 If other commandline options specify an action, a &'-qG<name>'& option
4674 will specify a queue to operate on.
4675 For example:
4676 .code
4677 exim -bp -qGquarantine
4678 mailq -qGquarantine
4679 exim -qGoffpeak -Rf @special.domain.example
4680 .endd
4681
4682 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4683 When scanning the queue, Exim can be made to skip over messages whose ids are
4684 lexically less than a given value by following the &%-q%& option with a
4685 starting message id. For example:
4686 .code
4687 exim -q 0t5C6f-0000c8-00
4688 .endd
4689 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4690 second message id is given, messages whose ids are lexically greater than it
4691 are also skipped. If the same id is given twice, for example,
4692 .code
4693 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4694 .endd
4695 just one delivery process is started, for that message. This differs from
4696 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4697 that it counts as a delivery from a queue run. Note that the selection
4698 mechanism does not affect the order in which the messages are scanned. There
4699 are also other ways of selecting specific sets of messages for delivery in a
4700 queue run &-- see &%-R%& and &%-S%&.
4701
4702 .vitem &%-q%&<&'qflags'&><&'time'&>
4703 .cindex "queue runner" "starting periodically"
4704 .cindex "periodic queue running"
4705 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4706 starting a queue runner process at intervals specified by the given time value
4707 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4708 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4709 single daemon process handles both functions. A common way of starting up a
4710 combined daemon at system boot time is to use a command such as
4711 .code
4712 /usr/exim/bin/exim -bd -q30m
4713 .endd
4714 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4715 process every 30 minutes.
4716
4717 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4718 pid file is written unless one is explicitly requested by the &%-oP%& option.
4719
4720 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4721 .oindex "&%-qR%&"
4722 This option is synonymous with &%-R%&. It is provided for Sendmail
4723 compatibility.
4724
4725 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4726 .oindex "&%-qS%&"
4727 This option is synonymous with &%-S%&.
4728
4729 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4730 .oindex "&%-R%&"
4731 .cindex "queue runner" "for specific recipients"
4732 .cindex "delivery" "to given domain"
4733 .cindex "domain" "delivery to"
4734 The <&'rsflags'&> may be empty, in which case the white space before the string
4735 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4736 which are the possible values for <&'rsflags'&>. White space is required if
4737 <&'rsflags'&> is not empty.
4738
4739 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4740 perform a single queue run, except that, when scanning the messages on the
4741 queue, Exim processes only those that have at least one undelivered recipient
4742 address containing the given string, which is checked in a case-independent
4743 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4744 regular expression; otherwise it is a literal string.
4745
4746 If you want to do periodic queue runs for messages with specific recipients,
4747 you can combine &%-R%& with &%-q%& and a time value. For example:
4748 .code
4749 exim -q25m -R @special.domain.example
4750 .endd
4751 This example does a queue run for messages with recipients in the given domain
4752 every 25 minutes. Any additional flags that are specified with &%-q%& are
4753 applied to each queue run.
4754
4755 Once a message is selected for delivery by this mechanism, all its addresses
4756 are processed. For the first selected message, Exim overrides any retry
4757 information and forces a delivery attempt for each undelivered address. This
4758 means that if delivery of any address in the first message is successful, any
4759 existing retry information is deleted, and so delivery attempts for that
4760 address in subsequently selected messages (which are processed without forcing)
4761 will run. However, if delivery of any address does not succeed, the retry
4762 information is updated, and in subsequently selected messages, the failing
4763 address will be skipped.
4764
4765 .cindex "frozen messages" "forcing delivery"
4766 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4767 all selected messages, not just the first; frozen messages are included when
4768 &'ff'& is present.
4769
4770 The &%-R%& option makes it straightforward to initiate delivery of all messages
4771 to a given domain after a host has been down for some time. When the SMTP
4772 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4773 effect is to run Exim with the &%-R%& option, but it can be configured to run
4774 an arbitrary command instead.
4775
4776 .vitem &%-r%&
4777 .oindex "&%-r%&"
4778 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4779
4780 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4781 .oindex "&%-S%&"
4782 .cindex "delivery" "from given sender"
4783 .cindex "queue runner" "for specific senders"
4784 This option acts like &%-R%& except that it checks the string against each
4785 message's sender instead of against the recipients. If &%-R%& is also set, both
4786 conditions must be met for a message to be selected. If either of the options
4787 has &'f'& or &'ff'& in its flags, the associated action is taken.
4788
4789 .vitem &%-Tqt%&&~<&'times'&>
4790 .oindex "&%-Tqt%&"
4791 This is an option that is exclusively for use by the Exim testing suite. It is not
4792 recognized when Exim is run normally. It allows for the setting up of explicit
4793 &"queue times"& so that various warning/retry features can be tested.
4794
4795 .vitem &%-t%&
4796 .oindex "&%-t%&"
4797 .cindex "recipient" "extracting from header lines"
4798 .chindex Bcc:
4799 .chindex Cc:
4800 .chindex To:
4801 When Exim is receiving a locally-generated, non-SMTP message on its standard
4802 input, the &%-t%& option causes the recipients of the message to be obtained
4803 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4804 from the command arguments. The addresses are extracted before any rewriting
4805 takes place and the &'Bcc:'& header line, if present, is then removed.
4806
4807 .cindex "Sendmail compatibility" "&%-t%& option"
4808 If the command has any arguments, they specify addresses to which the message
4809 is &'not'& to be delivered. That is, the argument addresses are removed from
4810 the recipients list obtained from the headers. This is compatible with Smail 3
4811 and in accordance with the documented behaviour of several versions of
4812 Sendmail, as described in man pages on a number of operating systems (e.g.
4813 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4814 argument addresses to those obtained from the headers, and the O'Reilly
4815 Sendmail book documents it that way. Exim can be made to add argument addresses
4816 instead of subtracting them by setting the option
4817 &%extract_addresses_remove_arguments%& false.
4818
4819 .cindex "&%Resent-%& header lines" "with &%-t%&"
4820 If there are any &%Resent-%& header lines in the message, Exim extracts
4821 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4822 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4823 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4824 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4825
4826 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4827 message is resent several times). The RFC also specifies that they should be
4828 added at the front of the message, and separated by &'Received:'& lines. It is
4829 not at all clear how &%-t%& should operate in the present of multiple sets,
4830 nor indeed exactly what constitutes a &"set"&.
4831 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4832 are often added at the end of the header, and if a message is resent more than
4833 once, it is common for the original set of &%Resent-%& headers to be renamed as
4834 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4835
4836 .vitem &%-ti%&
4837 .oindex "&%-ti%&"
4838 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4839 compatibility with Sendmail.
4840
4841 .vitem &%-tls-on-connect%&
4842 .oindex "&%-tls-on-connect%&"
4843 .cindex "TLS" "use without STARTTLS"
4844 .cindex "TLS" "automatic start"
4845 This option is available when Exim is compiled with TLS support. It forces all
4846 incoming SMTP connections to behave as if the incoming port is listed in the
4847 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4848 &<<CHAPTLS>>& for further details.
4849
4850
4851 .vitem &%-U%&
4852 .oindex "&%-U%&"
4853 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4854 Sendmail uses this option for &"initial message submission"&, and its
4855 documentation states that in future releases, it may complain about
4856 syntactically invalid messages rather than fixing them when this flag is not
4857 set. Exim ignores this option.
4858
4859 .vitem &%-v%&
4860 .oindex "&%-v%&"
4861 This option causes Exim to write information to the standard error stream,
4862 describing what it is doing. In particular, it shows the log lines for
4863 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4864 dialogue is shown. Some of the log lines shown may not actually be written to
4865 the log if the setting of &%log_selector%& discards them. Any relevant
4866 selectors are shown with each log line. If none are shown, the logging is
4867 unconditional.
4868
4869 .vitem &%-x%&
4870 .oindex "&%-x%&"
4871 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4872 National Language Support extended characters in the body of the mail item"&).
4873 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4874 this option.
4875
4876 .vitem &%-X%&&~<&'logfile'&>
4877 .oindex "&%-X%&"
4878 This option is interpreted by Sendmail to cause debug information to be sent
4879 to the named file.  It is ignored by Exim.
4880
4881 .vitem &%-z%&&~<&'log-line'&>
4882 .oindex "&%-z%&"
4883 This option writes its argument to Exim's logfile.
4884 Use is restricted to administrators; the intent is for operational notes.
4885 Quotes should be used to maintain a multi-word item as a single argument,
4886 under most shells.
4887 .endlist
4888
4889 .ecindex IIDclo1
4890 .ecindex IIDclo2
4891
4892
4893 . ////////////////////////////////////////////////////////////////////////////
4894 . Insert a stylized DocBook comment here, to identify the end of the command
4895 . line options. This is for the benefit of the Perl script that automatically
4896 . creates a man page for the options.
4897 . ////////////////////////////////////////////////////////////////////////////
4898
4899 .literal xml
4900 <!-- === End of command line options === -->
4901 .literal off
4902
4903
4904
4905
4906
4907 . ////////////////////////////////////////////////////////////////////////////
4908 . ////////////////////////////////////////////////////////////////////////////
4909
4910
4911 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4912          "The runtime configuration file"
4913
4914 .cindex "runtime configuration"
4915 .cindex "configuration file" "general description"
4916 .cindex "CONFIGURE_FILE"
4917 .cindex "configuration file" "errors in"
4918 .cindex "error" "in configuration file"
4919 .cindex "return code" "for bad configuration"
4920 Exim uses a single runtime configuration file that is read whenever an Exim
4921 binary is executed. Note that in normal operation, this happens frequently,
4922 because Exim is designed to operate in a distributed manner, without central
4923 control.
4924
4925 If a syntax error is detected while reading the configuration file, Exim
4926 writes a message on the standard error, and exits with a non-zero return code.
4927 The message is also written to the panic log. &*Note*&: Only simple syntax
4928 errors can be detected at this time. The values of any expanded options are
4929 not checked until the expansion happens, even when the expansion does not
4930 actually alter the string.
4931
4932 The name of the configuration file is compiled into the binary for security
4933 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4934 most configurations, this specifies a single file. However, it is permitted to
4935 give a colon-separated list of filenames, in which case Exim uses the first
4936 existing file in the list.
4937
4938 .cindex "EXIM_USER"
4939 .cindex "EXIM_GROUP"
4940 .cindex "CONFIGURE_OWNER"
4941 .cindex "CONFIGURE_GROUP"
4942 .cindex "configuration file" "ownership"
4943 .cindex "ownership" "configuration file"
4944 The runtime configuration file must be owned by root or by the user that is
4945 specified at compile time by the CONFIGURE_OWNER option (if set). The
4946 configuration file must not be world-writeable, or group-writeable unless its
4947 group is the root group or the one specified at compile time by the
4948 CONFIGURE_GROUP option.
4949
4950 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4951 to root, anybody who is able to edit the runtime configuration file has an
4952 easy way to run commands as root. If you specify a user or group in the
4953 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4954 who are members of that group will trivially be able to obtain root privileges.
4955
4956 Up to Exim version 4.72, the runtime configuration file was also permitted to
4957 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4958 since it offered a simple privilege escalation for any attacker who managed to
4959 compromise the Exim user account.
4960
4961 A default configuration file, which will work correctly in simple situations,
4962 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4963 defines just one filename, the installation process copies the default
4964 configuration to a new file of that name if it did not previously exist. If
4965 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4966 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4967 configuration.
4968
4969
4970
4971 .section "Using a different configuration file" "SECID40"
4972 .cindex "configuration file" "alternate"
4973 A one-off alternate configuration can be specified by the &%-C%& command line
4974 option, which may specify a single file or a list of files. However, when
4975 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4976 unless the argument for &%-C%& is identical to the built-in value from
4977 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4978 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4979 is useful mainly for checking the syntax of configuration files before
4980 installing them. No owner or group checks are done on a configuration file
4981 specified by &%-C%&, if root privilege has been dropped.
4982
4983 Even the Exim user is not trusted to specify an arbitrary configuration file
4984 with the &%-C%& option to be used with root privileges, unless that file is
4985 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4986 testing a configuration using &%-C%& right through message reception and
4987 delivery, even if the caller is root. The reception works, but by that time,
4988 Exim is running as the Exim user, so when it re-execs to regain privilege for
4989 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4990 can test reception and delivery using two separate commands (one to put a
4991 message in the queue, using &%-odq%&, and another to do the delivery, using
4992 &%-M%&).
4993
4994 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4995 prefix string with which any file named in a &%-C%& command line option must
4996 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4997 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4998 filename can be used with &%-C%&.
4999
5000 One-off changes to a configuration can be specified by the &%-D%& command line
5001 option, which defines and overrides values for macros used inside the
5002 configuration file. However, like &%-C%&, the use of this option by a
5003 non-privileged user causes Exim to discard its root privilege.
5004 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
5005 completely disabled, and its use causes an immediate error exit.
5006
5007 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
5008 to declare certain macro names trusted, such that root privilege will not
5009 necessarily be discarded.
5010 WHITELIST_D_MACROS defines a colon-separated list of macros which are
5011 considered safe and, if &%-D%& only supplies macros from this list, and the
5012 values are acceptable, then Exim will not give up root privilege if the caller
5013 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
5014 transition mechanism and is expected to be removed in the future.  Acceptable
5015 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
5016
5017 Some sites may wish to use the same Exim binary on different machines that
5018 share a file system, but to use different configuration files on each machine.
5019 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
5020 looks for a file whose name is the configuration filename followed by a dot
5021 and the machine's node name, as obtained from the &[uname()]& function. If this
5022 file does not exist, the standard name is tried. This processing occurs for
5023 each filename in the list given by CONFIGURE_FILE or &%-C%&.
5024
5025 In some esoteric situations different versions of Exim may be run under
5026 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
5027 help with this. See the comments in &_src/EDITME_& for details.
5028
5029
5030
5031 .section "Configuration file format" "SECTconffilfor"
5032 .cindex "configuration file" "format of"
5033 .cindex "format" "configuration file"
5034 Exim's configuration file is divided into a number of different parts. General
5035 option settings must always appear at the start of the file. The other parts
5036 are all optional, and may appear in any order. Each part other than the first
5037 is introduced by the word &"begin"& followed by at least one literal
5038 space, and the name of the part. The optional parts are:
5039
5040 .ilist
5041 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
5042 &<<CHAPACL>>&).
5043 .next
5044 .cindex "AUTH" "configuration"
5045 &'authenticators'&: Configuration settings for the authenticator drivers. These
5046 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
5047 .next
5048 &'routers'&: Configuration settings for the router drivers. Routers process
5049 addresses and determine how the message is to be delivered (see chapters
5050 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
5051 .next
5052 &'transports'&: Configuration settings for the transport drivers. Transports
5053 define mechanisms for copying messages to destinations (see chapters
5054 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
5055 .next
5056 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
5057 If there is no retry section, or if it is empty (that is, no retry rules are
5058 defined), Exim will not retry deliveries. In this situation, temporary errors
5059 are treated the same as permanent errors. Retry rules are discussed in chapter
5060 &<<CHAPretry>>&.
5061 .next
5062 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
5063 when new addresses are generated during delivery. Rewriting is discussed in
5064 chapter &<<CHAPrewrite>>&.
5065 .next
5066 &'local_scan'&: Private options for the &[local_scan()]& function. If you
5067 want to use this feature, you must set
5068 .code
5069 LOCAL_SCAN_HAS_OPTIONS=yes
5070 .endd
5071 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
5072 facility are given in chapter &<<CHAPlocalscan>>&.
5073 .endlist
5074
5075 .cindex "configuration file" "leading white space in"
5076 .cindex "configuration file" "trailing white space in"
5077 .cindex "white space" "in configuration file"
5078 Leading and trailing white space in configuration lines is always ignored.
5079
5080 Blank lines in the file, and lines starting with a # character (ignoring
5081 leading white space) are treated as comments and are ignored. &*Note*&: A
5082 # character other than at the beginning of a line is not treated specially,
5083 and does not introduce a comment.
5084
5085 Any non-comment line can be continued by ending it with a backslash. Note that
5086 the general rule for white space means that trailing white space after the
5087 backslash and leading white space at the start of continuation
5088 lines is ignored. Comment lines beginning with # (but not empty lines) may
5089 appear in the middle of a sequence of continuation lines.
5090
5091 A convenient way to create a configuration file is to start from the
5092 default, which is supplied in &_src/configure.default_&, and add, delete, or
5093 change settings as required.
5094
5095 The ACLs, retry rules, and rewriting rules have their own syntax which is
5096 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5097 respectively. The other parts of the configuration file have some syntactic
5098 items in common, and these are described below, from section &<<SECTcos>>&
5099 onwards. Before that, the inclusion, macro, and conditional facilities are
5100 described.
5101
5102
5103
5104 .section "File inclusions in the configuration file" "SECID41"
5105 .cindex "inclusions in configuration file"
5106 .cindex "configuration file" "including other files"
5107 .cindex "&`.include`& in configuration file"
5108 .cindex "&`.include_if_exists`& in configuration file"
5109 You can include other files inside Exim's runtime configuration file by
5110 using this syntax:
5111 .display
5112 &`.include`& <&'filename'&>
5113 &`.include_if_exists`& <&'filename'&>
5114 .endd
5115 on a line by itself. Double quotes round the filename are optional. If you use
5116 the first form, a configuration error occurs if the file does not exist; the
5117 second form does nothing for non-existent files.
5118 The first form allows a relative name. It is resolved relative to
5119 the directory of the including file. For the second form an absolute filename
5120 is required.
5121
5122 Includes may be nested to any depth, but remember that Exim reads its
5123 configuration file often, so it is a good idea to keep them to a minimum.
5124 If you change the contents of an included file, you must HUP the daemon,
5125 because an included file is read only when the configuration itself is read.
5126
5127 The processing of inclusions happens early, at a physical line level, so, like
5128 comment lines, an inclusion can be used in the middle of an option setting,
5129 for example:
5130 .code
5131 hosts_lookup = a.b.c \
5132                .include /some/file
5133 .endd
5134 Include processing happens after macro processing (see below). Its effect is to
5135 process the lines of the included file as if they occurred inline where the
5136 inclusion appears.
5137
5138
5139
5140 .section "Macros in the configuration file" "SECTmacrodefs"
5141 .cindex "macro" "description of"
5142 .cindex "configuration file" "macros"
5143 If a line in the main part of the configuration (that is, before the first
5144 &"begin"& line) begins with an upper case letter, it is taken as a macro
5145 definition, and must be of the form
5146 .display
5147 <&'name'&> = <&'rest of line'&>
5148 .endd
5149 The name must consist of letters, digits, and underscores, and need not all be
5150 in upper case, though that is recommended. The rest of the line, including any
5151 continuations, is the replacement text, and has leading and trailing white
5152 space removed. Quotes are not removed. The replacement text can never end with
5153 a backslash character, but this doesn't seem to be a serious limitation.
5154
5155 Macros may also be defined between router, transport, authenticator, or ACL
5156 definitions. They may not, however, be defined within an individual driver or
5157 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5158
5159 .section "Macro substitution" "SECID42"
5160 Once a macro is defined, all subsequent lines in the file (and any included
5161 files) are scanned for the macro name; if there are several macros, the line is
5162 scanned for each, in turn, in the order in which the macros are defined. The
5163 replacement text is not re-scanned for the current macro, though it is scanned
5164 for subsequently defined macros. For this reason, a macro name may not contain
5165 the name of a previously defined macro as a substring. You could, for example,
5166 define
5167 .display
5168 &`ABCD_XYZ = `&<&'something'&>
5169 &`ABCD = `&<&'something else'&>
5170 .endd
5171 but putting the definitions in the opposite order would provoke a configuration
5172 error. Macro expansion is applied to individual physical lines from the file,
5173 before checking for line continuation or file inclusion (see above). If a line
5174 consists solely of a macro name, and the expansion of the macro is empty, the
5175 line is ignored. A macro at the start of a line may turn the line into a
5176 comment line or a &`.include`& line.
5177
5178
5179 .section "Redefining macros" "SECID43"
5180 Once defined, the value of a macro can be redefined later in the configuration
5181 (or in an included file). Redefinition is specified by using &'=='& instead of
5182 &'='&. For example:
5183 .code
5184 MAC =  initial value
5185 ...
5186 MAC == updated value
5187 .endd
5188 Redefinition does not alter the order in which the macros are applied to the
5189 subsequent lines of the configuration file. It is still the same order in which
5190 the macros were originally defined. All that changes is the macro's value.
5191 Redefinition makes it possible to accumulate values. For example:
5192 .code
5193 MAC =  initial value
5194 ...
5195 MAC == MAC and something added
5196 .endd
5197 This can be helpful in situations where the configuration file is built
5198 from a number of other files.
5199
5200 .section "Overriding macro values" "SECID44"
5201 The values set for macros in the configuration file can be overridden by the
5202 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5203 used, unless called by root or the Exim user. A definition on the command line
5204 using the &%-D%& option causes all definitions and redefinitions within the
5205 file to be ignored.
5206
5207
5208
5209 .section "Example of macro usage" "SECID45"
5210 As an example of macro usage, consider a configuration where aliases are looked
5211 up in a MySQL database. It helps to keep the file less cluttered if long
5212 strings such as SQL statements are defined separately as macros, for example:
5213 .code
5214 ALIAS_QUERY = select mailbox from user where \
5215               login='${quote_mysql:$local_part}';
5216 .endd
5217 This can then be used in a &(redirect)& router setting like this:
5218 .code
5219 data = ${lookup mysql{ALIAS_QUERY}}
5220 .endd
5221 In earlier versions of Exim macros were sometimes used for domain, host, or
5222 address lists. In Exim 4 these are handled better by named lists &-- see
5223 section &<<SECTnamedlists>>&.
5224
5225
5226 .section "Builtin macros" "SECTbuiltinmacros"
5227 Exim defines some macros depending on facilities available, which may
5228 differ due to build-time definitions and from one release to another.
5229 All of these macros start with an underscore.
5230 They can be used to conditionally include parts of a configuration
5231 (see below).
5232
5233 The following classes of macros are defined:
5234 .display
5235 &` _HAVE_*                    `&  build-time defines
5236 &` _DRIVER_ROUTER_*           `&  router drivers
5237 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5238 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5239 &` _LOG_*                     `&  log_selector values
5240 &` _OPT_MAIN_*                `&  main config options
5241 &` _OPT_ROUTERS_*             `&  generic router options
5242 &` _OPT_TRANSPORTS_*          `&  generic transport options
5243 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5244 &` _OPT_ROUTER_*_*            `&  private router options
5245 &` _OPT_TRANSPORT_*_*         `&  private transport options
5246 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5247 .endd
5248
5249 Use an &"exim -bP macros"& command to get the list of macros.
5250
5251
5252 .section "Conditional skips in the configuration file" "SECID46"
5253 .cindex "configuration file" "conditional skips"
5254 .cindex "&`.ifdef`&"
5255 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5256 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5257 portions of the configuration file. The processing happens whenever the file is
5258 read (that is, when an Exim binary starts to run).
5259
5260 The implementation is very simple. Instances of the first four directives must
5261 be followed by text that includes the names of one or macros. The condition
5262 that is tested is whether or not any macro substitution has taken place in the
5263 line. Thus:
5264 .code
5265 .ifdef AAA
5266 message_size_limit = 50M
5267 .else
5268 message_size_limit = 100M
5269 .endif
5270 .endd
5271 sets a message size limit of 50M if the macro &`AAA`& is defined
5272 (or &`A`& or &`AA`&), and 100M
5273 otherwise. If there is more than one macro named on the line, the condition
5274 is true if any of them are defined. That is, it is an &"or"& condition. To
5275 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5276
5277 Although you can use a macro expansion to generate one of these directives,
5278 it is not very useful, because the condition &"there was a macro substitution
5279 in this line"& will always be true.
5280
5281 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5282 to clarify complicated nestings.
5283
5284
5285
5286 .section "Common option syntax" "SECTcos"
5287 .cindex "common option syntax"
5288 .cindex "syntax of common options"
5289 .cindex "configuration file" "common option syntax"
5290 For the main set of options, driver options, and &[local_scan()]& options,
5291 each setting is on a line by itself, and starts with a name consisting of
5292 lower-case letters and underscores. Many options require a data value, and in
5293 these cases the name must be followed by an equals sign (with optional white
5294 space) and then the value. For example:
5295 .code
5296 qualify_domain = mydomain.example.com
5297 .endd
5298 .cindex "hiding configuration option values"
5299 .cindex "configuration options" "hiding value of"
5300 .cindex "options" "hiding value of"
5301 Some option settings may contain sensitive data, for example, passwords for
5302 accessing databases. To stop non-admin users from using the &%-bP%& command
5303 line option to read these values, you can precede the option settings with the
5304 word &"hide"&. For example:
5305 .code
5306 hide mysql_servers = localhost/users/admin/secret-password
5307 .endd
5308 For non-admin users, such options are displayed like this:
5309 .code
5310 mysql_servers = <value not displayable>
5311 .endd
5312 If &"hide"& is used on a driver option, it hides the value of that option on
5313 all instances of the same driver.
5314
5315 The following sections describe the syntax used for the different data types
5316 that are found in option settings.
5317
5318
5319 .section "Boolean options" "SECID47"
5320 .cindex "format" "boolean"
5321 .cindex "boolean configuration values"
5322 .oindex "&%no_%&&'xxx'&"
5323 .oindex "&%not_%&&'xxx'&"
5324 Options whose type is given as boolean are on/off switches. There are two
5325 different ways of specifying such options: with and without a data value. If
5326 the option name is specified on its own without data, the switch is turned on;
5327 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5328 boolean options may be followed by an equals sign and one of the words
5329 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5330 the following two settings have exactly the same effect:
5331 .code
5332 queue_only
5333 queue_only = true
5334 .endd
5335 The following two lines also have the same (opposite) effect:
5336 .code
5337 no_queue_only
5338 queue_only = false
5339 .endd
5340 You can use whichever syntax you prefer.
5341
5342
5343
5344
5345 .section "Integer values" "SECID48"
5346 .cindex "integer configuration values"
5347 .cindex "format" "integer"
5348 If an option's type is given as &"integer"&, the value can be given in decimal,
5349 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5350 number is assumed. Otherwise, it is treated as an octal number unless it starts
5351 with the characters &"0x"&, in which case the remainder is interpreted as a
5352 hexadecimal number.
5353
5354 If an integer value is followed by the letter K, it is multiplied by 1024; if
5355 it is followed by the letter M, it is multiplied by 1024x1024;
5356 if by the letter G, 1024x1024x1024.
5357 When the values
5358 of integer option settings are output, values which are an exact multiple of
5359 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5360 and M. The printing style is independent of the actual input format that was
5361 used.
5362
5363
5364 .section "Octal integer values" "SECID49"
5365 .cindex "integer format"
5366 .cindex "format" "octal integer"
5367 If an option's type is given as &"octal integer"&, its value is always
5368 interpreted as an octal number, whether or not it starts with the digit zero.
5369 Such options are always output in octal.
5370
5371
5372 .section "Fixed point numbers" "SECID50"
5373 .cindex "fixed point configuration values"
5374 .cindex "format" "fixed point"
5375 If an option's type is given as &"fixed-point"&, its value must be a decimal
5376 integer, optionally followed by a decimal point and up to three further digits.
5377
5378
5379
5380 .section "Time intervals" "SECTtimeformat"
5381 .cindex "time interval" "specifying in configuration"
5382 .cindex "format" "time interval"
5383 A time interval is specified as a sequence of numbers, each followed by one of
5384 the following letters, with no intervening white space:
5385
5386 .table2 30pt
5387 .irow &%s%& seconds
5388 .irow &%m%& minutes
5389 .irow &%h%& hours
5390 .irow &%d%& days
5391 .irow &%w%& weeks
5392 .endtable
5393
5394 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5395 intervals are output in the same format. Exim does not restrict the values; it
5396 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5397
5398
5399
5400 .section "String values" "SECTstrings"
5401 .cindex "string" "format of configuration values"
5402 .cindex "format" "string"
5403 If an option's type is specified as &"string"&, the value can be specified with
5404 or without double-quotes. If it does not start with a double-quote, the value
5405 consists of the remainder of the line plus any continuation lines, starting at
5406 the first character after any leading white space, with trailing white space
5407 removed, and with no interpretation of the characters in the string. Because
5408 Exim removes comment lines (those beginning with #) at an early stage, they can
5409 appear in the middle of a multi-line string. The following two settings are
5410 therefore equivalent:
5411 .code
5412 trusted_users = uucp:mail
5413 trusted_users = uucp:\
5414                 # This comment line is ignored
5415                 mail
5416 .endd
5417 .cindex "string" "quoted"
5418 .cindex "escape characters in quoted strings"
5419 If a string does start with a double-quote, it must end with a closing
5420 double-quote, and any backslash characters other than those used for line
5421 continuation are interpreted as escape characters, as follows:
5422
5423 .table2 100pt
5424 .irow &`\\`&                     "single backslash"
5425 .irow &`\n`&                     "newline"
5426 .irow &`\r`&                     "carriage return"
5427 .irow &`\t`&                     "tab"
5428 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5429 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5430                                    character"
5431 .endtable
5432
5433 If a backslash is followed by some other character, including a double-quote
5434 character, that character replaces the pair.
5435
5436 Quoting is necessary only if you want to make use of the backslash escapes to
5437 insert special characters, or if you need to specify a value with leading or
5438 trailing spaces. These cases are rare, so quoting is almost never needed in
5439 current versions of Exim. In versions of Exim before 3.14, quoting was required
5440 in order to continue lines, so you may come across older configuration files
5441 and examples that apparently quote unnecessarily.
5442
5443
5444 .section "Expanded strings" "SECID51"
5445 .cindex "expansion" "definition of"
5446 Some strings in the configuration file are subjected to &'string expansion'&,
5447 by which means various parts of the string may be changed according to the
5448 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5449 is as just described; in particular, the handling of backslashes in quoted
5450 strings is done as part of the input process, before expansion takes place.
5451 However, backslash is also an escape character for the expander, so any
5452 backslashes that are required for that reason must be doubled if they are
5453 within a quoted configuration string.
5454
5455
5456 .section "User and group names" "SECID52"
5457 .cindex "user name" "format of"
5458 .cindex "format" "user name"
5459 .cindex "groups" "name format"
5460 .cindex "format" "group name"
5461 User and group names are specified as strings, using the syntax described
5462 above, but the strings are interpreted specially. A user or group name must
5463 either consist entirely of digits, or be a name that can be looked up using the
5464 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5465
5466
5467 .section "List construction" "SECTlistconstruct"
5468 .cindex "list" "syntax of in configuration"
5469 .cindex "format" "list item in configuration"
5470 .cindex "string" "list, definition of"
5471 The data for some configuration options is a list of items, with colon as the
5472 default separator. Many of these options are shown with type &"string list"& in
5473 the descriptions later in this document. Others are listed as &"domain list"&,
5474 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5475 are all the same; however, those other than &"string list"& are subject to
5476 particular kinds of interpretation, as described in chapter
5477 &<<CHAPdomhosaddlists>>&.
5478
5479 In all these cases, the entire list is treated as a single string as far as the
5480 input syntax is concerned. The &%trusted_users%& setting in section
5481 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5482 in a list, it must be entered as two colons. Leading and trailing white space
5483 on each item in a list is ignored. This makes it possible to include items that
5484 start with a colon, and in particular, certain forms of IPv6 address. For
5485 example, the list
5486 .code
5487 local_interfaces = 127.0.0.1 : ::::1
5488 .endd
5489 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5490
5491 &*Note*&: Although leading and trailing white space is ignored in individual
5492 list items, it is not ignored when parsing the list. The spaces around the first
5493 colon in the example above are necessary. If they were not there, the list would
5494 be interpreted as the two items 127.0.0.1:: and 1.
5495
5496 .section "Changing list separators" "SECTlistsepchange"
5497 .cindex "list separator" "changing"
5498 .cindex "IPv6" "addresses in lists"
5499 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5500 introduced to allow the separator character to be changed. If a list begins
5501 with a left angle bracket, followed by any punctuation character, that
5502 character is used instead of colon as the list separator. For example, the list
5503 above can be rewritten to use a semicolon separator like this:
5504 .code
5505 local_interfaces = <; 127.0.0.1 ; ::1
5506 .endd
5507 This facility applies to all lists, with the exception of the list in
5508 &%log_file_path%&. It is recommended that the use of non-colon separators be
5509 confined to circumstances where they really are needed.
5510
5511 .cindex "list separator" "newline as"
5512 .cindex "newline" "as list separator"
5513 It is also possible to use newline and other control characters (those with
5514 code values less than 32, plus DEL) as separators in lists. Such separators
5515 must be provided literally at the time the list is processed. For options that
5516 are string-expanded, you can write the separator using a normal escape
5517 sequence. This will be processed by the expander before the string is
5518 interpreted as a list. For example, if a newline-separated list of domains is
5519 generated by a lookup, you can process it directly by a line such as this:
5520 .code
5521 domains = <\n ${lookup mysql{.....}}
5522 .endd
5523 This avoids having to change the list separator in such data. You are unlikely
5524 to want to use a control character as a separator in an option that is not
5525 expanded, because the value is literal text. However, it can be done by giving
5526 the value in quotes. For example:
5527 .code
5528 local_interfaces = "<\n 127.0.0.1 \n ::1"
5529 .endd
5530 Unlike printing character separators, which can be included in list items by
5531 doubling, it is not possible to include a control character as data when it is
5532 set as the separator. Two such characters in succession are interpreted as
5533 enclosing an empty list item.
5534
5535
5536
5537 .section "Empty items in lists" "SECTempitelis"
5538 .cindex "list" "empty item in"
5539 An empty item at the end of a list is always ignored. In other words, trailing
5540 separator characters are ignored. Thus, the list in
5541 .code
5542 senders = user@domain :
5543 .endd
5544 contains only a single item. If you want to include an empty string as one item
5545 in a list, it must not be the last item. For example, this list contains three
5546 items, the second of which is empty:
5547 .code
5548 senders = user1@domain : : user2@domain
5549 .endd
5550 &*Note*&: There must be white space between the two colons, as otherwise they
5551 are interpreted as representing a single colon data character (and the list
5552 would then contain just one item). If you want to specify a list that contains
5553 just one, empty item, you can do it as in this example:
5554 .code
5555 senders = :
5556 .endd
5557 In this case, the first item is empty, and the second is discarded because it
5558 is at the end of the list.
5559
5560
5561
5562
5563 .section "Format of driver configurations" "SECTfordricon"
5564 .cindex "drivers" "configuration format"
5565 There are separate parts in the configuration for defining routers, transports,
5566 and authenticators. In each part, you are defining a number of driver
5567 instances, each with its own set of options. Each driver instance is defined by
5568 a sequence of lines like this:
5569 .display
5570 <&'instance name'&>:
5571   <&'option'&>
5572   ...
5573   <&'option'&>
5574 .endd
5575 In the following example, the instance name is &(localuser)&, and it is
5576 followed by three options settings:
5577 .code
5578 localuser:
5579   driver = accept
5580   check_local_user
5581   transport = local_delivery
5582 .endd
5583 For each driver instance, you specify which Exim code module it uses &-- by the
5584 setting of the &%driver%& option &-- and (optionally) some configuration
5585 settings. For example, in the case of transports, if you want a transport to
5586 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5587 a local file you would use the &(appendfile)& driver. Each of the drivers is
5588 described in detail in its own separate chapter later in this manual.
5589
5590 You can have several routers, transports, or authenticators that are based on
5591 the same underlying driver (each must have a different instance name).
5592
5593 The order in which routers are defined is important, because addresses are
5594 passed to individual routers one by one, in order. The order in which
5595 transports are defined does not matter at all. The order in which
5596 authenticators are defined is used only when Exim, as a client, is searching
5597 them to find one that matches an authentication mechanism offered by the
5598 server.
5599
5600 .cindex "generic options"
5601 .cindex "options" "generic &-- definition of"
5602 Within a driver instance definition, there are two kinds of option: &'generic'&
5603 and &'private'&. The generic options are those that apply to all drivers of the
5604 same type (that is, all routers, all transports or all authenticators). The
5605 &%driver%& option is a generic option that must appear in every definition.
5606 .cindex "private options"
5607 The private options are special for each driver, and none need appear, because
5608 they all have default values.
5609
5610 The options may appear in any order, except that the &%driver%& option must
5611 precede any private options, since these depend on the particular driver. For
5612 this reason, it is recommended that &%driver%& always be the first option.
5613
5614 Driver instance names, which are used for reference in log entries and
5615 elsewhere, can be any sequence of letters, digits, and underscores (starting
5616 with a letter) and must be unique among drivers of the same type. A router and
5617 a transport (for example) can each have the same name, but no two router
5618 instances can have the same name. The name of a driver instance should not be
5619 confused with the name of the underlying driver module. For example, the
5620 configuration lines:
5621 .code
5622 remote_smtp:
5623   driver = smtp
5624 .endd
5625 create an instance of the &(smtp)& transport driver whose name is
5626 &(remote_smtp)&. The same driver code can be used more than once, with
5627 different instance names and different option settings each time. A second
5628 instance of the &(smtp)& transport, with different options, might be defined
5629 thus:
5630 .code
5631 special_smtp:
5632   driver = smtp
5633   port = 1234
5634   command_timeout = 10s
5635 .endd
5636 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5637 these transport instances from routers, and these names would appear in log
5638 lines.
5639
5640 Comment lines may be present in the middle of driver specifications. The full
5641 list of option settings for any particular driver instance, including all the
5642 defaulted values, can be extracted by making use of the &%-bP%& command line
5643 option.
5644
5645
5646
5647
5648
5649
5650 . ////////////////////////////////////////////////////////////////////////////
5651 . ////////////////////////////////////////////////////////////////////////////
5652
5653 .chapter "The default configuration file" "CHAPdefconfil"
5654 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5655 .cindex "default" "configuration file &""walk through""&"
5656 The default configuration file supplied with Exim as &_src/configure.default_&
5657 is sufficient for a host with simple mail requirements. As an introduction to
5658 the way Exim is configured, this chapter &"walks through"& the default
5659 configuration, giving brief explanations of the settings. Detailed descriptions
5660 of the options are given in subsequent chapters. The default configuration file
5661 itself contains extensive comments about ways you might want to modify the
5662 initial settings. However, note that there are many options that are not
5663 mentioned at all in the default configuration.
5664
5665
5666
5667 .section "Macros" "SECTdefconfmacros"
5668 All macros should be defined before any options.
5669
5670 One macro is specified, but commented out, in the default configuration:
5671 .code
5672 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5673 .endd
5674 If all off-site mail is expected to be delivered to a "smarthost", then set the
5675 hostname here and uncomment the macro.  This will affect which router is used
5676 later on.  If this is left commented out, then Exim will perform direct-to-MX
5677 deliveries using a &(dnslookup)& router.
5678
5679 In addition to macros defined here, Exim includes a number of built-in macros
5680 to enable configuration to be guarded by a binary built with support for a
5681 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5682
5683
5684 .section "Main configuration settings" "SECTdefconfmain"
5685 The main (global) configuration option settings section must always come first
5686 in the file, after the macros.
5687 The first thing you'll see in the file, after some initial comments, is the line
5688 .code
5689 # primary_hostname =
5690 .endd
5691 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5692 to know the official, fully qualified name of your host, and this is where you
5693 can specify it. However, in most cases you do not need to set this option. When
5694 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5695
5696 The first three non-comment configuration lines are as follows:
5697 .code
5698 domainlist local_domains    = @
5699 domainlist relay_to_domains =
5700 hostlist   relay_from_hosts = 127.0.0.1
5701 .endd
5702 These are not, in fact, option settings. They are definitions of two named
5703 domain lists and one named host list. Exim allows you to give names to lists of
5704 domains, hosts, and email addresses, in order to make it easier to manage the
5705 configuration file (see section &<<SECTnamedlists>>&).
5706
5707 The first line defines a domain list called &'local_domains'&; this is used
5708 later in the configuration to identify domains that are to be delivered
5709 on the local host.
5710
5711 .cindex "@ in a domain list"
5712 There is just one item in this list, the string &"@"&. This is a special form
5713 of entry which means &"the name of the local host"&. Thus, if the local host is
5714 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5715 be delivered locally. Because the local host's name is referenced indirectly,
5716 the same configuration file can be used on different hosts.
5717
5718 The second line defines a domain list called &'relay_to_domains'&, but the
5719 list itself is empty. Later in the configuration we will come to the part that
5720 controls mail relaying through the local host; it allows relaying to any
5721 domains in this list. By default, therefore, no relaying on the basis of a mail
5722 domain is permitted.
5723
5724 The third line defines a host list called &'relay_from_hosts'&. This list is
5725 used later in the configuration to permit relaying from any host or IP address
5726 that matches the list. The default contains just the IP address of the IPv4
5727 loopback interface, which means that processes on the local host are able to
5728 submit mail for relaying by sending it over TCP/IP to that interface. No other
5729 hosts are permitted to submit messages for relaying.
5730
5731 Just to be sure there's no misunderstanding: at this point in the configuration
5732 we aren't actually setting up any controls. We are just defining some domains
5733 and hosts that will be used in the controls that are specified later.
5734
5735 The next two configuration lines are genuine option settings:
5736 .code
5737 acl_smtp_rcpt = acl_check_rcpt
5738 acl_smtp_data = acl_check_data
5739 .endd
5740 These options specify &'Access Control Lists'& (ACLs) that are to be used
5741 during an incoming SMTP session for every recipient of a message (every RCPT
5742 command), and after the contents of the message have been received,
5743 respectively. The names of the lists are &'acl_check_rcpt'& and
5744 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5745 section of the configuration. The RCPT ACL controls which recipients are
5746 accepted for an incoming message &-- if a configuration does not provide an ACL
5747 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5748 contents of a message to be checked.
5749
5750 Two commented-out option settings are next:
5751 .code
5752 # av_scanner = clamd:/tmp/clamd
5753 # spamd_address = 127.0.0.1 783
5754 .endd
5755 These are example settings that can be used when Exim is compiled with the
5756 content-scanning extension. The first specifies the interface to the virus
5757 scanner, and the second specifies the interface to SpamAssassin. Further
5758 details are given in chapter &<<CHAPexiscan>>&.
5759
5760 Three more commented-out option settings follow:
5761 .code
5762 # tls_advertise_hosts = *
5763 # tls_certificate = /etc/ssl/exim.crt
5764 # tls_privatekey = /etc/ssl/exim.pem
5765 .endd
5766 These are example settings that can be used when Exim is compiled with
5767 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5768 first one specifies the list of clients that are allowed to use TLS when
5769 connecting to this server; in this case, the wildcard means all clients. The
5770 other options specify where Exim should find its TLS certificate and private
5771 key, which together prove the server's identity to any clients that connect.
5772 More details are given in chapter &<<CHAPTLS>>&.
5773
5774 Another two commented-out option settings follow:
5775 .code
5776 # daemon_smtp_ports = 25 : 465 : 587
5777 # tls_on_connect_ports = 465
5778 .endd
5779 .cindex "port" "465 and 587"
5780 .cindex "port" "for message submission"
5781 .cindex "message" "submission, ports for"
5782 .cindex "submissions protocol"
5783 .cindex "smtps protocol"
5784 .cindex "ssmtp protocol"
5785 .cindex "SMTP" "submissions protocol"
5786 .cindex "SMTP" "ssmtp protocol"
5787 .cindex "SMTP" "smtps protocol"
5788 These options provide better support for roaming users who wish to use this
5789 server for message submission. They are not much use unless you have turned on
5790 TLS (as described in the previous paragraph) and authentication (about which
5791 more in section &<<SECTdefconfauth>>&).
5792 Mail submission from mail clients (MUAs) should be separate from inbound mail
5793 to your domain (MX delivery) for various good reasons (eg, ability to impose
5794 much saner TLS protocol and ciphersuite requirements without unintended
5795 consequences).
5796 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5797 which uses STARTTLS, so this is the &"submission"& port.
5798 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5799 which should be used in preference to 587.
5800 You should also consider deploying SRV records to help clients find
5801 these ports.
5802 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5803
5804 Two more commented-out options settings follow:
5805 .code
5806 # qualify_domain =
5807 # qualify_recipient =
5808 .endd
5809 The first of these specifies a domain that Exim uses when it constructs a
5810 complete email address from a local login name. This is often needed when Exim
5811 receives a message from a local process. If you do not set &%qualify_domain%&,
5812 the value of &%primary_hostname%& is used. If you set both of these options,
5813 you can have different qualification domains for sender and recipient
5814 addresses. If you set only the first one, its value is used in both cases.
5815
5816 .cindex "domain literal" "recognizing format"
5817 The following line must be uncommented if you want Exim to recognize
5818 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5819 (an IP address within square brackets) instead of a named domain.
5820 .code
5821 # allow_domain_literals
5822 .endd
5823 The RFCs still require this form, but many people think that in the modern
5824 Internet it makes little sense to permit mail to be sent to specific hosts by
5825 quoting their IP addresses. This ancient format has been used by people who
5826 try to abuse hosts by using them for unwanted relaying. However, some
5827 people believe there are circumstances (for example, messages addressed to
5828 &'postmaster'&) where domain literals are still useful.
5829
5830 The next configuration line is a kind of trigger guard:
5831 .code
5832 never_users = root
5833 .endd
5834 It specifies that no delivery must ever be run as the root user. The normal
5835 convention is to set up &'root'& as an alias for the system administrator. This
5836 setting is a guard against slips in the configuration.
5837 The list of users specified by &%never_users%& is not, however, the complete
5838 list; the build-time configuration in &_Local/Makefile_& has an option called
5839 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5840 contents of &%never_users%& are added to this list. By default
5841 FIXED_NEVER_USERS also specifies root.
5842
5843 When a remote host connects to Exim in order to send mail, the only information
5844 Exim has about the host's identity is its IP address. The next configuration
5845 line,
5846 .code
5847 host_lookup = *
5848 .endd
5849 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5850 in order to get a host name. This improves the quality of the logging
5851 information, but if you feel it is too expensive, you can remove it entirely,
5852 or restrict the lookup to hosts on &"nearby"& networks.
5853 Note that it is not always possible to find a host name from an IP address,
5854 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5855 unreachable.
5856
5857 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5858 1413 (hence their names):
5859 .code
5860 rfc1413_hosts = *
5861 rfc1413_query_timeout = 0s
5862 .endd
5863 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5864 Few hosts offer RFC1413 service these days; calls have to be
5865 terminated by a timeout and this needlessly delays the startup
5866 of an incoming SMTP connection.
5867 If you have hosts for which you trust RFC1413 and need this
5868 information, you can change this.
5869
5870 This line enables an efficiency SMTP option.  It is negotiated by clients
5871 and not expected to cause problems but can be disabled if needed.
5872 .code
5873 prdr_enable = true
5874 .endd
5875
5876 When Exim receives messages over SMTP connections, it expects all addresses to
5877 be fully qualified with a domain, as required by the SMTP definition. However,
5878 if you are running a server to which simple clients submit messages, you may
5879 find that they send unqualified addresses. The two commented-out options:
5880 .code
5881 # sender_unqualified_hosts =
5882 # recipient_unqualified_hosts =
5883 .endd
5884 show how you can specify hosts that are permitted to send unqualified sender
5885 and recipient addresses, respectively.
5886
5887 The &%log_selector%& option is used to increase the detail of logging
5888 over the default:
5889 .code
5890 log_selector = +smtp_protocol_error +smtp_syntax_error \
5891                +tls_certificate_verified
5892 .endd
5893
5894 The &%percent_hack_domains%& option is also commented out:
5895 .code
5896 # percent_hack_domains =
5897 .endd
5898 It provides a list of domains for which the &"percent hack"& is to operate.
5899 This is an almost obsolete form of explicit email routing. If you do not know
5900 anything about it, you can safely ignore this topic.
5901
5902 The next two settings in the main part of the default configuration are
5903 concerned with messages that have been &"frozen"& on Exim's queue. When a
5904 message is frozen, Exim no longer continues to try to deliver it. Freezing
5905 occurs when a bounce message encounters a permanent failure because the sender
5906 address of the original message that caused the bounce is invalid, so the
5907 bounce cannot be delivered. This is probably the most common case, but there
5908 are also other conditions that cause freezing, and frozen messages are not
5909 always bounce messages.
5910 .code
5911 ignore_bounce_errors_after = 2d
5912 timeout_frozen_after = 7d
5913 .endd
5914 The first of these options specifies that failing bounce messages are to be
5915 discarded after 2 days in the queue. The second specifies that any frozen
5916 message (whether a bounce message or not) is to be timed out (and discarded)
5917 after a week. In this configuration, the first setting ensures that no failing
5918 bounce message ever lasts a week.
5919
5920 Exim queues it's messages in a spool directory. If you expect to have
5921 large queues, you may consider using this option. It splits the spool
5922 directory into subdirectories to avoid file system degradation from
5923 many files in a single directory, resulting in better performance.
5924 Manual manipulation of queued messages becomes more complex (though fortunately
5925 not often needed).
5926 .code
5927 # split_spool_directory = true
5928 .endd
5929
5930 In an ideal world everybody follows the standards. For non-ASCII
5931 messages RFC 2047 is a standard, allowing a maximum line length of 76
5932 characters. Exim adheres that standard and won't process messages which
5933 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5934 In particular, the Exim maintainers have had multiple reports of
5935 problems from Russian administrators of issues until they disable this
5936 check, because of some popular, yet buggy, mail composition software.
5937 .code
5938 # check_rfc2047_length = false
5939 .endd
5940
5941 If you need to be strictly RFC compliant you may wish to disable the
5942 8BITMIME advertisement. Use this, if you exchange mails with systems
5943 that are not 8-bit clean.
5944 .code
5945 # accept_8bitmime = false
5946 .endd
5947
5948 Libraries you use may depend on specific environment settings.  This
5949 imposes a security risk (e.g. PATH). There are two lists:
5950 &%keep_environment%& for the variables to import as they are, and
5951 &%add_environment%& for variables we want to set to a fixed value.
5952 Note that TZ is handled separately, by the $%timezone%$ runtime
5953 option and by the TIMEZONE_DEFAULT buildtime option.
5954 .code
5955 # keep_environment = ^LDAP
5956 # add_environment = PATH=/usr/bin::/bin
5957 .endd
5958
5959
5960 .section "ACL configuration" "SECID54"
5961 .cindex "default" "ACLs"
5962 .cindex "&ACL;" "default configuration"
5963 In the default configuration, the ACL section follows the main configuration.
5964 It starts with the line
5965 .code
5966 begin acl
5967 .endd
5968 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5969 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5970 and &%acl_smtp_data%& above.
5971
5972 .cindex "RCPT" "ACL for"
5973 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5974 RCPT command specifies one of the message's recipients. The ACL statements
5975 are considered in order, until the recipient address is either accepted or
5976 rejected. The RCPT command is then accepted or rejected, according to the
5977 result of the ACL processing.
5978 .code
5979 acl_check_rcpt:
5980 .endd
5981 This line, consisting of a name terminated by a colon, marks the start of the
5982 ACL, and names it.
5983 .code
5984 accept  hosts = :
5985 .endd
5986 This ACL statement accepts the recipient if the sending host matches the list.
5987 But what does that strange list mean? It doesn't actually contain any host
5988 names or IP addresses. The presence of the colon puts an empty item in the
5989 list; Exim matches this only if the incoming message did not come from a remote
5990 host, because in that case, the remote hostname is empty. The colon is
5991 important. Without it, the list itself is empty, and can never match anything.
5992
5993 What this statement is doing is to accept unconditionally all recipients in
5994 messages that are submitted by SMTP from local processes using the standard
5995 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5996 manner.
5997 .code
5998 deny    domains       = +local_domains
5999         local_parts   = ^[.] : ^.*[@%!/|]
6000         message       = Restricted characters in address
6001
6002 deny    domains       = !+local_domains
6003         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
6004         message       = Restricted characters in address
6005 .endd
6006 These statements are concerned with local parts that contain any of the
6007 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
6008 Although these characters are entirely legal in local parts (in the case of
6009 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
6010 in Internet mail addresses.
6011
6012 The first three have in the past been associated with explicitly routed
6013 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
6014 option). Addresses containing these characters are regularly tried by spammers
6015 in an attempt to bypass relaying restrictions, and also by open relay testing
6016 programs. Unless you really need them it is safest to reject these characters
6017 at this early stage. This configuration is heavy-handed in rejecting these
6018 characters for all messages it accepts from remote hosts. This is a deliberate
6019 policy of being as safe as possible.
6020
6021 The first rule above is stricter, and is applied to messages that are addressed
6022 to one of the local domains handled by this host. This is implemented by the
6023 first condition, which restricts it to domains that are listed in the
6024 &'local_domains'& domain list. The &"+"& character is used to indicate a
6025 reference to a named list. In this configuration, there is just one domain in
6026 &'local_domains'&, but in general there may be many.
6027
6028 The second condition on the first statement uses two regular expressions to
6029 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
6030 or &"|"&. If you have local accounts that include these characters, you will
6031 have to modify this rule.
6032
6033 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
6034 allows them because they have been encountered in practice. (Consider the
6035 common convention of local parts constructed as
6036 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
6037 the author of Exim, who has no second initial.) However, a local part starting
6038 with a dot or containing &"/../"& can cause trouble if it is used as part of a
6039 filename (for example, for a mailing list). This is also true for local parts
6040 that contain slashes. A pipe symbol can also be troublesome if the local part
6041 is incorporated unthinkingly into a shell command line.
6042
6043 The second rule above applies to all other domains, and is less strict. This
6044 allows your own users to send outgoing messages to sites that use slashes
6045 and vertical bars in their local parts. It blocks local parts that begin
6046 with a dot, slash, or vertical bar, but allows these characters within the
6047 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
6048 and &"!"& is blocked, as before. The motivation here is to prevent your users
6049 (or your users' viruses) from mounting certain kinds of attack on remote sites.
6050 .code
6051 accept  local_parts   = postmaster
6052         domains       = +local_domains
6053 .endd
6054 This statement, which has two conditions, accepts an incoming address if the
6055 local part is &'postmaster'& and the domain is one of those listed in the
6056 &'local_domains'& domain list. The &"+"& character is used to indicate a
6057 reference to a named list. In this configuration, there is just one domain in
6058 &'local_domains'&, but in general there may be many.
6059
6060 The presence of this statement means that mail to postmaster is never blocked
6061 by any of the subsequent tests. This can be helpful while sorting out problems
6062 in cases where the subsequent tests are incorrectly denying access.
6063 .code
6064 require verify        = sender
6065 .endd
6066 This statement requires the sender address to be verified before any subsequent
6067 ACL statement can be used. If verification fails, the incoming recipient
6068 address is refused. Verification consists of trying to route the address, to
6069 see if a bounce message could be delivered to it. In the case of remote
6070 addresses, basic verification checks only the domain, but &'callouts'& can be
6071 used for more verification if required. Section &<<SECTaddressverification>>&
6072 discusses the details of address verification.
6073 .code
6074 accept  hosts         = +relay_from_hosts
6075         control       = submission
6076 .endd
6077 This statement accepts the address if the message is coming from one of the
6078 hosts that are defined as being allowed to relay through this host. Recipient
6079 verification is omitted here, because in many cases the clients are dumb MUAs
6080 that do not cope well with SMTP error responses. For the same reason, the
6081 second line specifies &"submission mode"& for messages that are accepted. This
6082 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
6083 messages that are deficient in some way, for example, because they lack a
6084 &'Date:'& header line. If you are actually relaying out from MTAs, you should
6085 probably add recipient verification here, and disable submission mode.
6086 .code
6087 accept  authenticated = *
6088         control       = submission
6089 .endd
6090 This statement accepts the address if the client host has authenticated itself.
6091 Submission mode is again specified, on the grounds that such messages are most
6092 likely to come from MUAs. The default configuration does not define any
6093 authenticators, though it does include some nearly complete commented-out
6094 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6095 fact authenticate until you complete the authenticator definitions.
6096 .code
6097 require message = relay not permitted
6098         domains = +local_domains : +relay_to_domains
6099 .endd
6100 This statement rejects the address if its domain is neither a local domain nor
6101 one of the domains for which this host is a relay.
6102 .code
6103 require verify = recipient
6104 .endd
6105 This statement requires the recipient address to be verified; if verification
6106 fails, the address is rejected.
6107 .code
6108 # deny    dnslists    = black.list.example
6109 #         message     = rejected because $sender_host_address \
6110 #                       is in a black list at $dnslist_domain\n\
6111 #                       $dnslist_text
6112 #
6113 # warn    dnslists    = black.list.example
6114 #         add_header  = X-Warning: $sender_host_address is in \
6115 #                       a black list at $dnslist_domain
6116 #         log_message = found in $dnslist_domain
6117 .endd
6118 These commented-out lines are examples of how you could configure Exim to check
6119 sending hosts against a DNS black list. The first statement rejects messages
6120 from blacklisted hosts, whereas the second just inserts a warning header
6121 line.
6122 .code
6123 # require verify = csa
6124 .endd
6125 This commented-out line is an example of how you could turn on client SMTP
6126 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6127 records.
6128 .code
6129 accept
6130 .endd
6131 The final statement in the first ACL unconditionally accepts any recipient
6132 address that has successfully passed all the previous tests.
6133 .code
6134 acl_check_data:
6135 .endd
6136 This line marks the start of the second ACL, and names it. Most of the contents
6137 of this ACL are commented out:
6138 .code
6139 # deny    malware   = *
6140 #         message   = This message contains a virus \
6141 #                     ($malware_name).
6142 .endd
6143 These lines are examples of how to arrange for messages to be scanned for
6144 viruses when Exim has been compiled with the content-scanning extension, and a
6145 suitable virus scanner is installed. If the message is found to contain a
6146 virus, it is rejected with the given custom error message.
6147 .code
6148 # warn    spam      = nobody
6149 #         message   = X-Spam_score: $spam_score\n\
6150 #                     X-Spam_score_int: $spam_score_int\n\
6151 #                     X-Spam_bar: $spam_bar\n\
6152 #                     X-Spam_report: $spam_report
6153 .endd
6154 These lines are an example of how to arrange for messages to be scanned by
6155 SpamAssassin when Exim has been compiled with the content-scanning extension,
6156 and SpamAssassin has been installed. The SpamAssassin check is run with
6157 &`nobody`& as its user parameter, and the results are added to the message as a
6158 series of extra header line. In this case, the message is not rejected,
6159 whatever the spam score.
6160 .code
6161 accept
6162 .endd
6163 This final line in the DATA ACL accepts the message unconditionally.
6164
6165
6166 .section "Router configuration" "SECID55"
6167 .cindex "default" "routers"
6168 .cindex "routers" "default"
6169 The router configuration comes next in the default configuration, introduced
6170 by the line
6171 .code
6172 begin routers
6173 .endd
6174 Routers are the modules in Exim that make decisions about where to send
6175 messages. An address is passed to each router, in turn, until it is either
6176 accepted, or failed. This means that the order in which you define the routers
6177 matters. Each router is fully described in its own chapter later in this
6178 manual. Here we give only brief overviews.
6179 .code
6180 # domain_literal:
6181 #   driver = ipliteral
6182 #   domains = !+local_domains
6183 #   transport = remote_smtp
6184 .endd
6185 .cindex "domain literal" "default router"
6186 This router is commented out because the majority of sites do not want to
6187 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6188 you uncomment this router, you also need to uncomment the setting of
6189 &%allow_domain_literals%& in the main part of the configuration.
6190
6191 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6192 macro has been defined, per
6193 .code
6194 .ifdef ROUTER_SMARTHOST
6195 smarthost:
6196 #...
6197 .else
6198 dnslookup:
6199 #...
6200 .endif
6201 .endd
6202
6203 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6204 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6205 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6206 skip these routers because of the &%domains%& option.
6207
6208 .code
6209 smarthost:
6210   driver = manualroute
6211   domains = ! +local_domains
6212   transport = smarthost_smtp
6213   route_data = ROUTER_SMARTHOST
6214   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6215   no_more
6216 .endd
6217 This router only handles mail which is not to any local domains; this is
6218 specified by the line
6219 .code
6220 domains = ! +local_domains
6221 .endd
6222 The &%domains%& option lists the domains to which this router applies, but the
6223 exclamation mark is a negation sign, so the router is used only for domains
6224 that are not in the domain list called &'local_domains'& (which was defined at
6225 the start of the configuration). The plus sign before &'local_domains'&
6226 indicates that it is referring to a named list. Addresses in other domains are
6227 passed on to the following routers.
6228
6229 The name of the router driver is &(manualroute)& because we are manually
6230 specifying how mail should be routed onwards, instead of using DNS MX.
6231 While the name of this router instance is arbitrary, the &%driver%& option must
6232 be one of the driver modules that is in the Exim binary.
6233
6234 With no pre-conditions other than &%domains%&, all mail for non-local domains
6235 will be handled by this router, and the &%no_more%& setting will ensure that no
6236 other routers will be used for messages matching the pre-conditions.  See
6237 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6238 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6239 and the macro supplies the value; the address is then queued for the
6240 &(smarthost_smtp)& transport.
6241
6242 .code
6243 dnslookup:
6244   driver = dnslookup
6245   domains = ! +local_domains
6246   transport = remote_smtp
6247   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6248   no_more
6249 .endd
6250 The &%domains%& option behaves as per smarthost, above.
6251
6252 The name of the router driver is &(dnslookup)&,
6253 and is specified by the &%driver%& option. Do not be confused by the fact that
6254 the name of this router instance is the same as the name of the driver. The
6255 instance name is arbitrary, but the name set in the &%driver%& option must be
6256 one of the driver modules that is in the Exim binary.
6257
6258 The &(dnslookup)& router routes addresses by looking up their domains in the
6259 DNS in order to obtain a list of hosts to which the address is routed. If the
6260 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6261 specified by the &%transport%& option. If the router does not find the domain
6262 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6263 the address fails and is bounced.
6264
6265 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6266 be entirely ignored. This option is present because a number of cases have been
6267 encountered where MX records in the DNS point to host names
6268 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6269 Completely ignoring these IP addresses causes Exim to fail to route the
6270 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6271 continue to try to deliver the message periodically until the address timed
6272 out.
6273 .code
6274 system_aliases:
6275   driver = redirect
6276   allow_fail
6277   allow_defer
6278   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6279 # user = exim
6280   file_transport = address_file
6281   pipe_transport = address_pipe
6282 .endd
6283 Control reaches this and subsequent routers only for addresses in the local
6284 domains. This router checks to see whether the local part is defined as an
6285 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6286 data that it looks up from that file. If no data is found for the local part,
6287 the value of the &%data%& option is empty, causing the address to be passed to
6288 the next router.
6289
6290 &_/etc/aliases_& is a conventional name for the system aliases file that is
6291 often used. That is why it is referenced by from the default configuration
6292 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6293 &_Local/Makefile_& before building Exim.
6294 .code
6295 userforward:
6296   driver = redirect
6297   check_local_user
6298 # local_part_suffix = +* : -*
6299 # local_part_suffix_optional
6300   file = $home/.forward
6301 # allow_filter
6302   no_verify
6303   no_expn
6304   check_ancestor
6305   file_transport = address_file
6306   pipe_transport = address_pipe
6307   reply_transport = address_reply
6308 .endd
6309 This is the most complicated router in the default configuration. It is another
6310 redirection router, but this time it is looking for forwarding data set up by
6311 individual users. The &%check_local_user%& setting specifies a check that the
6312 local part of the address is the login name of a local user. If it is not, the
6313 router is skipped. The two commented options that follow &%check_local_user%&,
6314 namely:
6315 .code
6316 # local_part_suffix = +* : -*
6317 # local_part_suffix_optional
6318 .endd
6319 .vindex "&$local_part_suffix$&"
6320 show how you can specify the recognition of local part suffixes. If the first
6321 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6322 by any sequence of characters, is removed from the local part and placed in the
6323 variable &$local_part_suffix$&. The second suffix option specifies that the
6324 presence of a suffix in the local part is optional. When a suffix is present,
6325 the check for a local login uses the local part with the suffix removed.
6326
6327 When a local user account is found, the file called &_.forward_& in the user's
6328 home directory is consulted. If it does not exist, or is empty, the router
6329 declines. Otherwise, the contents of &_.forward_& are interpreted as
6330 redirection data (see chapter &<<CHAPredirect>>& for more details).
6331
6332 .cindex "Sieve filter" "enabling in default router"
6333 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6334 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6335 is commented out by default), the contents of the file are interpreted as a set
6336 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6337 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6338 separate document entitled &'Exim's interfaces to mail filtering'&.
6339
6340 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6341 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6342 There are two reasons for doing this:
6343
6344 .olist
6345 Whether or not a local user has a &_.forward_& file is not really relevant when
6346 checking an address for validity; it makes sense not to waste resources doing
6347 unnecessary work.
6348 .next
6349 More importantly, when Exim is verifying addresses or handling an EXPN
6350 command during an SMTP session, it is running as the Exim user, not as root.
6351 The group is the Exim group, and no additional groups are set up.
6352 It may therefore not be possible for Exim to read users' &_.forward_& files at
6353 this time.
6354 .endlist
6355
6356 The setting of &%check_ancestor%& prevents the router from generating a new
6357 address that is the same as any previous address that was redirected. (This
6358 works round a problem concerning a bad interaction between aliasing and
6359 forwarding &-- see section &<<SECTredlocmai>>&).
6360
6361 The final three option settings specify the transports that are to be used when
6362 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6363 auto-reply, respectively. For example, if a &_.forward_& file contains
6364 .code
6365 a.nother@elsewhere.example, /home/spqr/archive
6366 .endd
6367 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6368 transport.
6369 .code
6370 localuser:
6371   driver = accept
6372   check_local_user
6373 # local_part_suffix = +* : -*
6374 # local_part_suffix_optional
6375   transport = local_delivery
6376 .endd
6377 The final router sets up delivery into local mailboxes, provided that the local
6378 part is the name of a local login, by accepting the address and assigning it to
6379 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6380 routers, so the address is bounced. The commented suffix settings fulfil the
6381 same purpose as they do for the &(userforward)& router.
6382
6383
6384 .section "Transport configuration" "SECID56"
6385 .cindex "default" "transports"
6386 .cindex "transports" "default"
6387 Transports define mechanisms for actually delivering messages. They operate
6388 only when referenced from routers, so the order in which they are defined does
6389 not matter. The transports section of the configuration starts with
6390 .code
6391 begin transports
6392 .endd
6393 Two remote transports and four local transports are defined.
6394 .code
6395 remote_smtp:
6396   driver = smtp
6397   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6398 .ifdef _HAVE_PRDR
6399   hosts_try_prdr = *
6400 .endif
6401 .endd
6402 This transport is used for delivering messages over SMTP connections.
6403 The list of remote hosts comes from the router.
6404 The &%message_size_limit%& usage is a hack to avoid sending on messages
6405 with over-long lines.
6406
6407 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6408 negotiated between client and server and not expected to cause problems
6409 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6410 use of the &%hosts_try_prdr%& configuration option.
6411
6412 The other remote transport is used when delivering to a specific smarthost
6413 with whom there must be some kind of existing relationship, instead of the
6414 usual federated system.
6415
6416 .code
6417 smarthost_smtp:
6418   driver = smtp
6419   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6420   multi_domain
6421   #
6422 .ifdef _HAVE_TLS
6423   # Comment out any of these which you have to, then file a Support
6424   # request with your smarthost provider to get things fixed:
6425   hosts_require_tls = *
6426   tls_verify_hosts = *
6427   # As long as tls_verify_hosts is enabled, this this will have no effect,
6428   # but if you have to comment it out then this will at least log whether
6429   # you succeed or not:
6430   tls_try_verify_hosts = *
6431   #
6432   # The SNI name should match the name which we'll expect to verify;
6433   # many mail systems don't use SNI and this doesn't matter, but if it does,
6434   # we need to send a name which the remote site will recognize.
6435   # This _should_ be the name which the smarthost operators specified as
6436   # the hostname for sending your mail to.
6437   tls_sni = ROUTER_SMARTHOST
6438   #
6439 .ifdef _HAVE_OPENSSL
6440   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6441 .endif
6442 .ifdef _HAVE_GNUTLS
6443   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6444 .endif
6445 .endif
6446 .ifdef _HAVE_PRDR
6447   hosts_try_prdr = *
6448 .endif
6449 .endd
6450 After the same &%message_size_limit%& hack, we then specify that this Transport
6451 can handle messages to multiple domains in one run.  The assumption here is
6452 that you're routing all non-local mail to the same place and that place is
6453 happy to take all messages from you as quickly as possible.
6454 All other options depend upon built-in macros; if Exim was built without TLS support
6455 then no other options are defined.
6456 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6457 and versions using the &%tls_require_ciphers%& option, where the value to be
6458 used depends upon the library providing TLS.
6459 Beyond that, the options adopt the stance that you should have TLS support available
6460 from your smarthost on today's Internet, so we turn on requiring TLS for the
6461 mail to be delivered, and requiring that the certificate be valid, and match
6462 the expected hostname.  The &%tls_sni%& option can be used by service providers
6463 to select an appropriate certificate to present to you and here we re-use the
6464 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6465 You want to specify the hostname which you'll expect to validate for, and that
6466 should not be subject to insecure tampering via DNS results.
6467
6468 For the &%hosts_try_prdr%& option see the previous transport.
6469
6470 All other options are defaulted.
6471 .code
6472 local_delivery:
6473   driver = appendfile
6474   file = /var/mail/$local_part_data
6475   delivery_date_add
6476   envelope_to_add
6477   return_path_add
6478 # group = mail
6479 # mode = 0660
6480 .endd
6481 This &(appendfile)& transport is used for local delivery to user mailboxes in
6482 traditional BSD mailbox format.
6483
6484 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6485 as it is provided by a potential bad actor.
6486 Instead we use &$local_part_data$&,
6487 the result of looking up &$local_part$& in the user database
6488 (done by using &%check_local_user%& in the the router).
6489
6490 By default &(appendfile)& runs under the uid and gid of the
6491 local user, which requires the sticky bit to be set on the &_/var/mail_&
6492 directory. Some systems use the alternative approach of running mail deliveries
6493 under a particular group instead of using the sticky bit. The commented options
6494 show how this can be done.
6495
6496 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6497 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6498 similarly-named options above.
6499 .code
6500 address_pipe:
6501   driver = pipe
6502   return_output
6503 .endd
6504 This transport is used for handling deliveries to pipes that are generated by
6505 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6506 option specifies that any output on stdout or stderr generated by the pipe is to
6507 be returned to the sender.
6508 .code
6509 address_file:
6510   driver = appendfile
6511   delivery_date_add
6512   envelope_to_add
6513   return_path_add
6514 .endd
6515 This transport is used for handling deliveries to files that are generated by
6516 redirection. The name of the file is not specified in this instance of
6517 &(appendfile)&, because it comes from the &(redirect)& router.
6518 .code
6519 address_reply:
6520   driver = autoreply
6521 .endd
6522 This transport is used for handling automatic replies generated by users'
6523 filter files.
6524
6525
6526
6527 .section "Default retry rule" "SECID57"
6528 .cindex "retry" "default rule"
6529 .cindex "default" "retry rule"
6530 The retry section of the configuration file contains rules which affect the way
6531 Exim retries deliveries that cannot be completed at the first attempt. It is
6532 introduced by the line
6533 .code
6534 begin retry
6535 .endd
6536 In the default configuration, there is just one rule, which applies to all
6537 errors:
6538 .code
6539 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6540 .endd
6541 This causes any temporarily failing address to be retried every 15 minutes for
6542 2 hours, then at intervals starting at one hour and increasing by a factor of
6543 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6544 is not delivered after 4 days of temporary failure, it is bounced. The time is
6545 measured from first failure, not from the time the message was received.
6546
6547 If the retry section is removed from the configuration, or is empty (that is,
6548 if no retry rules are defined), Exim will not retry deliveries. This turns
6549 temporary errors into permanent errors.
6550
6551
6552 .section "Rewriting configuration" "SECID58"
6553 The rewriting section of the configuration, introduced by
6554 .code
6555 begin rewrite
6556 .endd
6557 contains rules for rewriting addresses in messages as they arrive. There are no
6558 rewriting rules in the default configuration file.
6559
6560
6561
6562 .section "Authenticators configuration" "SECTdefconfauth"
6563 .cindex "AUTH" "configuration"
6564 The authenticators section of the configuration, introduced by
6565 .code
6566 begin authenticators
6567 .endd
6568 defines mechanisms for the use of the SMTP AUTH command. The default
6569 configuration file contains two commented-out example authenticators
6570 which support plaintext username/password authentication using the
6571 standard PLAIN mechanism and the traditional but non-standard LOGIN
6572 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6573 to support most MUA software.
6574
6575 The example PLAIN authenticator looks like this:
6576 .code
6577 #PLAIN:
6578 #  driver                  = plaintext
6579 #  server_set_id           = $auth2
6580 #  server_prompts          = :
6581 #  server_condition        = Authentication is not yet configured
6582 #  server_advertise_condition = ${if def:tls_in_cipher }
6583 .endd
6584 And the example LOGIN authenticator looks like this:
6585 .code
6586 #LOGIN:
6587 #  driver                  = plaintext
6588 #  server_set_id           = $auth1
6589 #  server_prompts          = <| Username: | Password:
6590 #  server_condition        = Authentication is not yet configured
6591 #  server_advertise_condition = ${if def:tls_in_cipher }
6592 .endd
6593
6594 The &%server_set_id%& option makes Exim remember the authenticated username
6595 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6596 &%server_prompts%& option configures the &(plaintext)& authenticator so
6597 that it implements the details of the specific authentication mechanism,
6598 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6599 when Exim offers authentication to clients; in the examples, this is only
6600 when TLS or SSL has been started, so to enable the authenticators you also
6601 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6602
6603 The &%server_condition%& setting defines how to verify that the username and
6604 password are correct. In the examples it just produces an error message.
6605 To make the authenticators work, you can use a string expansion
6606 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6607
6608 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6609 usercode and password are in different positions.
6610 Chapter &<<CHAPplaintext>>& covers both.
6611
6612 .ecindex IIDconfiwal
6613
6614
6615
6616 . ////////////////////////////////////////////////////////////////////////////
6617 . ////////////////////////////////////////////////////////////////////////////
6618
6619 .chapter "Regular expressions" "CHAPregexp"
6620
6621 .cindex "regular expressions" "library"
6622 .cindex "PCRE"
6623 Exim supports the use of regular expressions in many of its options. It
6624 uses the PCRE regular expression library; this provides regular expression
6625 matching that is compatible with Perl 5. The syntax and semantics of
6626 regular expressions is discussed in
6627 online Perl manpages, in
6628 many Perl reference books, and also in
6629 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6630 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6631 . --- the http: URL here redirects to another page with the ISBN in the URL
6632 . --- where trying to use https: just redirects back to http:, so sticking
6633 . --- to the old URL for now.  2018-09-07.
6634
6635 The documentation for the syntax and semantics of the regular expressions that
6636 are supported by PCRE is included in the PCRE distribution, and no further
6637 description is included here. The PCRE functions are called from Exim using
6638 the default option settings (that is, with no PCRE options set), except that
6639 the PCRE_CASELESS option is set when the matching is required to be
6640 case-insensitive.
6641
6642 In most cases, when a regular expression is required in an Exim configuration,
6643 it has to start with a circumflex, in order to distinguish it from plain text
6644 or an &"ends with"& wildcard. In this example of a configuration setting, the
6645 second item in the colon-separated list is a regular expression.
6646 .code
6647 domains = a.b.c : ^\\d{3} : *.y.z : ...
6648 .endd
6649 The doubling of the backslash is required because of string expansion that
6650 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6651 of this issue, and a way of avoiding the need for doubling backslashes. The
6652 regular expression that is eventually used in this example contains just one
6653 backslash. The circumflex is included in the regular expression, and has the
6654 normal effect of &"anchoring"& it to the start of the string that is being
6655 matched.
6656
6657 There are, however, two cases where a circumflex is not required for the
6658 recognition of a regular expression: these are the &%match%& condition in a
6659 string expansion, and the &%matches%& condition in an Exim filter file. In
6660 these cases, the relevant string is always treated as a regular expression; if
6661 it does not start with a circumflex, the expression is not anchored, and can
6662 match anywhere in the subject string.
6663
6664 In all cases, if you want a regular expression to match at the end of a string,
6665 you must code the $ metacharacter to indicate this. For example:
6666 .code
6667 domains = ^\\d{3}\\.example
6668 .endd
6669 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6670 You need to use:
6671 .code
6672 domains = ^\\d{3}\\.example\$
6673 .endd
6674 if you want &'example'& to be the top-level domain. The backslash before the
6675 $ is needed because string expansion also interprets dollar characters.
6676
6677
6678
6679 . ////////////////////////////////////////////////////////////////////////////
6680 . ////////////////////////////////////////////////////////////////////////////
6681
6682 .chapter "File and database lookups" "CHAPfdlookup"
6683 .scindex IIDfidalo1 "file" "lookups"
6684 .scindex IIDfidalo2 "database" "lookups"
6685 .cindex "lookup" "description of"
6686 Exim can be configured to look up data in files or databases as it processes
6687 messages. Two different kinds of syntax are used:
6688
6689 .olist
6690 A string that is to be expanded may contain explicit lookup requests. These
6691 cause parts of the string to be replaced by data that is obtained from the
6692 lookup. Lookups of this type are conditional expansion items. Different results
6693 can be defined for the cases of lookup success and failure. See chapter
6694 &<<CHAPexpand>>&, where string expansions are described in detail.
6695 The key for the lookup is &*specified*& as part of the string expansion.
6696 .next
6697 Lists of domains, hosts, and email addresses can contain lookup requests as a
6698 way of avoiding excessively long linear lists. In this case, the data that is
6699 returned by the lookup is often (but not always) discarded; whether the lookup
6700 succeeds or fails is what really counts. These kinds of list are described in
6701 chapter &<<CHAPdomhosaddlists>>&.
6702 The key for the lookup is &*implicit*&,
6703 given by the context in which the list is expanded.
6704 .endlist
6705
6706 String expansions, lists, and lookups interact with each other in such a way
6707 that there is no order in which to describe any one of them that does not
6708 involve references to the others. Each of these three chapters makes more sense
6709 if you have read the other two first. If you are reading this for the first
6710 time, be aware that some of it will make a lot more sense after you have read
6711 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6712
6713 .section "Examples of different lookup syntax" "SECID60"
6714 It is easy to confuse the two different kinds of lookup, especially as the
6715 lists that may contain the second kind are always expanded before being
6716 processed as lists. Therefore, they may also contain lookups of the first kind.
6717 Be careful to distinguish between the following two examples:
6718 .code
6719 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6720 domains = lsearch;/some/file
6721 .endd
6722 The first uses a string expansion, the result of which must be a domain list.
6723 No strings have been specified for a successful or a failing lookup; the
6724 defaults in this case are the looked-up data and an empty string, respectively.
6725 The expansion takes place before the string is processed as a list, and the
6726 file that is searched could contain lines like this:
6727 .code
6728 192.168.3.4: domain1:domain2:...
6729 192.168.1.9: domain3:domain4:...
6730 .endd
6731 When the lookup succeeds, the result of the expansion is a list of domains (and
6732 possibly other types of item that are allowed in domain lists).
6733 .cindex "tainted data" "de-tainting"
6734 The result of the expansion is not tainted.
6735
6736 In the second example, the lookup is a single item in a domain list. It causes
6737 Exim to use a lookup to see if the domain that is being processed can be found
6738 in the file.
6739 The file could contains lines like this:
6740 .code
6741 domain1:
6742 domain2:
6743 .endd
6744 Any data that follows the keys is not relevant when checking that the domain
6745 matches the list item.
6746
6747 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6748 Consider a file containing lines like this:
6749 .code
6750 192.168.5.6: lsearch;/another/file
6751 .endd
6752 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6753 first &%domains%& setting above generates the second setting, which therefore
6754 causes a second lookup to occur.
6755
6756 .new
6757 The lookup type may optionally be followed by a comma
6758 and a comma-separated list of options.
6759 Each option is a &"name=value"& pair.
6760 Whether an option is meaningful depends on the lookup type.
6761
6762 All lookups support the option &"cache=no_rd"&.
6763 If this is given then the cache that Exim manages for lookup results
6764 is not checked before doing the lookup.
6765 The result of the lookup is still written to the cache.
6766 .wen
6767
6768 The rest of this chapter describes the different lookup types that are
6769 available. Any of them can be used in any part of the configuration where a
6770 lookup is permitted.
6771
6772
6773 .section "Lookup types" "SECID61"
6774 .cindex "lookup" "types of"
6775 .cindex "single-key lookup" "definition of"
6776 Two different types of data lookup are implemented:
6777
6778 .ilist
6779 The &'single-key'& type requires the specification of a file in which to look,
6780 and a single key to search for. The key must be a non-empty string for the
6781 lookup to succeed. The lookup type determines how the file is searched.
6782 .cindex "tainted data" "single-key lookups"
6783 The file string may not be tainted
6784
6785 .cindex "tainted data" "de-tainting"
6786 All single-key lookups support the option &"ret=key"&.
6787 If this is given and the lookup
6788 (either underlying implementation or cached value)
6789 returns data, the result is replaced with a non-tainted
6790 version of the lookup key.
6791 .cindex "tainted data" "de-tainting"
6792 .next
6793 .cindex "query-style lookup" "definition of"
6794 The &'query-style'& type accepts a generalized database query. No particular
6795 key value is assumed by Exim for query-style lookups. You can use whichever
6796 Exim variables you need to construct the database query.
6797 .endlist
6798
6799 The code for each lookup type is in a separate source file that is included in
6800 the binary of Exim only if the corresponding compile-time option is set. The
6801 default settings in &_src/EDITME_& are:
6802 .code
6803 LOOKUP_DBM=yes
6804 LOOKUP_LSEARCH=yes
6805 .endd
6806 which means that only linear searching and DBM lookups are included by default.
6807 For some types of lookup (e.g. SQL databases), you need to install appropriate
6808 libraries and header files before building Exim.
6809
6810
6811
6812
6813 .section "Single-key lookup types" "SECTsinglekeylookups"
6814 .cindex "lookup" "single-key types"
6815 .cindex "single-key lookup" "list of types"
6816 The following single-key lookup types are implemented:
6817
6818 .ilist
6819 .cindex "cdb" "description of"
6820 .cindex "lookup" "cdb"
6821 .cindex "binary zero" "in lookup key"
6822 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6823 string without a terminating binary zero. The cdb format is designed for
6824 indexed files that are read frequently and never updated, except by total
6825 re-creation. As such, it is particularly suitable for large files containing
6826 aliases or other indexed data referenced by an MTA. Information about cdb and
6827 tools for building the files can be found in several places:
6828 .display
6829 &url(https://cr.yp.to/cdb.html)
6830 &url(https://www.corpit.ru/mjt/tinycdb.html)
6831 &url(https://packages.debian.org/stable/utils/freecdb)
6832 &url(https://github.com/philpennock/cdbtools) (in Go)
6833 .endd
6834 A cdb distribution is not needed in order to build Exim with cdb support,
6835 because the code for reading cdb files is included directly in Exim itself.
6836 However, no means of building or testing cdb files is provided with Exim, so
6837 you need to obtain a cdb distribution in order to do this.
6838 .next
6839 .cindex "DBM" "lookup type"
6840 .cindex "lookup" "dbm"
6841 .cindex "binary zero" "in lookup key"
6842 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6843 DBM file by looking up the record with the given key. A terminating binary
6844 zero is included in the key that is passed to the DBM library. See section
6845 &<<SECTdb>>& for a discussion of DBM libraries.
6846
6847 .cindex "Berkeley DB library" "file format"
6848 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6849 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6850 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6851 the DB_UNKNOWN option. This enables it to handle any of the types of database
6852 that the library supports, and can be useful for accessing DBM files created by
6853 other applications. (For earlier DB versions, DB_HASH is always used.)
6854 .next
6855 .cindex "lookup" "dbmjz"
6856 .cindex "lookup" "dbm &-- embedded NULs"
6857 .cindex "sasldb2"
6858 .cindex "dbmjz lookup type"
6859 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6860 interpreted as an Exim list; the elements of the list are joined together with
6861 ASCII NUL characters to form the lookup key.  An example usage would be to
6862 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6863 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6864 &(cram_md5)& authenticator.
6865 .next
6866 .cindex "lookup" "dbmnz"
6867 .cindex "lookup" "dbm &-- terminating zero"
6868 .cindex "binary zero" "in lookup key"
6869 .cindex "Courier"
6870 .cindex "&_/etc/userdbshadow.dat_&"
6871 .cindex "dbmnz lookup type"
6872 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6873 is not included in the key that is passed to the DBM library. You may need this
6874 if you want to look up data in files that are created by or shared with some
6875 other application that does not use terminating zeros. For example, you need to
6876 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6877 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6878 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6879 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6880 .next
6881 .cindex "lookup" "dsearch"
6882 .cindex "dsearch lookup type"
6883 &(dsearch)&: The given file must be an
6884 absolute
6885 directory path; this is searched for an entry
6886 whose name is the key by calling the &[lstat()]& function.
6887 The key may not
6888 contain any forward slash characters.
6889 If &[lstat()]& succeeds then so does the lookup.
6890 .cindex "tainted data" "dsearch result"
6891 The result is regarded as untainted.
6892
6893 Options for the lookup can be given by appending them after the word "dsearch",
6894 separated by a comma.  Options, if present, are a comma-separated list having
6895 each element starting with a tag name and an equals.
6896
6897 Two options are supported, for the return value and for filtering match
6898 candidates.
6899 The "ret" option requests an alternate result value of
6900 the entire path for the entry. Example:
6901 .code
6902 ${lookup {passwd} dsearch,ret=full {/etc}}
6903 .endd
6904 The default result is just the requested entry.
6905 The "filter" option requests that only directory entries of a given type
6906 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6907 not matching "." or ".."). Example:
6908 .code
6909 ${lookup {passwd} dsearch,filter=file {/etc}}
6910 .endd
6911 The default matching is for any entry type, including directories
6912 and symlinks.
6913
6914 An example of how this
6915 lookup can be used to support virtual domains is given in section
6916 &<<SECTvirtualdomains>>&.
6917 .next
6918 .cindex "lookup" "iplsearch"
6919 .cindex "iplsearch lookup type"
6920 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6921 terminated by a colon or white space or the end of the line. The keys in the
6922 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6923 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6924 being interpreted as a key terminator. For example:
6925 .code
6926 1.2.3.4:           data for 1.2.3.4
6927 192.168.0.0/16:    data for 192.168.0.0/16
6928 "abcd::cdab":      data for abcd::cdab
6929 "abcd:abcd::/32"   data for abcd:abcd::/32
6930 .endd
6931 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6932 file is searched linearly, using the CIDR masks where present, until a matching
6933 key is found. The first key that matches is used; there is no attempt to find a
6934 &"best"& match. Apart from the way the keys are matched, the processing for
6935 &(iplsearch)& is the same as for &(lsearch)&.
6936
6937 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6938 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6939 lookup types support only literal keys.
6940
6941 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6942 the implicit key is the host's IP address rather than its name (see section
6943 &<<SECThoslispatsikey>>&).
6944
6945 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6946 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6947 notation before executing the lookup.)
6948
6949 .new
6950 One option is supported, "ret=full", to request the return of the entire line
6951 rather than omitting the key porttion.
6952 Note however that the key portion will have been de-quoted.
6953 .wen
6954
6955 .next
6956 .cindex lookup json
6957 .cindex json "lookup type"
6958 .cindex JSON expansions
6959 &(json)&: The given file is a text file with a JSON structure.
6960 An element of the structure is extracted, defined by the search key.
6961 The key is a list of subelement selectors
6962 (colon-separated by default but changeable in the usual way)
6963 which are applied in turn to select smaller and smaller portions
6964 of the JSON structure.
6965 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6966 nunbered array element is selected.
6967 Otherwise it must apply to a JSON object; the named element is selected.
6968 The final resulting element can be a simple JSON type or a JSON object
6969 or array; for the latter two a string-representation of the JSON
6970 is returned.
6971 For elements of type string, the returned value is de-quoted.
6972
6973
6974 .new
6975 .next
6976 .cindex LMDB
6977 .cindex lookup lmdb
6978 .cindex database lmdb
6979 &(lmdb)&: The given file is an LMDB database.
6980 LMDB is a memory-mapped key-value store,
6981 with API modeled loosely on that of BerkeleyDB.
6982 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6983 for the feature set and operation modes.
6984
6985 Exim provides read-only access via the LMDB C library.
6986 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6987 or your operating system package repository.
6988 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6989
6990 You will need to separately create the LMDB database file,
6991 possibly using the &"mdb_load"& utility.
6992 .wen
6993
6994
6995 .next
6996 .cindex "linear search"
6997 .cindex "lookup" "lsearch"
6998 .cindex "lsearch lookup type"
6999 .cindex "case sensitivity" "in lsearch lookup"
7000 &(lsearch)&: The given file is a text file that is searched linearly for a
7001 line beginning with the search key, terminated by a colon or white space or the
7002 end of the line. The search is case-insensitive; that is, upper and lower case
7003 letters are treated as the same. The first occurrence of the key that is found
7004 in the file is used.
7005
7006 White space between the key and the colon is permitted. The remainder of the
7007 line, with leading and trailing white space removed, is the data. This can be
7008 continued onto subsequent lines by starting them with any amount of white
7009 space, but only a single space character is included in the data at such a
7010 junction. If the data begins with a colon, the key must be terminated by a
7011 colon, for example:
7012 .code
7013 baduser:  :fail:
7014 .endd
7015 Empty lines and lines beginning with # are ignored, even if they occur in the
7016 middle of an item. This is the traditional textual format of alias files. Note
7017 that the keys in an &(lsearch)& file are literal strings. There is no
7018 wildcarding of any kind.
7019
7020 .cindex "lookup" "lsearch &-- colons in keys"
7021 .cindex "white space" "in lsearch key"
7022 In most &(lsearch)& files, keys are not required to contain colons or #
7023 characters, or white space. However, if you need this feature, it is available.
7024 If a key begins with a doublequote character, it is terminated only by a
7025 matching quote (or end of line), and the normal escaping rules apply to its
7026 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
7027 quoted keys (exactly as for unquoted keys). There is no special handling of
7028 quotes for the data part of an &(lsearch)& line.
7029
7030 .next
7031 .cindex "NIS lookup type"
7032 .cindex "lookup" "NIS"
7033 .cindex "binary zero" "in lookup key"
7034 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
7035 the given key, without a terminating binary zero. There is a variant called
7036 &(nis0)& which does include the terminating binary zero in the key. This is
7037 reportedly needed for Sun-style alias files. Exim does not recognize NIS
7038 aliases; the full map names must be used.
7039
7040 .next
7041 .cindex "wildlsearch lookup type"
7042 .cindex "lookup" "wildlsearch"
7043 .cindex "nwildlsearch lookup type"
7044 .cindex "lookup" "nwildlsearch"
7045 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
7046 &(lsearch)&, but instead of being interpreted as a literal string, each key in
7047 the file may be wildcarded. The difference between these two lookup types is
7048 that for &(wildlsearch)&, each key in the file is string-expanded before being
7049 used, whereas for &(nwildlsearch)&, no expansion takes place.
7050
7051 .cindex "case sensitivity" "in (n)wildlsearch lookup"
7052 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
7053 file that are regular expressions can be made case-sensitive by the use of
7054 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
7055
7056 . ==== As this is a nested list, any displays it contains must be indented
7057 . ==== as otherwise they are too far to the left.
7058
7059 .olist
7060 The string may begin with an asterisk to mean &"ends with"&. For example:
7061 .code
7062     *.a.b.c       data for anything.a.b.c
7063     *fish         data for anythingfish
7064 .endd
7065 .next
7066 The string may begin with a circumflex to indicate a regular expression. For
7067 example, for &(wildlsearch)&:
7068 .code
7069     ^\N\d+\.a\.b\N    data for <digits>.a.b
7070 .endd
7071 Note the use of &`\N`& to disable expansion of the contents of the regular
7072 expression. If you are using &(nwildlsearch)&, where the keys are not
7073 string-expanded, the equivalent entry is:
7074 .code
7075     ^\d+\.a\.b        data for <digits>.a.b
7076 .endd
7077 The case-insensitive flag is set at the start of compiling the regular
7078 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
7079 For example, to make the entire pattern case-sensitive:
7080 .code
7081     ^(?-i)\d+\.a\.b        data for <digits>.a.b
7082 .endd
7083
7084 If the regular expression contains white space or colon characters, you must
7085 either quote it (see &(lsearch)& above), or represent these characters in other
7086 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
7087 colon. This may be easier than quoting, because if you quote, you have to
7088 escape all the backslashes inside the quotes.
7089
7090 &*Note*&: It is not possible to capture substrings in a regular expression
7091 match for later use, because the results of all lookups are cached. If a lookup
7092 is repeated, the result is taken from the cache, and no actual pattern matching
7093 takes place. The values of all the numeric variables are unset after a
7094 &((n)wildlsearch)& match.
7095
7096 .next
7097 Although I cannot see it being of much use, the general matching function that
7098 is used to implement &((n)wildlsearch)& means that the string may begin with a
7099 lookup name terminated by a semicolon, and followed by lookup data. For
7100 example:
7101 .code
7102     cdb;/some/file  data for keys that match the file
7103 .endd
7104 The data that is obtained from the nested lookup is discarded.
7105 .endlist olist
7106
7107 Keys that do not match any of these patterns are interpreted literally. The
7108 continuation rules for the data are the same as for &(lsearch)&, and keys may
7109 be followed by optional colons.
7110
7111 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7112 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7113 lookup types support only literal keys.
7114
7115 .next
7116 .cindex "spf lookup type"
7117 .cindex "lookup" "spf"
7118 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7119 (as opposed to the standard ACL condition method).
7120 For details see section &<<SECSPF>>&.
7121 .endlist ilist
7122
7123
7124 .section "Query-style lookup types" "SECTquerystylelookups"
7125 .cindex "lookup" "query-style types"
7126 .cindex "query-style lookup" "list of types"
7127 The supported query-style lookup types are listed below. Further details about
7128 many of them are given in later sections.
7129
7130 .ilist
7131 .cindex "DNS" "as a lookup type"
7132 .cindex "lookup" "DNS"
7133 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7134 are given in the supplied query. The resulting data is the contents of the
7135 records. See section &<<SECTdnsdb>>&.
7136 .next
7137 .cindex "InterBase lookup type"
7138 .cindex "lookup" "InterBase"
7139 &(ibase)&: This does a lookup in an InterBase database.
7140 .next
7141 .cindex "LDAP" "lookup type"
7142 .cindex "lookup" "LDAP"
7143 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7144 returns attributes from a single entry. There is a variant called &(ldapm)&
7145 that permits values from multiple entries to be returned. A third variant
7146 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7147 any attribute values. See section &<<SECTldap>>&.
7148 .next
7149 .cindex "MySQL" "lookup type"
7150 .cindex "lookup" "MySQL"
7151 &(mysql)&: The format of the query is an SQL statement that is passed to a
7152 MySQL database. See section &<<SECTsql>>&.
7153 .next
7154 .cindex "NIS+ lookup type"
7155 .cindex "lookup" "NIS+"
7156 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7157 the field to be returned. See section &<<SECTnisplus>>&.
7158 .next
7159 .cindex "Oracle" "lookup type"
7160 .cindex "lookup" "Oracle"
7161 &(oracle)&: The format of the query is an SQL statement that is passed to an
7162 Oracle database. See section &<<SECTsql>>&.
7163 .next
7164 .cindex "lookup" "passwd"
7165 .cindex "passwd lookup type"
7166 .cindex "&_/etc/passwd_&"
7167 &(passwd)& is a query-style lookup with queries that are just user names. The
7168 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7169 success, the result string is the same as you would get from an &(lsearch)&
7170 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7171 password value. For example:
7172 .code
7173 *:42:42:King Rat:/home/kr:/bin/bash
7174 .endd
7175 .next
7176 .cindex "PostgreSQL lookup type"
7177 .cindex "lookup" "PostgreSQL"
7178 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7179 PostgreSQL database. See section &<<SECTsql>>&.
7180
7181 .next
7182 .cindex "Redis lookup type"
7183 .cindex lookup Redis
7184 &(redis)&: The format of the query is either a simple get or simple set,
7185 passed to a Redis database. See section &<<SECTsql>>&.
7186
7187 .next
7188 .cindex "sqlite lookup type"
7189 .cindex "lookup" "sqlite"
7190 &(sqlite)&: The format of the query is
7191 an SQL statement that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7192
7193 .next
7194 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7195 not likely to be useful in normal operation.
7196 .next
7197 .cindex "whoson lookup type"
7198 .cindex "lookup" "whoson"
7199 . --- still http:-only, 2018-09-07
7200 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7201 allows a server to check whether a particular (dynamically allocated) IP
7202 address is currently allocated to a known (trusted) user and, optionally, to
7203 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7204 at one time for &"POP before SMTP"& authentication, but that approach has been
7205 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7206 &"POP before SMTP"& checking using ACL statements such as
7207 .code
7208 require condition = \
7209   ${lookup whoson {$sender_host_address}{yes}{no}}
7210 .endd
7211 The query consists of a single IP address. The value returned is the name of
7212 the authenticated user, which is stored in the variable &$value$&. However, in
7213 this example, the data in &$value$& is not used; the result of the lookup is
7214 one of the fixed strings &"yes"& or &"no"&.
7215 .endlist
7216
7217
7218
7219 .section "Temporary errors in lookups" "SECID63"
7220 .cindex "lookup" "temporary error in"
7221 Lookup functions can return temporary error codes if the lookup cannot be
7222 completed. For example, an SQL or LDAP database might be unavailable. For this
7223 reason, it is not advisable to use a lookup that might do this for critical
7224 options such as a list of local domains.
7225
7226 When a lookup cannot be completed in a router or transport, delivery
7227 of the message (to the relevant address) is deferred, as for any other
7228 temporary error. In other circumstances Exim may assume the lookup has failed,
7229 or may give up altogether.
7230
7231
7232
7233 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7234 .cindex "wildcard lookups"
7235 .cindex "lookup" "default values"
7236 .cindex "lookup" "wildcard"
7237 .cindex "lookup" "* added to type"
7238 .cindex "default" "in single-key lookups"
7239 In this context, a &"default value"& is a value specified by the administrator
7240 that is to be used if a lookup fails.
7241
7242 &*Note:*& This section applies only to single-key lookups. For query-style
7243 lookups, the facilities of the query language must be used. An attempt to
7244 specify a default for a query-style lookup provokes an error.
7245
7246 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7247 and the initial lookup fails, the key &"*"& is looked up in the file to
7248 provide a default value. See also the section on partial matching below.
7249
7250 .cindex "*@ with single-key lookup"
7251 .cindex "lookup" "*@ added to type"
7252 .cindex "alias file" "per-domain default"
7253 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7254 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7255 character, a second lookup is done with everything before the last @ replaced
7256 by *. This makes it possible to provide per-domain defaults in alias files
7257 that include the domains in the keys. If the second lookup fails (or doesn't
7258 take place because there is no @ in the key), &"*"& is looked up.
7259 For example, a &(redirect)& router might contain:
7260 .code
7261 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7262 .endd
7263 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7264 looks up these keys, in this order:
7265 .code
7266 jane@eyre.example
7267 *@eyre.example
7268 *
7269 .endd
7270 The data is taken from whichever key it finds first. &*Note*&: In an
7271 &(lsearch)& file, this does not mean the first of these keys in the file. A
7272 complete scan is done for each key, and only if it is not found at all does
7273 Exim move on to try the next key.
7274
7275
7276
7277 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7278 .cindex "partial matching"
7279 .cindex "wildcard lookups"
7280 .cindex "lookup" "partial matching"
7281 .cindex "lookup" "wildcard"
7282 .cindex "asterisk" "in search type"
7283 The normal operation of a single-key lookup is to search the file for an exact
7284 match with the given key. However, in a number of situations where domains are
7285 being looked up, it is useful to be able to do partial matching. In this case,
7286 information in the file that has a key starting with &"*."& is matched by any
7287 domain that ends with the components that follow the full stop. For example, if
7288 a key in a DBM file is
7289 .code
7290 *.dates.fict.example
7291 .endd
7292 then when partial matching is enabled this is matched by (amongst others)
7293 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7294 by &'dates.fict.example'&, if that does not appear as a separate key in the
7295 file.
7296
7297 &*Note*&: Partial matching is not available for query-style lookups. It is
7298 also not available for any lookup items in address lists (see section
7299 &<<SECTaddresslist>>&).
7300
7301 Partial matching is implemented by doing a series of separate lookups using
7302 keys constructed by modifying the original subject key. This means that it can
7303 be used with any of the single-key lookup types, provided that
7304 partial matching keys
7305 beginning with a special prefix (default &"*."&) are included in the data file.
7306 Keys in the file that do not begin with the prefix are matched only by
7307 unmodified subject keys when partial matching is in use.
7308
7309 Partial matching is requested by adding the string &"partial-"& to the front of
7310 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7311 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7312 is added at the start of the subject key, and it is looked up again. If that
7313 fails, further lookups are tried with dot-separated components removed from the
7314 start of the subject key, one-by-one, and &"*."& added on the front of what
7315 remains.
7316
7317 A minimum number of two non-* components are required. This can be adjusted
7318 by including a number before the hyphen in the search type. For example,
7319 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7320 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7321 subject key is &'2250.dates.fict.example'& then the following keys are looked
7322 up when the minimum number of non-* components is two:
7323 .code
7324 2250.dates.fict.example
7325 *.2250.dates.fict.example
7326 *.dates.fict.example
7327 *.fict.example
7328 .endd
7329 As soon as one key in the sequence is successfully looked up, the lookup
7330 finishes.
7331
7332 .cindex "lookup" "partial matching &-- changing prefix"
7333 .cindex "prefix" "for partial matching"
7334 The use of &"*."& as the partial matching prefix is a default that can be
7335 changed. The motivation for this feature is to allow Exim to operate with file
7336 formats that are used by other MTAs. A different prefix can be supplied in
7337 parentheses instead of the hyphen after &"partial"&. For example:
7338 .code
7339 domains = partial(.)lsearch;/some/file
7340 .endd
7341 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7342 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7343 components is unchanged). The prefix may consist of any punctuation characters
7344 other than a closing parenthesis. It may be empty, for example:
7345 .code
7346 domains = partial1()cdb;/some/file
7347 .endd
7348 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7349 &`a.b.c`&, &`b.c`&, and &`c`&.
7350
7351 If &"partial0"& is specified, what happens at the end (when the lookup with
7352 just one non-wild component has failed, and the original key is shortened right
7353 down to the null string) depends on the prefix:
7354
7355 .ilist
7356 If the prefix has zero length, the whole lookup fails.
7357 .next
7358 If the prefix has length 1, a lookup for just the prefix is done. For
7359 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7360 .next
7361 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7362 remainder is looked up. With the default prefix, therefore, the final lookup is
7363 for &"*"& on its own.
7364 .next
7365 Otherwise, the whole prefix is looked up.
7366 .endlist
7367
7368
7369 If the search type ends in &"*"& or &"*@"& (see section
7370 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7371 this implies happens after all partial lookups have failed. If &"partial0"& is
7372 specified, adding &"*"& to the search type has no effect with the default
7373 prefix, because the &"*"& key is already included in the sequence of partial
7374 lookups. However, there might be a use for lookup types such as
7375 &"partial0(.)lsearch*"&.
7376
7377 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7378 in domain lists and the like. Partial matching works only in terms of
7379 dot-separated components; a key such as &`*fict.example`&
7380 in a database file is useless, because the asterisk in a partial matching
7381 subject key is always followed by a dot.
7382
7383
7384
7385
7386 .section "Lookup caching" "SECID64"
7387 .cindex "lookup" "caching"
7388 .cindex "caching" "lookup data"
7389 Exim caches all lookup results in order to avoid needless repetition of
7390 lookups. However, because (apart from the daemon) Exim operates as a collection
7391 of independent, short-lived processes, this caching applies only within a
7392 single Exim process. There is no inter-process lookup caching facility.
7393
7394 For single-key lookups, Exim keeps the relevant files open in case there is
7395 another lookup that needs them. In some types of configuration this can lead to
7396 many files being kept open for messages with many recipients. To avoid hitting
7397 the operating system limit on the number of simultaneously open files, Exim
7398 closes the least recently used file when it needs to open more files than its
7399 own internal limit, which can be changed via the &%lookup_open_max%& option.
7400
7401 The single-key lookup files are closed and the lookup caches are flushed at
7402 strategic points during delivery &-- for example, after all routing is
7403 complete.
7404
7405
7406
7407
7408 .section "Quoting lookup data" "SECID65"
7409 .cindex "lookup" "quoting"
7410 .cindex "quoting" "in lookups"
7411 When data from an incoming message is included in a query-style lookup, there
7412 is the possibility of special characters in the data messing up the syntax of
7413 the query. For example, a NIS+ query that contains
7414 .code
7415 [name=$local_part]
7416 .endd
7417 will be broken if the local part happens to contain a closing square bracket.
7418 For NIS+, data can be enclosed in double quotes like this:
7419 .code
7420 [name="$local_part"]
7421 .endd
7422 but this still leaves the problem of a double quote in the data. The rule for
7423 NIS+ is that double quotes must be doubled. Other lookup types have different
7424 rules, and to cope with the differing requirements, an expansion operator
7425 of the following form is provided:
7426 .code
7427 ${quote_<lookup-type>:<string>}
7428 .endd
7429 For example, the safest way to write the NIS+ query is
7430 .code
7431 [name="${quote_nisplus:$local_part}"]
7432 .endd
7433 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7434 operator can be used for all lookup types, but has no effect for single-key
7435 lookups, since no quoting is ever needed in their key strings.
7436
7437
7438
7439
7440 .section "More about dnsdb" "SECTdnsdb"
7441 .cindex "dnsdb lookup"
7442 .cindex "lookup" "dnsdb"
7443 .cindex "DNS" "as a lookup type"
7444 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7445 of a record type and a domain name, separated by an equals sign. For example,
7446 an expansion string could contain:
7447 .code
7448 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7449 .endd
7450 If the lookup succeeds, the result is placed in &$value$&, which in this case
7451 is used on its own as the result. If the lookup does not succeed, the
7452 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7453 &<<SECTforexpfai>>& for an explanation of what this means.
7454
7455 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7456 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7457 If no type is given, TXT is assumed.
7458
7459 For any record type, if multiple records are found, the data is returned as a
7460 concatenation, with newline as the default separator. The order, of course,
7461 depends on the DNS resolver. You can specify a different separator character
7462 between multiple records by putting a right angle-bracket followed immediately
7463 by the new separator at the start of the query. For example:
7464 .code
7465 ${lookup dnsdb{>: a=host1.example}}
7466 .endd
7467 It is permitted to specify a space as the separator character. Further
7468 white space is ignored.
7469 For lookup types that return multiple fields per record,
7470 an alternate field separator can be specified using a comma after the main
7471 separator character, followed immediately by the field separator.
7472
7473 .cindex "PTR record" "in &(dnsdb)& lookup"
7474 When the type is PTR,
7475 the data can be an IP address, written as normal; inversion and the addition of
7476 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7477 .code
7478 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7479 .endd
7480 If the data for a PTR record is not a syntactically valid IP address, it is not
7481 altered and nothing is added.
7482
7483 .cindex "MX record" "in &(dnsdb)& lookup"
7484 .cindex "SRV record" "in &(dnsdb)& lookup"
7485 For an MX lookup, both the preference value and the host name are returned for
7486 each record, separated by a space. For an SRV lookup, the priority, weight,
7487 port, and host name are returned for each record, separated by spaces.
7488 The field separator can be modified as above.
7489
7490 .cindex "TXT record" "in &(dnsdb)& lookup"
7491 .cindex "SPF record" "in &(dnsdb)& lookup"
7492 For TXT records with multiple items of data, only the first item is returned,
7493 unless a field separator is specified.
7494 To concatenate items without a separator, use a semicolon instead.
7495 For SPF records the
7496 default behaviour is to concatenate multiple items without using a separator.
7497 .code
7498 ${lookup dnsdb{>\n,: txt=a.b.example}}
7499 ${lookup dnsdb{>\n; txt=a.b.example}}
7500 ${lookup dnsdb{spf=example.org}}
7501 .endd
7502 It is permitted to specify a space as the separator character. Further
7503 white space is ignored.
7504
7505 .cindex "SOA record" "in &(dnsdb)& lookup"
7506 For an SOA lookup, while no result is obtained the lookup is redone with
7507 successively more leading components dropped from the given domain.
7508 Only the primary-nameserver field is returned unless a field separator is
7509 specified.
7510 .code
7511 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7512 .endd
7513
7514 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7515 .cindex "dnsdb modifiers"
7516 .cindex "modifiers" "dnsdb"
7517 .cindex "options" "dnsdb"
7518 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7519 each followed by a comma,
7520 that may appear before the record type.
7521
7522 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7523 temporary DNS error for any of them, the behaviour is controlled by
7524 a defer-option modifier.
7525 The possible keywords are
7526 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7527 With &"strict"& behaviour, any temporary DNS error causes the
7528 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7529 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7530 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7531 error causes the whole lookup to defer only if none of the other lookups
7532 succeed. The default is &"lax"&, so the following lookups are equivalent:
7533 .code
7534 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7535 ${lookup dnsdb{a=one.host.com:two.host.com}}
7536 .endd
7537 Thus, in the default case, as long as at least one of the DNS lookups
7538 yields some data, the lookup succeeds.
7539
7540 .cindex "DNSSEC" "dns lookup"
7541 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7542 The possible keywords are
7543 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7544 With &"strict"& or &"lax"& DNSSEC information is requested
7545 with the lookup.
7546 With &"strict"& a response from the DNS resolver that
7547 is not labelled as authenticated data
7548 is treated as equivalent to a temporary DNS error.
7549 The default is &"lax"&.
7550
7551 See also the &$lookup_dnssec_authenticated$& variable.
7552
7553 .cindex timeout "dns lookup"
7554 .cindex "DNS" timeout
7555 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7556 The form is &"retrans_VAL"& where VAL is an Exim time specification
7557 (e.g. &"5s"&).
7558 The default value is set by the main configuration option &%dns_retrans%&.
7559
7560 Retries for the dnsdb lookup can be controlled by a retry modifier.
7561 The form if &"retry_VAL"& where VAL is an integer.
7562 The default count is set by the main configuration option &%dns_retry%&.
7563
7564 .cindex caching "of dns lookup"
7565 .cindex TTL "of dns lookup"
7566 .cindex DNS TTL
7567 Dnsdb lookup results are cached within a single process (and its children).
7568 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7569 value of the set of returned DNS records.
7570
7571
7572 .section "Pseudo dnsdb record types" "SECID66"
7573 .cindex "MX record" "in &(dnsdb)& lookup"
7574 By default, both the preference value and the host name are returned for
7575 each MX record, separated by a space. If you want only host names, you can use
7576 the pseudo-type MXH:
7577 .code
7578 ${lookup dnsdb{mxh=a.b.example}}
7579 .endd
7580 In this case, the preference values are omitted, and just the host names are
7581 returned.
7582
7583 .cindex "name server for enclosing domain"
7584 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7585 records on the given domain, but if none are found, it removes the first
7586 component of the domain name, and tries again. This process continues until NS
7587 records are found or there are no more components left (or there is a DNS
7588 error). In other words, it may return the name servers for a top-level domain,
7589 but it never returns the root name servers. If there are no NS records for the
7590 top-level domain, the lookup fails. Consider these examples:
7591 .code
7592 ${lookup dnsdb{zns=xxx.quercite.com}}
7593 ${lookup dnsdb{zns=xxx.edu}}
7594 .endd
7595 Assuming that in each case there are no NS records for the full domain name,
7596 the first returns the name servers for &%quercite.com%&, and the second returns
7597 the name servers for &%edu%&.
7598
7599 You should be careful about how you use this lookup because, unless the
7600 top-level domain does not exist, the lookup always returns some host names. The
7601 sort of use to which this might be put is for seeing if the name servers for a
7602 given domain are on a blacklist. You can probably assume that the name servers
7603 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7604 such a list.
7605
7606 .cindex "CSA" "in &(dnsdb)& lookup"
7607 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7608 records according to the CSA rules, which are described in section
7609 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7610 not sufficient because of the extra parent domain search behaviour of CSA. The
7611 result of a successful lookup such as:
7612 .code
7613 ${lookup dnsdb {csa=$sender_helo_name}}
7614 .endd
7615 has two space-separated fields: an authorization code and a target host name.
7616 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7617 authorization required but absent, or &"?"& for unknown.
7618
7619 .cindex "A+" "in &(dnsdb)& lookup"
7620 The pseudo-type A+ performs an AAAA
7621 and then an A lookup.  All results are returned; defer processing
7622 (see below) is handled separately for each lookup.  Example:
7623 .code
7624 ${lookup dnsdb {>; a+=$sender_helo_name}}
7625 .endd
7626
7627
7628 .section "Multiple dnsdb lookups" "SECID67"
7629 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7630 However, you can specify a list of domains or IP addresses in a single
7631 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7632 the default separator, but with the ability to change this. For example:
7633 .code
7634 ${lookup dnsdb{one.domain.com:two.domain.com}}
7635 ${lookup dnsdb{a=one.host.com:two.host.com}}
7636 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7637 .endd
7638 In order to retain backwards compatibility, there is one special case: if
7639 the lookup type is PTR and no change of separator is specified, Exim looks
7640 to see if the rest of the string is precisely one IPv6 address. In this
7641 case, it does not treat it as a list.
7642
7643 The data from each lookup is concatenated, with newline separators by default,
7644 in the same way that multiple DNS records for a single item are handled. A
7645 different separator can be specified, as described above.
7646
7647
7648
7649
7650 .section "More about LDAP" "SECTldap"
7651 .cindex "LDAP" "lookup, more about"
7652 .cindex "lookup" "LDAP"
7653 .cindex "Solaris" "LDAP"
7654 The original LDAP implementation came from the University of Michigan; this has
7655 become &"Open LDAP"&, and there are now two different releases. Another
7656 implementation comes from Netscape, and Solaris 7 and subsequent releases
7657 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7658 the lookup function level, their error handling is different. For this reason
7659 it is necessary to set a compile-time variable when building Exim with LDAP, to
7660 indicate which LDAP library is in use. One of the following should appear in
7661 your &_Local/Makefile_&:
7662 .code
7663 LDAP_LIB_TYPE=UMICHIGAN
7664 LDAP_LIB_TYPE=OPENLDAP1
7665 LDAP_LIB_TYPE=OPENLDAP2
7666 LDAP_LIB_TYPE=NETSCAPE
7667 LDAP_LIB_TYPE=SOLARIS
7668 .endd
7669 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7670 same interface as the University of Michigan version.
7671
7672 There are three LDAP lookup types in Exim. These behave slightly differently in
7673 the way they handle the results of a query:
7674
7675 .ilist
7676 &(ldap)& requires the result to contain just one entry; if there are more, it
7677 gives an error.
7678 .next
7679 &(ldapdn)& also requires the result to contain just one entry, but it is the
7680 Distinguished Name that is returned rather than any attribute values.
7681 .next
7682 &(ldapm)& permits the result to contain more than one entry; the attributes
7683 from all of them are returned.
7684 .endlist
7685
7686
7687 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7688 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7689 the data returned by a successful lookup is described in the next section.
7690 First we explain how LDAP queries are coded.
7691
7692
7693 .section "Format of LDAP queries" "SECTforldaque"
7694 .cindex "LDAP" "query format"
7695 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7696 the configuration of a &(redirect)& router one might have this setting:
7697 .code
7698 data = ${lookup ldap \
7699   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7700   c=UK?mailbox?base?}}
7701 .endd
7702 .cindex "LDAP" "with TLS"
7703 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7704 secure (encrypted) LDAP connections. The second of these ensures that an
7705 encrypted TLS connection is used.
7706
7707 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7708 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7709 See the &%ldap_start_tls%& option.
7710
7711 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7712 controlled. Every part of the TLS configuration can be configured by settings in
7713 &_exim.conf_&. Depending on the version of the client libraries installed on
7714 your system, some of the initialization may have required setting options in
7715 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7716 certificates. This revealed a nuance where the current UID that exim was
7717 running as could affect which config files it read. With Exim 4.83, these
7718 methods become optional, only taking effect if not specifically set in
7719 &_exim.conf_&.
7720
7721
7722 .section "LDAP quoting" "SECID68"
7723 .cindex "LDAP" "quoting"
7724 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7725 and the second because the LDAP query is represented as a URL. Furthermore,
7726 within an LDAP query, two different kinds of quoting are required. For this
7727 reason, there are two different LDAP-specific quoting operators.
7728
7729 The &%quote_ldap%& operator is designed for use on strings that are part of
7730 filter specifications. Conceptually, it first does the following conversions on
7731 the string:
7732 .code
7733 *   =>   \2A
7734 (   =>   \28
7735 )   =>   \29
7736 \   =>   \5C
7737 .endd
7738 in accordance with RFC 2254. The resulting string is then quoted according
7739 to the rules for URLs, that is, all non-alphanumeric characters except
7740 .code
7741 ! $ ' - . _ ( ) * +
7742 .endd
7743 are converted to their hex values, preceded by a percent sign. For example:
7744 .code
7745 ${quote_ldap: a(bc)*, a<yz>; }
7746 .endd
7747 yields
7748 .code
7749 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7750 .endd
7751 Removing the URL quoting, this is (with a leading and a trailing space):
7752 .code
7753 a\28bc\29\2A, a<yz>;
7754 .endd
7755 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7756 base DN specifications in queries. Conceptually, it first converts the string
7757 by inserting a backslash in front of any of the following characters:
7758 .code
7759 , + " \ < > ;
7760 .endd
7761 It also inserts a backslash before any leading spaces or # characters, and
7762 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7763 is then quoted according to the rules for URLs. For example:
7764 .code
7765 ${quote_ldap_dn: a(bc)*, a<yz>; }
7766 .endd
7767 yields
7768 .code
7769 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7770 .endd
7771 Removing the URL quoting, this is (with a trailing space):
7772 .code
7773 \ a(bc)*\, a\<yz\>\;\
7774 .endd
7775 There are some further comments about quoting in the section on LDAP
7776 authentication below.
7777
7778
7779 .section "LDAP connections" "SECID69"
7780 .cindex "LDAP" "connections"
7781 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7782 is in use, via a Unix domain socket. The example given above does not specify
7783 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7784 by starting it with
7785 .code
7786 ldap://<hostname>:<port>/...
7787 .endd
7788 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7789 used. When no server is specified in a query, a list of default servers is
7790 taken from the &%ldap_default_servers%& configuration option. This supplies a
7791 colon-separated list of servers which are tried in turn until one successfully
7792 handles a query, or there is a serious error. Successful handling either
7793 returns the requested data, or indicates that it does not exist. Serious errors
7794 are syntactical, or multiple values when only a single value is expected.
7795 Errors which cause the next server to be tried are connection failures, bind
7796 failures, and timeouts.
7797
7798 For each server name in the list, a port number can be given. The standard way
7799 of specifying a host and port is to use a colon separator (RFC 1738). Because
7800 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7801 doubled. For example
7802 .code
7803 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7804 .endd
7805 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7806 to the LDAP library with no server name, and the library's default (normally
7807 the local host) is used.
7808
7809 If you are using the OpenLDAP library, you can connect to an LDAP server using
7810 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7811 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7812 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7813 not available.
7814
7815 For this type of connection, instead of a host name for the server, a pathname
7816 for the socket is required, and the port number is not relevant. The pathname
7817 can be specified either as an item in &%ldap_default_servers%&, or inline in
7818 the query. In the former case, you can have settings such as
7819 .code
7820 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7821 .endd
7822 When the pathname is given in the query, you have to escape the slashes as
7823 &`%2F`& to fit in with the LDAP URL syntax. For example:
7824 .code
7825 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7826 .endd
7827 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7828 a pathname, it uses the Unix domain socket code, even if the query actually
7829 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7830 socket connection. This behaviour means that you can use a setting of
7831 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7832 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7833 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7834 backup host.
7835
7836 If an explicit &`ldapi`& type is given in a query when a host name is
7837 specified, an error is diagnosed. However, if there are more items in
7838 &%ldap_default_servers%&, they are tried. In other words:
7839
7840 .ilist
7841 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7842 interface.
7843 .next
7844 Using &`ldapi`& with a host name causes an error.
7845 .endlist
7846
7847
7848 Using &`ldapi`& with no host or path in the query, and no setting of
7849 &%ldap_default_servers%&, does whatever the library does by default.
7850
7851
7852
7853 .section "LDAP authentication and control information" "SECID70"
7854 .cindex "LDAP" "authentication"
7855 The LDAP URL syntax provides no way of passing authentication and other control
7856 information to the server. To make this possible, the URL in an LDAP query may
7857 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7858 spaces. If a value contains spaces it must be enclosed in double quotes, and
7859 when double quotes are used, backslash is interpreted in the usual way inside
7860 them. The following names are recognized:
7861 .display
7862 &`DEREFERENCE`&  set the dereferencing parameter
7863 &`NETTIME    `&  set a timeout for a network operation
7864 &`USER       `&  set the DN, for authenticating the LDAP bind
7865 &`PASS       `&  set the password, likewise
7866 &`REFERRALS  `&  set the referrals parameter
7867 &`SERVERS    `&  set alternate server list for this query only
7868 &`SIZE       `&  set the limit for the number of entries returned
7869 &`TIME       `&  set the maximum waiting time for a query
7870 .endd
7871 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7872 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7873 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7874 library from trying to follow referrals issued by the LDAP server.
7875
7876 .cindex LDAP timeout
7877 .cindex timeout "LDAP lookup"
7878 The name CONNECT is an obsolete name for NETTIME, retained for
7879 backwards compatibility. This timeout (specified as a number of seconds) is
7880 enforced from the client end for operations that can be carried out over a
7881 network. Specifically, it applies to network connections and calls to the
7882 &'ldap_result()'& function. If the value is greater than zero, it is used if
7883 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7884 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7885 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7886 Netscape SDK; for OpenLDAP no action is taken.
7887
7888 The TIME parameter (also a number of seconds) is passed to the server to
7889 set a server-side limit on the time taken to complete a search.
7890
7891 The SERVERS parameter allows you to specify an alternate list of ldap servers
7892 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7893 default list of ldap servers, and a single lookup can specify a single ldap
7894 server to use.  But when you need to do a lookup with a list of servers that is
7895 different than the default list (maybe different order, maybe a completely
7896 different set of servers), the SERVERS parameter allows you to specify this
7897 alternate list (colon-separated).
7898
7899 Here is an example of an LDAP query in an Exim lookup that uses some of these
7900 values. This is a single line, folded to fit on the page:
7901 .code
7902 ${lookup ldap
7903   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7904   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7905   {$value}fail}
7906 .endd
7907 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7908 any of the auxiliary data. Exim configuration settings that include lookups
7909 which contain password information should be preceded by &"hide"& to prevent
7910 non-admin users from using the &%-bP%& option to see their values.
7911
7912 The auxiliary data items may be given in any order. The default is no
7913 connection timeout (the system timeout is used), no user or password, no limit
7914 on the number of entries returned, and no time limit on queries.
7915
7916 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7917 removes any URL quoting that it may contain before passing it LDAP. Apparently
7918 some libraries do this for themselves, but some do not. Removing the URL
7919 quoting has two advantages:
7920
7921 .ilist
7922 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7923 DNs as with DNs inside actual queries.
7924 .next
7925 It permits spaces inside USER= DNs.
7926 .endlist
7927
7928 For example, a setting such as
7929 .code
7930 USER=cn=${quote_ldap_dn:$1}
7931 .endd
7932 should work even if &$1$& contains spaces.
7933
7934 Expanded data for the PASS= value should be quoted using the &%quote%&
7935 expansion operator, rather than the LDAP quote operators. The only reason this
7936 field needs quoting is to ensure that it conforms to the Exim syntax, which
7937 does not allow unquoted spaces. For example:
7938 .code
7939 PASS=${quote:$3}
7940 .endd
7941 The LDAP authentication mechanism can be used to check passwords as part of
7942 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7943 &<<CHAPexpand>>&.
7944
7945
7946
7947 .section "Format of data returned by LDAP" "SECID71"
7948 .cindex "LDAP" "returned data formats"
7949 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7950 as a sequence of values, for example
7951 .code
7952 cn=manager,o=University of Cambridge,c=UK
7953 .endd
7954 The &(ldap)& lookup type generates an error if more than one entry matches the
7955 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7956 the result between the data from different entries. It is possible for multiple
7957 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7958 you know that whatever values are returned all came from a single entry in the
7959 directory.
7960
7961 In the common case where you specify a single attribute in your LDAP query, the
7962 result is not quoted, and does not contain the attribute name. If the attribute
7963 has multiple values, they are separated by commas. Any comma that is
7964 part of an attribute's value is doubled.
7965
7966 If you specify multiple attributes, the result contains space-separated, quoted
7967 strings, each preceded by the attribute name and an equals sign. Within the
7968 quotes, the quote character, backslash, and newline are escaped with
7969 backslashes, and commas are used to separate multiple values for the attribute.
7970 Any commas in attribute values are doubled
7971 (permitting treatment of the values as a comma-separated list).
7972 Apart from the escaping, the string within quotes takes the same form as the
7973 output when a single attribute is requested. Specifying no attributes is the
7974 same as specifying all of an entry's attributes.
7975
7976 Here are some examples of the output format. The first line of each pair is an
7977 LDAP query, and the second is the data that is returned. The attribute called
7978 &%attr1%& has two values, one of them with an embedded comma, whereas
7979 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7980 (they have SUP &%attr%& in their schema definitions).
7981
7982 .code
7983 ldap:///o=base?attr1?sub?(uid=fred)
7984 value1.1,value1,,2
7985
7986 ldap:///o=base?attr2?sub?(uid=fred)
7987 value two
7988
7989 ldap:///o=base?attr?sub?(uid=fred)
7990 value1.1,value1,,2,value two
7991
7992 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7993 attr1="value1.1,value1,,2" attr2="value two"
7994
7995 ldap:///o=base??sub?(uid=fred)
7996 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7997 .endd
7998 You can
7999 make use of Exim's &%-be%& option to run expansion tests and thereby check the
8000 results of LDAP lookups.
8001 The &%extract%& operator in string expansions can be used to pick out
8002 individual fields from data that consists of &'key'&=&'value'& pairs.
8003 The &%listextract%& operator should be used to pick out individual values
8004 of attributes, even when only a single value is expected.
8005 The doubling of embedded commas allows you to use the returned data as a
8006 comma separated list (using the "<," syntax for changing the input list separator).
8007
8008
8009
8010
8011 .section "More about NIS+" "SECTnisplus"
8012 .cindex "NIS+ lookup type"
8013 .cindex "lookup" "NIS+"
8014 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
8015 and field name. If this is given, the result of a successful query is the
8016 contents of the named field; otherwise the result consists of a concatenation
8017 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
8018 values containing spaces are quoted. For example, the query
8019 .code
8020 [name=mg1456],passwd.org_dir
8021 .endd
8022 might return the string
8023 .code
8024 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
8025 home=/home/mg1456 shell=/bin/bash shadow=""
8026 .endd
8027 (split over two lines here to fit on the page), whereas
8028 .code
8029 [name=mg1456],passwd.org_dir:gcos
8030 .endd
8031 would just return
8032 .code
8033 Martin Guerre
8034 .endd
8035 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
8036 for the given indexed key. The effect of the &%quote_nisplus%& expansion
8037 operator is to double any quote characters within the text.
8038
8039
8040
8041 .section "SQL lookups" "SECTsql"
8042 .cindex "SQL lookup types"
8043 .cindex "MySQL" "lookup type"
8044 .cindex "PostgreSQL lookup type"
8045 .cindex "lookup" "MySQL"
8046 .cindex "lookup" "PostgreSQL"
8047 .cindex "Oracle" "lookup type"
8048 .cindex "lookup" "Oracle"
8049 .cindex "InterBase lookup type"
8050 .cindex "lookup" "InterBase"
8051 .cindex "Redis lookup type"
8052 .cindex lookup Redis
8053 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
8054 and SQLite
8055 databases. Queries for these databases contain SQL statements, so an example
8056 might be
8057 .code
8058 ${lookup mysql{select mailbox from users where id='userx'}\
8059   {$value}fail}
8060 .endd
8061 If the result of the query contains more than one field, the data for each
8062 field in the row is returned, preceded by its name, so the result of
8063 .code
8064 ${lookup pgsql{select home,name from users where id='userx'}\
8065   {$value}}
8066 .endd
8067 might be
8068 .code
8069 home=/home/userx name="Mister X"
8070 .endd
8071 Empty values and values containing spaces are double quoted, with embedded
8072 quotes escaped by a backslash. If the result of the query contains just one
8073 field, the value is passed back verbatim, without a field name, for example:
8074 .code
8075 Mister X
8076 .endd
8077 If the result of the query yields more than one row, it is all concatenated,
8078 with a newline between the data for each row.
8079
8080
8081 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
8082 .cindex "MySQL" "lookup type"
8083 .cindex "PostgreSQL lookup type"
8084 .cindex "lookup" "MySQL"
8085 .cindex "lookup" "PostgreSQL"
8086 .cindex "Oracle" "lookup type"
8087 .cindex "lookup" "Oracle"
8088 .cindex "InterBase lookup type"
8089 .cindex "lookup" "InterBase"
8090 .cindex "Redis lookup type"
8091 .cindex lookup Redis
8092 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8093 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8094 or &%redis_servers%&
8095 option (as appropriate) must be set to a colon-separated list of server
8096 information.
8097 .oindex &%mysql_servers%&
8098 .oindex &%pgsql_servers%&
8099 .oindex &%oracle_servers%&
8100 .oindex &%ibase_servers%&
8101 .oindex &%redis_servers%&
8102 (For MySQL and PostgreSQL, the global option need not be set if all
8103 queries contain their own server information &-- see section
8104 &<<SECTspeserque>>&.)
8105 For all but Redis
8106 each item in the list is a slash-separated list of four
8107 items: host name, database name, user name, and password. In the case of
8108 Oracle, the host name field is used for the &"service name"&, and the database
8109 name field is not used and should be empty. For example:
8110 .code
8111 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8112 .endd
8113 Because password data is sensitive, you should always precede the setting with
8114 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8115 option. Here is an example where two MySQL servers are listed:
8116 .code
8117 hide mysql_servers = localhost/users/root/secret:\
8118                      otherhost/users/root/othersecret
8119 .endd
8120 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8121 because this is a colon-separated list, the colon has to be doubled. For each
8122 query, these parameter groups are tried in order until a connection is made and
8123 a query is successfully processed. The result of a query may be that no data is
8124 found, but that is still a successful query. In other words, the list of
8125 servers provides a backup facility, not a list of different places to look.
8126
8127 For Redis the global option need not be specified if all queries contain their
8128 own server information &-- see section &<<SECTspeserque>>&.
8129 If specified, the option must be set to a colon-separated list of server
8130 information.
8131 Each item in the list is a slash-separated list of three items:
8132 host, database number, and password.
8133 .olist
8134 The host is required and may be either an IPv4 address and optional
8135 port number (separated by a colon, which needs doubling due to the
8136 higher-level list), or a Unix socket pathname enclosed in parentheses
8137 .next
8138 The database number is optional; if present that number is selected in the backend
8139 .next
8140 The password is optional; if present it is used to authenticate to the backend
8141 .endlist
8142
8143 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8144 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8145 respectively, and the characters single-quote, double-quote, and backslash
8146 itself are escaped with backslashes.
8147
8148 The &%quote_redis%& expansion operator
8149 escapes whitespace and backslash characters with a backslash.
8150
8151 .section "Specifying the server in the query" "SECTspeserque"
8152 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8153 it is possible to specify a list of servers with an individual query. This is
8154 done by appending a comma-separated option to the query type:
8155 .display
8156 &`,servers=`&&'server1:server2:server3:...'&
8157 .endd
8158 Each item in the list may take one of two forms:
8159 .olist
8160 If it contains no slashes it is assumed to be just a host name. The appropriate
8161 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8162 of the same name, and the remaining parameters (database, user, password) are
8163 taken from there.
8164 .next
8165 If it contains any slashes, it is taken as a complete parameter set.
8166 .endlist
8167 The list of servers is used in exactly the same way as the global list.
8168 Once a connection to a server has happened and a query has been
8169 successfully executed, processing of the lookup ceases.
8170
8171 This feature is intended for use in master/slave situations where updates
8172 are occurring and you want to update the master rather than a slave. If the
8173 master is in the list as a backup for reading, you might have a global setting
8174 like this:
8175 .code
8176 mysql_servers = slave1/db/name/pw:\
8177                 slave2/db/name/pw:\
8178                 master/db/name/pw
8179 .endd
8180 In an updating lookup, you could then write:
8181 .code
8182 ${lookup mysql,servers=master {UPDATE ...} }
8183 .endd
8184 That query would then be sent only to the master server. If, on the other hand,
8185 the master is not to be used for reading, and so is not present in the global
8186 option, you can still update it by a query of this form:
8187 .code
8188 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8189 .endd
8190
8191 An older syntax places the servers specification before the query,
8192 semicolon separated:
8193 .code
8194 ${lookup mysql{servers=master; UPDATE ...} }
8195 .endd
8196 The new version avoids potential issues with tainted
8197 arguments in the query, for explicit expansion.
8198 &*Note*&: server specifications in list-style lookups are still problematic.
8199
8200
8201 .section "Special MySQL features" "SECID73"
8202 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8203 causes a connection to the server on the local host by means of a Unix domain
8204 socket. An alternate socket can be specified in parentheses.
8205 An option group name for MySQL option files can be specified in square brackets;
8206 the default value is &"exim"&.
8207 The full syntax of each item in &%mysql_servers%& is:
8208 .display
8209 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8210   <&'database'&>/<&'user'&>/<&'password'&>
8211 .endd
8212 Any of the four sub-parts of the first field can be omitted. For normal use on
8213 the local host it can be left blank or set to just &"localhost"&.
8214
8215 No database need be supplied &-- but if it is absent here, it must be given in
8216 the queries.
8217
8218 If a MySQL query is issued that does not request any data (an insert, update,
8219 or delete command), the result of the lookup is the number of rows affected.
8220
8221 &*Warning*&: This can be misleading. If an update does not actually change
8222 anything (for example, setting a field to the value it already has), the result
8223 is zero because no rows are affected.
8224
8225
8226 .section "Special PostgreSQL features" "SECID74"
8227 PostgreSQL lookups can also use Unix domain socket connections to the database.
8228 This is usually faster and costs less CPU time than a TCP/IP connection.
8229 However it can be used only if the mail server runs on the same machine as the
8230 database server. A configuration line for PostgreSQL via Unix domain sockets
8231 looks like this:
8232 .code
8233 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8234 .endd
8235 In other words, instead of supplying a host name, a path to the socket is
8236 given. The path name is enclosed in parentheses so that its slashes aren't
8237 visually confused with the delimiters for the other server parameters.
8238
8239 If a PostgreSQL query is issued that does not request any data (an insert,
8240 update, or delete command), the result of the lookup is the number of rows
8241 affected.
8242
8243 .section "More about SQLite" "SECTsqlite"
8244 .cindex "lookup" "SQLite"
8245 .cindex "sqlite lookup type"
8246 SQLite is different to the other SQL lookups because a filename is required in
8247 addition to the SQL query. An SQLite database is a single file, and there is no
8248 daemon as in the other SQL databases.
8249
8250 .new
8251 .oindex &%sqlite_dbfile%&
8252 There are two ways of
8253 specifying the file.
8254 The first is is by using the &%sqlite_dbfile%& main option.
8255 The second, which allows separate files for each query,
8256 is to use an option appended, comma-separated, to the &"sqlite"&
8257 lookup type word.  The option is the word &"file"&, then an equals,
8258 then the filename.
8259 The filename in this case cannot contain whitespace or open-brace charachters.
8260 .wen
8261
8262 A deprecated method is available, prefixing the query with the filename
8263 separated by white space.
8264 This means that
8265 .cindex "tainted data" "sqlite file"
8266 the query cannot use any tainted values, as that taints
8267 the entire query including the filename - resulting in a refusal to open
8268 the file.
8269
8270 In all the above cases the filename must be an absolute path.
8271
8272 Here is a lookup expansion example:
8273 .code
8274 sqlite_dbfile = /some/thing/sqlitedb
8275 ...
8276 ${lookup sqlite {select name from aliases where id='userx';}}
8277 .endd
8278 In a list, the syntax is similar. For example:
8279 .code
8280 domainlist relay_to_domains = sqlite;\
8281    select * from relays where ip='$sender_host_address';
8282 .endd
8283 The only character affected by the &%quote_sqlite%& operator is a single
8284 quote, which it doubles.
8285
8286 .cindex timeout SQLite
8287 .cindex sqlite "lookup timeout"
8288 The SQLite library handles multiple simultaneous accesses to the database
8289 internally. Multiple readers are permitted, but only one process can
8290 update at once. Attempts to access the database while it is being updated
8291 are rejected after a timeout period, during which the SQLite library
8292 waits for the lock to be released. In Exim, the default timeout is set
8293 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8294 option.
8295
8296 .section "More about Redis" "SECTredis"
8297 .cindex "lookup" "Redis"
8298 .cindex "redis lookup type"
8299 Redis is a non-SQL database. Commands are simple get and set.
8300 Examples:
8301 .code
8302 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8303 ${lookup redis{get keyname}}
8304 .endd
8305
8306 As of release 4.91, "lightweight" support for Redis Cluster is available.
8307 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8308 of which must be reachable from the running exim instance. If the cluster has
8309 master/slave replication, the list must contain all the master and slave
8310 servers.
8311
8312 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8313 immediately follow the redirection but treats the response as a DEFER, moving on
8314 to the next server in the &%redis_servers%& list until the correct server is
8315 reached.
8316
8317 .ecindex IIDfidalo1
8318 .ecindex IIDfidalo2
8319
8320
8321 . ////////////////////////////////////////////////////////////////////////////
8322 . ////////////////////////////////////////////////////////////////////////////
8323
8324 .chapter "Domain, host, address, and local part lists" &&&
8325          "CHAPdomhosaddlists" &&&
8326          "Domain, host, and address lists"
8327 .scindex IIDdohoadli "lists of domains; hosts; etc."
8328 A number of Exim configuration options contain lists of domains, hosts,
8329 email addresses, or local parts. For example, the &%hold_domains%& option
8330 contains a list of domains whose delivery is currently suspended. These lists
8331 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8332 arguments to expansion conditions such as &%match_domain%&.
8333
8334 Each item in one of these lists is a pattern to be matched against a domain,
8335 host, email address, or local part, respectively. In the sections below, the
8336 different types of pattern for each case are described, but first we cover some
8337 general facilities that apply to all four kinds of list.
8338
8339 Note that other parts of Exim use a &'string list'& which does not
8340 support all the complexity available in
8341 domain, host, address and local part lists.
8342
8343
8344
8345 .section "Expansion of lists" "SECTlistexpand"
8346 .cindex "expansion" "of lists"
8347 Each list is expanded as a single string before it is used.
8348
8349 &'Exception: the router headers_remove option, where list-item
8350 splitting is done before string-expansion.'&
8351
8352 The result of
8353 expansion must be a list, possibly containing empty items, which is split up
8354 into separate items for matching. By default, colon is the separator character,
8355 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8356 &<<SECTempitelis>>& for details of the list syntax; the second of these
8357 discusses the way to specify empty list items.
8358
8359
8360 If the string expansion is forced to fail, Exim behaves as if the item it is
8361 testing (domain, host, address, or local part) is not in the list. Other
8362 expansion failures cause temporary errors.
8363
8364 If an item in a list is a regular expression, backslashes, dollars and possibly
8365 other special characters in the expression must be protected against
8366 misinterpretation by the string expander. The easiest way to do this is to use
8367 the &`\N`& expansion feature to indicate that the contents of the regular
8368 expression should not be expanded. For example, in an ACL you might have:
8369 .code
8370 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8371                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8372 .endd
8373 The first item is a regular expression that is protected from expansion by
8374 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8375 senders based on the receiving domain.
8376
8377
8378
8379
8380 .section "Negated items in lists" "SECID76"
8381 .cindex "list" "negation"
8382 .cindex "negation" "in lists"
8383 Items in a list may be positive or negative. Negative items are indicated by a
8384 leading exclamation mark, which may be followed by optional white space. A list
8385 defines a set of items (domains, etc). When Exim processes one of these lists,
8386 it is trying to find out whether a domain, host, address, or local part
8387 (respectively) is in the set that is defined by the list. It works like this:
8388
8389 The list is scanned from left to right. If a positive item is matched, the
8390 subject that is being checked is in the set; if a negative item is matched, the
8391 subject is not in the set. If the end of the list is reached without the
8392 subject having matched any of the patterns, it is in the set if the last item
8393 was a negative one, but not if it was a positive one. For example, the list in
8394 .code
8395 domainlist relay_to_domains = !a.b.c : *.b.c
8396 .endd
8397 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8398 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8399 list is positive. However, if the setting were
8400 .code
8401 domainlist relay_to_domains = !a.b.c
8402 .endd
8403 then all domains other than &'a.b.c'& would match because the last item in the
8404 list is negative. In other words, a list that ends with a negative item behaves
8405 as if it had an extra item &`:*`& on the end.
8406
8407 Another way of thinking about positive and negative items in lists is to read
8408 the connector as &"or"& after a positive item and as &"and"& after a negative
8409 item.
8410
8411
8412
8413 .section "File names in lists" "SECTfilnamlis"
8414 .cindex "list" "filename in"
8415 If an item in a domain, host, address, or local part list is an absolute
8416 filename (beginning with a slash character), each line of the file is read and
8417 processed as if it were an independent item in the list, except that further
8418 filenames are not allowed,
8419 and no expansion of the data from the file takes place.
8420 Empty lines in the file are ignored, and the file may also contain comment
8421 lines:
8422
8423 .ilist
8424 For domain and host lists, if a # character appears anywhere in a line of the
8425 file, it and all following characters are ignored.
8426 .next
8427 Because local parts may legitimately contain # characters, a comment in an
8428 address list or local part list file is recognized only if # is preceded by
8429 white space or the start of the line. For example:
8430 .code
8431 not#comment@x.y.z   # but this is a comment
8432 .endd
8433 .endlist
8434
8435 Putting a filename in a list has the same effect as inserting each line of the
8436 file as an item in the list (blank lines and comments excepted). However, there
8437 is one important difference: the file is read each time the list is processed,
8438 so if its contents vary over time, Exim's behaviour changes.
8439
8440 If a filename is preceded by an exclamation mark, the sense of any match
8441 within the file is inverted. For example, if
8442 .code
8443 hold_domains = !/etc/nohold-domains
8444 .endd
8445 and the file contains the lines
8446 .code
8447 !a.b.c
8448 *.b.c
8449 .endd
8450 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8451 any domain matching &`*.b.c`& is not.
8452
8453
8454
8455 .section "An lsearch file is not an out-of-line list" "SECID77"
8456 As will be described in the sections that follow, lookups can be used in lists
8457 to provide indexed methods of checking list membership. There has been some
8458 confusion about the way &(lsearch)& lookups work in lists. Because
8459 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8460 sometimes thought that it is allowed to contain wild cards and other kinds of
8461 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8462 always fixed strings, just as for any other single-key lookup type.
8463
8464 If you want to use a file to contain wild-card patterns that form part of a
8465 list, just give the filename on its own, without a search type, as described
8466 in the previous section. You could also use the &(wildlsearch)& or
8467 &(nwildlsearch)&, but there is no advantage in doing this.
8468
8469
8470
8471
8472 .section "Results of list checking" SECTlistresults
8473 The primary result of doing a list check is a truth value.
8474 In some contexts additional information is stored
8475 about the list element that matched:
8476 .vlist
8477 .vitem hosts
8478 A &%hosts%& ACL condition
8479 will store a result in the &$host_data$& variable.
8480 .vitem local_parts
8481 A &%local_parts%& router option or &%local_parts%& ACL condition
8482 will store a result in the &$local_part_data$& variable.
8483 .vitem domains
8484 .new
8485 A &%domains%& router option or &%domains%& ACL condition
8486 will store a result in the &$domain_data$& variable
8487 .wen
8488 .vitem senders
8489 A &%senders%& router option or &%senders%& ACL condition
8490 will store a result in the &$sender_data$& variable.
8491 .vitem recipients
8492 A &%recipients%& ACL condition
8493 will store a result in the &$recipient_data$& variable.
8494 .endlist
8495
8496 The detail of the additional information depends on the
8497 type of match and is given below as the &*value*& information.
8498
8499
8500
8501
8502 .section "Named lists" "SECTnamedlists"
8503 .cindex "named lists"
8504 .cindex "list" "named"
8505 A list of domains, hosts, email addresses, or local parts can be given a name
8506 which is then used to refer to the list elsewhere in the configuration. This is
8507 particularly convenient if the same list is required in several different
8508 places. It also allows lists to be given meaningful names, which can improve
8509 the readability of the configuration. For example, it is conventional to define
8510 a domain list called &'local_domains'& for all the domains that are handled
8511 locally on a host, using a configuration line such as
8512 .code
8513 domainlist local_domains = localhost:my.dom.example
8514 .endd
8515 Named lists are referenced by giving their name preceded by a plus sign, so,
8516 for example, a router that is intended to handle local domains would be
8517 configured with the line
8518 .code
8519 domains = +local_domains
8520 .endd
8521 The first router in a configuration is often one that handles all domains
8522 except the local ones, using a configuration with a negated item like this:
8523 .code
8524 dnslookup:
8525   driver = dnslookup
8526   domains = ! +local_domains
8527   transport = remote_smtp
8528   no_more
8529 .endd
8530 The four kinds of named list are created by configuration lines starting with
8531 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8532 respectively. Then there follows the name that you are defining, followed by an
8533 equals sign and the list itself. For example:
8534 .code
8535 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8536 addresslist bad_senders = cdb;/etc/badsenders
8537 .endd
8538 A named list may refer to other named lists:
8539 .code
8540 domainlist  dom1 = first.example : second.example
8541 domainlist  dom2 = +dom1 : third.example
8542 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8543 .endd
8544 &*Warning*&: If the last item in a referenced list is a negative one, the
8545 effect may not be what you intended, because the negation does not propagate
8546 out to the higher level. For example, consider:
8547 .code
8548 domainlist  dom1 = !a.b
8549 domainlist  dom2 = +dom1 : *.b
8550 .endd
8551 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8552 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8553 means it matches the second list as well. The effect is not the same as
8554 .code
8555 domainlist  dom2 = !a.b : *.b
8556 .endd
8557 where &'x.y'& does not match. It's best to avoid negation altogether in
8558 referenced lists if you can.
8559
8560 .cindex "hiding named list values"
8561 .cindex "named lists" "hiding value of"
8562 Some named list definitions may contain sensitive data, for example, passwords for
8563 accessing databases. To stop non-admin users from using the &%-bP%& command
8564 line option to read these values, you can precede the definition with the
8565 word &"hide"&. For example:
8566 .code
8567 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8568 .endd
8569
8570
8571 Named lists may have a performance advantage. When Exim is routing an
8572 address or checking an incoming message, it caches the result of tests on named
8573 lists. So, if you have a setting such as
8574 .code
8575 domains = +local_domains
8576 .endd
8577 on several of your routers
8578 or in several ACL statements,
8579 the actual test is done only for the first one. However, the caching works only
8580 if there are no expansions within the list itself or any sublists that it
8581 references. In other words, caching happens only for lists that are known to be
8582 the same each time they are referenced.
8583
8584 By default, there may be up to 16 named lists of each type. This limit can be
8585 extended by changing a compile-time variable. The use of domain and host lists
8586 is recommended for concepts such as local domains, relay domains, and relay
8587 hosts. The default configuration is set up like this.
8588
8589
8590
8591 .section "Named lists compared with macros" "SECID78"
8592 .cindex "list" "named compared with macro"
8593 .cindex "macro" "compared with named list"
8594 At first sight, named lists might seem to be no different from macros in the
8595 configuration file. However, macros are just textual substitutions. If you
8596 write
8597 .code
8598 ALIST = host1 : host2
8599 auth_advertise_hosts = !ALIST
8600 .endd
8601 it probably won't do what you want, because that is exactly the same as
8602 .code
8603 auth_advertise_hosts = !host1 : host2
8604 .endd
8605 Notice that the second host name is not negated. However, if you use a host
8606 list, and write
8607 .code
8608 hostlist alist = host1 : host2
8609 auth_advertise_hosts = ! +alist
8610 .endd
8611 the negation applies to the whole list, and so that is equivalent to
8612 .code
8613 auth_advertise_hosts = !host1 : !host2
8614 .endd
8615
8616
8617 .section "Named list caching" "SECID79"
8618 .cindex "list" "caching of named"
8619 .cindex "caching" "named lists"
8620 While processing a message, Exim caches the result of checking a named list if
8621 it is sure that the list is the same each time. In practice, this means that
8622 the cache operates only if the list contains no $ characters, which guarantees
8623 that it will not change when it is expanded. Sometimes, however, you may have
8624 an expanded list that you know will be the same each time within a given
8625 message. For example:
8626 .code
8627 domainlist special_domains = \
8628            ${lookup{$sender_host_address}cdb{/some/file}}
8629 .endd
8630 This provides a list of domains that depends only on the sending host's IP
8631 address. If this domain list is referenced a number of times (for example,
8632 in several ACL lines, or in several routers) the result of the check is not
8633 cached by default, because Exim does not know that it is going to be the
8634 same list each time.
8635
8636 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8637 cache the result anyway. For example:
8638 .code
8639 domainlist_cache special_domains = ${lookup{...
8640 .endd
8641 If you do this, you should be absolutely sure that caching is going to do
8642 the right thing in all cases. When in doubt, leave it out.
8643
8644
8645
8646 .section "Domain lists" "SECTdomainlist"
8647 .cindex "domain list" "patterns for"
8648 .cindex "list" "domain list"
8649 Domain lists contain patterns that are to be matched against a mail domain.
8650 The following types of item may appear in domain lists:
8651
8652 .ilist
8653 .cindex "primary host name"
8654 .cindex "host name" "matched in domain list"
8655 .oindex "&%primary_hostname%&"
8656 .cindex "domain list" "matching primary host name"
8657 .cindex "@ in a domain list"
8658 If a pattern consists of a single @ character, it matches the local host name,
8659 as set by the &%primary_hostname%& option (or defaulted). This makes it
8660 possible to use the same configuration file on several different hosts that
8661 differ only in their names.
8662
8663 The value for a match will be the primary host name.
8664
8665
8666 .next
8667 .cindex "@[] in a domain list"
8668 .cindex "domain list" "matching local IP interfaces"
8669 .cindex "domain literal"
8670 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8671 in square brackets (as in an email address that contains a domain literal), but
8672 only if that IP address is recognized as local for email routing purposes. The
8673 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8674 control which of a host's several IP addresses are treated as local.
8675 In today's Internet, the use of domain literals is controversial;
8676 see the &%allow_domain_literals%& main option.
8677
8678 The value for a match will be the string &`@[]`&.
8679
8680
8681 .next
8682 .cindex "@mx_any"
8683 .cindex "@mx_primary"
8684 .cindex "@mx_secondary"
8685 .cindex "domain list" "matching MX pointers to local host"
8686 If a pattern consists of the string &`@mx_any`& it matches any domain that
8687 has an MX record pointing to the local host or to any host that is listed in
8688 .oindex "&%hosts_treat_as_local%&"
8689 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8690 are similar, except that the first matches only when a primary MX target is the
8691 local host, and the second only when no primary MX target is the local host,
8692 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8693 preference value &-- there may of course be more than one of them.
8694
8695 The MX lookup that takes place when matching a pattern of this type is
8696 performed with the resolver options for widening names turned off. Thus, for
8697 example, a single-component domain will &'not'& be expanded by adding the
8698 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8699 options of the &(dnslookup)& router for a discussion of domain widening.
8700
8701 Sometimes you may want to ignore certain IP addresses when using one of these
8702 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8703 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8704 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8705 on a router). For example:
8706 .code
8707 domains = @mx_any/ignore=127.0.0.1
8708 .endd
8709 This example matches any domain that has an MX record pointing to one of
8710 the local host's IP addresses other than 127.0.0.1.
8711
8712 The list of IP addresses is in fact processed by the same code that processes
8713 host lists, so it may contain CIDR-coded network specifications and it may also
8714 contain negative items.
8715
8716 Because the list of IP addresses is a sublist within a domain list, you have to
8717 be careful about delimiters if there is more than one address. Like any other
8718 list, the default delimiter can be changed. Thus, you might have:
8719 .code
8720 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8721           an.other.domain : ...
8722 .endd
8723 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8724 involved, it is easiest to change the delimiter for the main list as well:
8725 .code
8726 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8727           an.other.domain ? ...
8728 .endd
8729 The value for a match will be the list element string (starting &`@mx_`&).
8730
8731
8732 .next
8733 .cindex "asterisk" "in domain list"
8734 .cindex "domain list" "asterisk in"
8735 .cindex "domain list" "matching &""ends with""&"
8736 If a pattern starts with an asterisk, the remaining characters of the pattern
8737 are compared with the terminating characters of the domain. The use of &"*"& in
8738 domain lists differs from its use in partial matching lookups. In a domain
8739 list, the character following the asterisk need not be a dot, whereas partial
8740 matching works only in terms of dot-separated components. For example, a domain
8741 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8742 &'cipher.key.ex'&.
8743
8744 The value for a match will be the list element string (starting with the asterisk).
8745 Additionally, &$0$& will be set to the matched string
8746 and &$1$& to the variable portion which the asterisk matched.
8747
8748 .next
8749 .cindex "regular expressions" "in domain list"
8750 .cindex "domain list" "matching regular expression"
8751 If a pattern starts with a circumflex character, it is treated as a regular
8752 expression, and matched against the domain using a regular expression matching
8753 function. The circumflex is treated as part of the regular expression.
8754 Email domains are case-independent, so this regular expression match is by
8755 default case-independent, but you can make it case-dependent by starting it
8756 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8757 are given in chapter &<<CHAPregexp>>&.
8758
8759 &*Warning*&: Because domain lists are expanded before being processed, you
8760 must escape any backslash and dollar characters in the regular expression, or
8761 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8762 it is not to be expanded (unless you really do want to build a regular
8763 expression by expansion, of course).
8764
8765 The value for a match will be the list element string (starting with the circumflex).
8766 Additionally, &$0$& will be set to the string matching the regular expression,
8767 and &$1$& (onwards) to any submatches identified by parentheses.
8768
8769
8770
8771 .next
8772 .cindex "lookup" "in domain list"
8773 .cindex "domain list" "matching by lookup"
8774 If a pattern starts with the name of a single-key lookup type followed by a
8775 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8776 must be a filename in a suitable format for the lookup type. For example, for
8777 &"cdb;"& it must be an absolute path:
8778 .code
8779 domains = cdb;/etc/mail/local_domains.cdb
8780 .endd
8781 The appropriate type of lookup is done on the file using the domain name as the
8782 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8783 only in whether or not the key is present in the file. However, when a lookup
8784 is used for the &%domains%& option on a router
8785 or a &%domains%& condition in an ACL statement, the value is preserved in the
8786 &$domain_data$& variable and can be referred to in other router options or
8787 other statements in the same ACL.
8788 .cindex "tainted data" "de-tainting"
8789 The value will be untainted.
8790
8791 .new
8792 &*Note*&: If the data result of the lookup (as opposed to the key)
8793 is empty, then this empty value is stored in &$domain_data$&.
8794 The option to return the key for the lookup, as the value,
8795 may be what is wanted.
8796 .wen
8797
8798
8799 .next
8800 Any of the single-key lookup type names may be preceded by
8801 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8802 .code
8803 domains = partial-dbm;/partial/domains
8804 .endd
8805 This causes partial matching logic to be invoked; a description of how this
8806 works is given in section &<<SECTpartiallookup>>&.
8807
8808 .next
8809 .cindex "asterisk" "in lookup type"
8810 Any of the single-key lookup types may be followed by an asterisk. This causes
8811 a default lookup for a key consisting of a single asterisk to be done if the
8812 original lookup fails. This is not a useful feature when using a domain list to
8813 select particular domains (because any domain would match), but it might have
8814 value if the result of the lookup is being used via the &$domain_data$&
8815 expansion variable.
8816
8817 .next
8818 If the pattern starts with the name of a query-style lookup type followed by a
8819 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8820 pattern must be an appropriate query for the lookup type, as described in
8821 chapter &<<CHAPfdlookup>>&. For example:
8822 .code
8823 hold_domains = mysql;select domain from holdlist \
8824   where domain = '${quote_mysql:$domain}';
8825 .endd
8826 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8827 example, it doesn't matter what field you select). Exim is interested only in
8828 whether or not the query succeeds. However, when a lookup is used for the
8829 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8830 variable and can be referred to in other options.
8831 .cindex "tainted data" "de-tainting"
8832 The value will be untainted.
8833
8834 .next
8835 If the pattern starts with the name of a lookup type
8836 of either kind (single-key or query-style) it may be
8837 followed by a comma and options,
8838 The options are lookup-type specific and consist of a comma-separated list.
8839 Each item starts with a tag and and equals "=".
8840
8841 .next
8842 .cindex "domain list" "matching literal domain name"
8843 If none of the above cases apply, a caseless textual comparison is made
8844 between the pattern and the domain.
8845
8846 The value for a match will be the list element string.
8847 .cindex "tainted data" "de-tainting"
8848 Note that this is commonly untainted
8849 (depending on the way the list was created).
8850 Specifically, explicit text in the configuration file in not tainted.
8851 This is a useful way of obtaining an untainted equivalent to
8852 the domain, for later operations.
8853
8854 However if the list (including one-element lists)
8855 is created by expanding a variable containing tainted data,
8856 it is tainted and so will the match value be.
8857 .endlist
8858
8859
8860 Here is an example that uses several different kinds of pattern:
8861 .code
8862 domainlist funny_domains = \
8863   @ : \
8864   lib.unseen.edu : \
8865   *.foundation.fict.example : \
8866   \N^[1-2]\d{3}\.fict\.example$\N : \
8867   partial-dbm;/opt/data/penguin/book : \
8868   nis;domains.byname : \
8869   nisplus;[name=$domain,status=local],domains.org_dir
8870 .endd
8871 There are obvious processing trade-offs among the various matching modes. Using
8872 an asterisk is faster than a regular expression, and listing a few names
8873 explicitly probably is too. The use of a file or database lookup is expensive,
8874 but may be the only option if hundreds of names are required. Because the
8875 patterns are tested in order, it makes sense to put the most commonly matched
8876 patterns earlier.
8877
8878
8879
8880 .section "Host lists" "SECThostlist"
8881 .cindex "host list" "patterns in"
8882 .cindex "list" "host list"
8883 Host lists are used to control what remote hosts are allowed to do. For
8884 example, some hosts may be allowed to use the local host as a relay, and some
8885 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8886 two different ways, by name or by IP address. In a host list, some types of
8887 pattern are matched to a host name, and some are matched to an IP address.
8888 You need to be particularly careful with this when single-key lookups are
8889 involved, to ensure that the right value is being used as the key.
8890
8891
8892 .section "Special host list patterns" "SECID80"
8893 .cindex "empty item in hosts list"
8894 .cindex "host list" "empty string in"
8895 If a host list item is the empty string, it matches only when no remote host is
8896 involved. This is the case when a message is being received from a local
8897 process using SMTP on the standard input, that is, when a TCP/IP connection is
8898 not used.
8899
8900 .cindex "asterisk" "in host list"
8901 The special pattern &"*"& in a host list matches any host or no host. Neither
8902 the IP address nor the name is actually inspected.
8903
8904
8905
8906 .section "Host list patterns that match by IP address" "SECThoslispatip"
8907 .cindex "host list" "matching IP addresses"
8908 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8909 the incoming address actually appears in the IPv6 host as
8910 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8911 list, it is converted into a traditional IPv4 address first. (Not all operating
8912 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8913 concerns.)
8914
8915 The following types of pattern in a host list check the remote host by
8916 inspecting its IP address:
8917
8918 .ilist
8919 If the pattern is a plain domain name (not a regular expression, not starting
8920 with *, not a lookup of any kind), Exim calls the operating system function
8921 to find the associated IP address(es). Exim uses the newer
8922 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8923 This typically causes a forward DNS lookup of the name. The result is compared
8924 with the IP address of the subject host.
8925
8926 If there is a temporary problem (such as a DNS timeout) with the host name
8927 lookup, a temporary error occurs. For example, if the list is being used in an
8928 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8929 temporary SMTP error code. If no IP address can be found for the host name,
8930 what happens is described in section &<<SECTbehipnot>>& below.
8931
8932 .next
8933 .cindex "@ in a host list"
8934 If the pattern is &"@"&, the primary host name is substituted and used as a
8935 domain name, as just described.
8936
8937 .next
8938 If the pattern is an IP address, it is matched against the IP address of the
8939 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8940 IPv6 addresses can be given in colon-separated format, but the colons have to
8941 be doubled so as not to be taken as item separators when the default list
8942 separator is used. IPv6 addresses are recognized even when Exim is compiled
8943 without IPv6 support. This means that if they appear in a host list on an
8944 IPv4-only host, Exim will not treat them as host names. They are just addresses
8945 that can never match a client host.
8946
8947 .next
8948 .cindex "@[] in a host list"
8949 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8950 the local host. For example, if the local host is an IPv4 host with one
8951 interface address 10.45.23.56, these two ACL statements have the same effect:
8952 .code
8953 accept hosts = 127.0.0.1 : 10.45.23.56
8954 accept hosts = @[]
8955 .endd
8956 .next
8957 .cindex "CIDR notation"
8958 If the pattern is an IP address followed by a slash and a mask length (for
8959 example 10.11.42.0/24), it is matched against the IP address of the subject
8960 host under the given mask. This allows, an entire network of hosts to be
8961 included (or excluded) by a single item. The mask uses CIDR notation; it
8962 specifies the number of address bits that must match, starting from the most
8963 significant end of the address.
8964
8965 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8966 of a range of addresses. It is the number of bits in the network portion of the
8967 address. The above example specifies a 24-bit netmask, so it matches all 256
8968 addresses in the 10.11.42.0 network. An item such as
8969 .code
8970 192.168.23.236/31
8971 .endd
8972 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8973 32 for an IPv4 address is the same as no mask at all; just a single address
8974 matches.
8975
8976 Here is another example which shows an IPv4 and an IPv6 network:
8977 .code
8978 recipient_unqualified_hosts = 192.168.0.0/16: \
8979                               3ffe::ffff::836f::::/48
8980 .endd
8981 The doubling of list separator characters applies only when these items
8982 appear inline in a host list. It is not required when indirecting via a file.
8983 For example:
8984 .code
8985 recipient_unqualified_hosts = /opt/exim/unqualnets
8986 .endd
8987 could make use of a file containing
8988 .code
8989 172.16.0.0/12
8990 3ffe:ffff:836f::/48
8991 .endd
8992 to have exactly the same effect as the previous example. When listing IPv6
8993 addresses inline, it is usually more convenient to use the facility for
8994 changing separator characters. This list contains the same two networks:
8995 .code
8996 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8997                                  3ffe:ffff:836f::/48
8998 .endd
8999 The separator is changed to semicolon by the leading &"<;"& at the start of the
9000 list.
9001 .endlist
9002
9003
9004
9005 .section "Host list patterns for single-key lookups by host address" &&&
9006          "SECThoslispatsikey"
9007 .cindex "host list" "lookup of IP address"
9008 When a host is to be identified by a single-key lookup of its complete IP
9009 address, the pattern takes this form:
9010 .display
9011 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9012 .endd
9013 For example:
9014 .code
9015 hosts_lookup = net-cdb;/hosts-by-ip.db
9016 .endd
9017 The text form of the IP address of the subject host is used as the lookup key.
9018 IPv6 addresses are converted to an unabbreviated form, using lower case
9019 letters, with dots as separators because colon is the key terminator in
9020 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
9021 quoting the keys, but this is a facility that was added later.] The data
9022 returned by the lookup is not used.
9023
9024 .cindex "IP address" "masking"
9025 .cindex "host list" "masked IP address"
9026 Single-key lookups can also be performed using masked IP addresses, using
9027 patterns of this form:
9028 .display
9029 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
9030 .endd
9031 For example:
9032 .code
9033 net24-dbm;/networks.db
9034 .endd
9035 The IP address of the subject host is masked using <&'number'&> as the mask
9036 length. A textual string is constructed from the masked value, followed by the
9037 mask, and this is used as the lookup key. For example, if the host's IP address
9038 is 192.168.34.6, the key that is looked up for the above example is
9039 &"192.168.34.0/24"&.
9040
9041 When an IPv6 address is converted to a string, dots are normally used instead
9042 of colons, so that keys in &(lsearch)& files need not contain colons (which
9043 terminate &(lsearch)& keys). This was implemented some time before the ability
9044 to quote keys was made available in &(lsearch)& files. However, the more
9045 recently implemented &(iplsearch)& files do require colons in IPv6 keys
9046 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
9047 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
9048 converted using colons and not dots.
9049 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
9050 addresses are always used.
9051 The latter are converted to IPv4 addresses, in dotted-quad form.
9052
9053 Ideally, it would be nice to tidy up this anomalous situation by changing to
9054 colons in all cases, given that quoting is now available for &(lsearch)&.
9055 However, this would be an incompatible change that might break some existing
9056 configurations.
9057
9058 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
9059 IPv6 address) is not the same as specifying just &%net-%& without a number. In
9060 the former case the key strings include the mask value, whereas in the latter
9061 case the IP address is used on its own.
9062
9063
9064
9065 .section "Host list patterns that match by host name" "SECThoslispatnam"
9066 .cindex "host" "lookup failures"
9067 .cindex "unknown host name"
9068 .cindex "host list" "matching host name"
9069 There are several types of pattern that require Exim to know the name of the
9070 remote host. These are either wildcard patterns or lookups by name. (If a
9071 complete hostname is given without any wildcarding, it is used to find an IP
9072 address to match against, as described in section &<<SECThoslispatip>>&
9073 above.)
9074
9075 If the remote host name is not already known when Exim encounters one of these
9076 patterns, it has to be found from the IP address.
9077 Although many sites on the Internet are conscientious about maintaining reverse
9078 DNS data for their hosts, there are also many that do not do this.
9079 Consequently, a name cannot always be found, and this may lead to unwanted
9080 effects. Take care when configuring host lists with wildcarded name patterns.
9081 Consider what will happen if a name cannot be found.
9082
9083 Because of the problems of determining host names from IP addresses, matching
9084 against host names is not as common as matching against IP addresses.
9085
9086 By default, in order to find a host name, Exim first does a reverse DNS lookup;
9087 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
9088 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
9089 are done can be changed by setting the &%host_lookup_order%& option. For
9090 security, once Exim has found one or more names, it looks up the IP addresses
9091 for these names and compares them with the IP address that it started with.
9092 Only those names whose IP addresses match are accepted. Any other names are
9093 discarded. If no names are left, Exim behaves as if the host name cannot be
9094 found. In the most common case there is only one name and one IP address.
9095
9096 There are some options that control what happens if a host name cannot be
9097 found. These are described in section &<<SECTbehipnot>>& below.
9098
9099 .cindex "host" "alias for"
9100 .cindex "alias for host"
9101 As a result of aliasing, hosts may have more than one name. When processing any
9102 of the following types of pattern, all the host's names are checked:
9103
9104 .ilist
9105 .cindex "asterisk" "in host list"
9106 If a pattern starts with &"*"& the remainder of the item must match the end of
9107 the host name. For example, &`*.b.c`& matches all hosts whose names end in
9108 &'.b.c'&. This special simple form is provided because this is a very common
9109 requirement. Other kinds of wildcarding require the use of a regular
9110 expression.
9111 .next
9112 .cindex "regular expressions" "in host list"
9113 .cindex "host list" "regular expression in"
9114 If the item starts with &"^"& it is taken to be a regular expression which is
9115 matched against the host name. Host names are case-independent, so this regular
9116 expression match is by default case-independent, but you can make it
9117 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9118 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9119 example,
9120 .code
9121 ^(a|b)\.c\.d$
9122 .endd
9123 is a regular expression that matches either of the two hosts &'a.c.d'& or
9124 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9125 that backslash and dollar characters are not misinterpreted as part of the
9126 string expansion. The simplest way to do this is to use &`\N`& to mark that
9127 part of the string as non-expandable. For example:
9128 .code
9129 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9130 .endd
9131 &*Warning*&: If you want to match a complete host name, you must include the
9132 &`$`& terminating metacharacter in the regular expression, as in the above
9133 example. Without it, a match at the start of the host name is all that is
9134 required.
9135 .endlist
9136
9137
9138
9139
9140 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9141 .cindex "host" "lookup failures, permanent"
9142 While processing a host list, Exim may need to look up an IP address from a
9143 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9144 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9145 behaviour when it fails to find the information it is seeking is the same.
9146
9147 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9148 apply to temporary DNS errors, whose handling is described in the next section.
9149
9150 .cindex "&`+include_unknown`&"
9151 .cindex "&`+ignore_unknown`&"
9152 Exim parses a host list from left to right. If it encounters a permanent
9153 lookup failure in any item in the host list before it has found a match,
9154 Exim treats it as a failure and the default behavior is as if the host
9155 does not match the list. This may not always be what you want to happen.
9156 To change Exim's behaviour, the special items &`+include_unknown`& or
9157 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9158 not recognized in an indirected file).
9159
9160 .ilist
9161 If any item that follows &`+include_unknown`& requires information that
9162 cannot found, Exim behaves as if the host does match the list. For example,
9163 .code
9164 host_reject_connection = +include_unknown:*.enemy.ex
9165 .endd
9166 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9167 any hosts whose name it cannot find.
9168
9169 .next
9170 If any item that follows &`+ignore_unknown`& requires information that cannot
9171 be found, Exim ignores that item and proceeds to the rest of the list. For
9172 example:
9173 .code
9174 accept hosts = +ignore_unknown : friend.example : \
9175                192.168.4.5
9176 .endd
9177 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9178 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9179 name can be found for 192.168.4.5, it is rejected.
9180 .endlist
9181
9182 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9183 list. The effect of each one lasts until the next, or until the end of the
9184 list.
9185
9186 .section "Mixing wildcarded host names and addresses in host lists" &&&
9187          "SECTmixwilhos"
9188 .cindex "host list" "mixing names and addresses in"
9189
9190 This section explains the host/ip processing logic with the same concepts
9191 as the previous section, but specifically addresses what happens when a
9192 wildcarded hostname is one of the items in the hostlist.
9193
9194 .ilist
9195 If you have name lookups or wildcarded host names and
9196 IP addresses in the same host list, you should normally put the IP
9197 addresses first. For example, in an ACL you could have:
9198 .code
9199 accept hosts = 10.9.8.7 : *.friend.example
9200 .endd
9201 The reason you normally would order it this way lies in the
9202 left-to-right way that Exim processes lists.  It can test IP addresses
9203 without doing any DNS lookups, but when it reaches an item that requires
9204 a host name, it fails if it cannot find a host name to compare with the
9205 pattern. If the above list is given in the opposite order, the
9206 &%accept%& statement fails for a host whose name cannot be found, even
9207 if its IP address is 10.9.8.7.
9208
9209 .next
9210 If you really do want to do the name check first, and still recognize the IP
9211 address, you can rewrite the ACL like this:
9212 .code
9213 accept hosts = *.friend.example
9214 accept hosts = 10.9.8.7
9215 .endd
9216 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9217 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9218 &`+ignore_unknown`&, which was discussed in depth in the first example in
9219 this section.
9220 .endlist
9221
9222
9223 .section "Temporary DNS errors when looking up host information" &&&
9224          "SECTtemdnserr"
9225 .cindex "host" "lookup failures, temporary"
9226 .cindex "&`+include_defer`&"
9227 .cindex "&`+ignore_defer`&"
9228 A temporary DNS lookup failure normally causes a defer action (except when
9229 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9230 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9231 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9232 section. These options should be used with care, probably only in non-critical
9233 host lists such as whitelists.
9234
9235
9236
9237 .section "Host list patterns for single-key lookups by host name" &&&
9238          "SECThoslispatnamsk"
9239 .cindex "unknown host name"
9240 .cindex "host list" "matching host name"
9241 If a pattern is of the form
9242 .display
9243 <&'single-key-search-type'&>;<&'search-data'&>
9244 .endd
9245 for example
9246 .code
9247 dbm;/host/accept/list
9248 .endd
9249 a single-key lookup is performed, using the host name as its key. If the
9250 lookup succeeds, the host matches the item. The actual data that is looked up
9251 is not used.
9252
9253 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9254 keys in the file, not IP addresses. If you want to do lookups based on IP
9255 addresses, you must precede the search type with &"net-"& (see section
9256 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9257 two items in the same list, one doing an address lookup and one doing a name
9258 lookup, both using the same file.
9259
9260
9261
9262 .section "Host list patterns for query-style lookups" "SECID81"
9263 If a pattern is of the form
9264 .display
9265 <&'query-style-search-type'&>;<&'query'&>
9266 .endd
9267 the query is obeyed, and if it succeeds, the host matches the item. The actual
9268 data that is looked up is not used. The variables &$sender_host_address$& and
9269 &$sender_host_name$& can be used in the query. For example:
9270 .code
9271 hosts_lookup = pgsql;\
9272   select ip from hostlist where ip='$sender_host_address'
9273 .endd
9274 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9275 can use the &%sg%& expansion item to change this if you need to. If you want to
9276 use masked IP addresses in database queries, you can use the &%mask%& expansion
9277 operator.
9278
9279 If the query contains a reference to &$sender_host_name$&, Exim automatically
9280 looks up the host name if it has not already done so. (See section
9281 &<<SECThoslispatnam>>& for comments on finding host names.)
9282
9283 Historical note: prior to release 4.30, Exim would always attempt to find a
9284 host name before running the query, unless the search type was preceded by
9285 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9286 still recognized for query-style lookups, but its presence or absence has no
9287 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9288 See section &<<SECThoslispatsikey>>&.)
9289
9290
9291
9292
9293
9294 .section "Address lists" "SECTaddresslist"
9295 .cindex "list" "address list"
9296 .cindex "address list" "empty item"
9297 .cindex "address list" "patterns"
9298 Address lists contain patterns that are matched against mail addresses. There
9299 is one special case to be considered: the sender address of a bounce message is
9300 always empty. You can test for this by providing an empty item in an address
9301 list. For example, you can set up a router to process bounce messages by
9302 using this option setting:
9303 .code
9304 senders = :
9305 .endd
9306 The presence of the colon creates an empty item. If you do not provide any
9307 data, the list is empty and matches nothing. The empty sender can also be
9308 detected by a regular expression that matches an empty string,
9309 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9310
9311 Non-empty items in an address list can be straightforward email addresses. For
9312 example:
9313 .code
9314 senders = jbc@askone.example : hs@anacreon.example
9315 .endd
9316 A certain amount of wildcarding is permitted. If a pattern contains an @
9317 character, but is not a regular expression and does not begin with a
9318 semicolon-terminated lookup type (described below), the local part of the
9319 subject address is compared with the local part of the pattern, which may start
9320 with an asterisk. If the local parts match, the domain is checked in exactly
9321 the same way as for a pattern in a domain list. For example, the domain can be
9322 wildcarded, refer to a named list, or be a lookup:
9323 .code
9324 deny senders = *@*.spamming.site:\
9325                *@+hostile_domains:\
9326                bozo@partial-lsearch;/list/of/dodgy/sites:\
9327                *@dbm;/bad/domains.db
9328 .endd
9329 .cindex "local part" "starting with !"
9330 .cindex "address list" "local part starting with !"
9331 If a local part that begins with an exclamation mark is required, it has to be
9332 specified using a regular expression, because otherwise the exclamation mark is
9333 treated as a sign of negation, as is standard in lists.
9334
9335 If a non-empty pattern that is not a regular expression or a lookup does not
9336 contain an @ character, it is matched against the domain part of the subject
9337 address. The only two formats that are recognized this way are a literal
9338 domain, or a domain pattern that starts with *. In both these cases, the effect
9339 is the same as if &`*@`& preceded the pattern. For example:
9340 .code
9341 deny senders = enemy.domain : *.enemy.domain
9342 .endd
9343
9344 The following kinds of more complicated address list pattern can match any
9345 address, including the empty address that is characteristic of bounce message
9346 senders:
9347
9348 .ilist
9349 .cindex "regular expressions" "in address list"
9350 .cindex "address list" "regular expression in"
9351 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9352 done against the complete address, with the pattern as the regular expression.
9353 You must take care that backslash and dollar characters are not misinterpreted
9354 as part of the string expansion. The simplest way to do this is to use &`\N`&
9355 to mark that part of the string as non-expandable. For example:
9356 .code
9357 deny senders = \N^.*this.*@example\.com$\N : \
9358                \N^\d{8}.+@spamhaus.example$\N : ...
9359 .endd
9360 The &`\N`& sequences are removed by the expansion, so these items do indeed
9361 start with &"^"& by the time they are being interpreted as address patterns.
9362
9363 .next
9364 .cindex "address list" "lookup for complete address"
9365 Complete addresses can be looked up by using a pattern that starts with a
9366 lookup type terminated by a semicolon, followed by the data for the lookup. For
9367 example:
9368 .code
9369 deny senders = cdb;/etc/blocked.senders : \
9370   mysql;select address from blocked where \
9371   address='${quote_mysql:$sender_address}'
9372 .endd
9373 Both query-style and single-key lookup types can be used. For a single-key
9374 lookup type, Exim uses the complete address as the key. However, empty keys are
9375 not supported for single-key lookups, so a match against the empty address
9376 always fails. This restriction does not apply to query-style lookups.
9377
9378 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9379 cannot be used, and is ignored if specified, with an entry being written to the
9380 panic log.
9381 .cindex "*@ with single-key lookup"
9382 However, you can configure lookup defaults, as described in section
9383 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9384 default. For example, with this lookup:
9385 .code
9386 accept senders = lsearch*@;/some/file
9387 .endd
9388 the file could contains lines like this:
9389 .code
9390 user1@domain1.example
9391 *@domain2.example
9392 .endd
9393 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9394 that are tried is:
9395 .code
9396 nimrod@jaeger.example
9397 *@jaeger.example
9398 *
9399 .endd
9400 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9401 would mean that every address matches, thus rendering the test useless.
9402
9403 &*Warning 2*&: Do not confuse these two kinds of item:
9404 .code
9405 deny recipients = dbm*@;/some/file
9406 deny recipients = *@dbm;/some/file
9407 .endd
9408 The first does a whole address lookup, with defaulting, as just described,
9409 because it starts with a lookup type. The second matches the local part and
9410 domain independently, as described in a bullet point below.
9411 .endlist
9412
9413
9414 The following kinds of address list pattern can match only non-empty addresses.
9415 If the subject address is empty, a match against any of these pattern types
9416 always fails.
9417
9418
9419 .ilist
9420 .cindex "@@ with single-key lookup"
9421 .cindex "address list" "@@ lookup type"
9422 .cindex "address list" "split local part and domain"
9423 If a pattern starts with &"@@"& followed by a single-key lookup item
9424 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9425 split into a local part and a domain. The domain is looked up in the file. If
9426 it is not found, there is no match. If it is found, the data that is looked up
9427 from the file is treated as a colon-separated list of local part patterns, each
9428 of which is matched against the subject local part in turn.
9429
9430 .cindex "asterisk" "in address list"
9431 The lookup may be a partial one, and/or one involving a search for a default
9432 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9433 patterns that are looked up can be regular expressions or begin with &"*"&, or
9434 even be further lookups. They may also be independently negated. For example,
9435 with
9436 .code
9437 deny senders = @@dbm;/etc/reject-by-domain
9438 .endd
9439 the data from which the DBM file is built could contain lines like
9440 .code
9441 baddomain.com:  !postmaster : *
9442 .endd
9443 to reject all senders except &%postmaster%& from that domain.
9444
9445 .cindex "local part" "starting with !"
9446 If a local part that actually begins with an exclamation mark is required, it
9447 has to be specified using a regular expression. In &(lsearch)& files, an entry
9448 may be split over several lines by indenting the second and subsequent lines,
9449 but the separating colon must still be included at line breaks. White space
9450 surrounding the colons is ignored. For example:
9451 .code
9452 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9453   spammer3 : spammer4
9454 .endd
9455 As in all colon-separated lists in Exim, a colon can be included in an item by
9456 doubling.
9457
9458 If the last item in the list starts with a right angle-bracket, the remainder
9459 of the item is taken as a new key to look up in order to obtain a continuation
9460 list of local parts. The new key can be any sequence of characters. Thus one
9461 might have entries like
9462 .code
9463 aol.com: spammer1 : spammer 2 : >*
9464 xyz.com: spammer3 : >*
9465 *:       ^\d{8}$
9466 .endd
9467 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9468 local parts for all domains, in addition to the specific local parts listed for
9469 each domain. Of course, using this feature costs another lookup each time a
9470 chain is followed, but the effort needed to maintain the data is reduced.
9471
9472 .cindex "loop" "in lookups"
9473 It is possible to construct loops using this facility, and in order to catch
9474 them, the chains may be no more than fifty items long.
9475
9476 .next
9477 The @@<&'lookup'&> style of item can also be used with a query-style
9478 lookup, but in this case, the chaining facility is not available. The lookup
9479 can only return a single list of local parts.
9480 .endlist
9481
9482 &*Warning*&: There is an important difference between the address list items
9483 in these two examples:
9484 .code
9485 senders = +my_list
9486 senders = *@+my_list
9487 .endd
9488 In the first one, &`my_list`& is a named address list, whereas in the second
9489 example it is a named domain list.
9490
9491
9492
9493
9494 .section "Case of letters in address lists" "SECTcasletadd"
9495 .cindex "case of local parts"
9496 .cindex "address list" "case forcing"
9497 .cindex "case forcing in address lists"
9498 Domains in email addresses are always handled caselessly, but for local parts
9499 case may be significant on some systems (see &%caseful_local_part%& for how
9500 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9501 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9502 blocking lists should be done in a case-independent manner. Since most address
9503 lists in Exim are used for this kind of control, Exim attempts to do this by
9504 default.
9505
9506 The domain portion of an address is always lowercased before matching it to an
9507 address list. The local part is lowercased by default, and any string
9508 comparisons that take place are done caselessly. This means that the data in
9509 the address list itself, in files included as plain filenames, and in any file
9510 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9511 keys in files that are looked up by a search type other than &(lsearch)& (which
9512 works caselessly) must be in lower case, because these lookups are not
9513 case-independent.
9514
9515 .cindex "&`+caseful`&"
9516 To allow for the possibility of caseful address list matching, if an item in
9517 an address list is the string &"+caseful"&, the original case of the local
9518 part is restored for any comparisons that follow, and string comparisons are no
9519 longer case-independent. This does not affect the domain, which remains in
9520 lower case. However, although independent matches on the domain alone are still
9521 performed caselessly, regular expressions that match against an entire address
9522 become case-sensitive after &"+caseful"& has been seen.
9523
9524
9525
9526 .section "Local part lists" "SECTlocparlis"
9527 .cindex "list" "local part list"
9528 .cindex "local part" "list"
9529 These behave in the same way as domain and host lists, with the following
9530 changes:
9531
9532 Case-sensitivity in local part lists is handled in the same way as for address
9533 lists, as just described. The &"+caseful"& item can be used if required. In a
9534 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9535 set false, the subject is lowercased and the matching is initially
9536 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9537 matching in the local part list, but not elsewhere in the router. If
9538 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9539 option is case-sensitive from the start.
9540
9541 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9542 comments are handled in the same way as address lists &-- they are recognized
9543 only if the # is preceded by white space or the start of the line.
9544 Otherwise, local part lists are matched in the same way as domain lists, except
9545 that the special items that refer to the local host (&`@`&, &`@[]`&,
9546 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9547 Refer to section &<<SECTdomainlist>>& for details of the other available item
9548 types.
9549 .ecindex IIDdohoadli
9550
9551
9552
9553
9554 . ////////////////////////////////////////////////////////////////////////////
9555 . ////////////////////////////////////////////////////////////////////////////
9556
9557 .chapter "String expansions" "CHAPexpand"
9558 .scindex IIDstrexp "expansion" "of strings"
9559 Many strings in Exim's runtime configuration are expanded before use. Some of
9560 them are expanded every time they are used; others are expanded only once.
9561
9562 When a string is being expanded it is copied verbatim from left to right except
9563 .cindex expansion "string concatenation"
9564 when a dollar or backslash character is encountered. A dollar specifies the
9565 start of a portion of the string that is interpreted and replaced as described
9566 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9567 escape character, as described in the following section.
9568
9569 Whether a string is expanded depends upon the context.  Usually this is solely
9570 dependent upon the option for which a value is sought; in this documentation,
9571 options for which string expansion is performed are marked with &dagger; after
9572 the data type.  ACL rules always expand strings.  A couple of expansion
9573 conditions do not expand some of the brace-delimited branches, for security
9574 reasons,
9575 .cindex "tainted data" expansion
9576 .cindex "tainted data" definition
9577 .cindex expansion "tainted data"
9578 and expansion of data deriving from the sender (&"tainted data"&)
9579 .new
9580 is not permitted (including acessing a file using a tainted name).
9581 .wen
9582
9583 .new
9584 Common ways of obtaining untainted equivalents of variables with
9585 tainted values
9586 .cindex "tainted data" "de-tainting"
9587 come down to using the tainted value as a lookup key in a trusted database.
9588 This database could be the filesystem structure,
9589 or the password file,
9590 or accessed via a DBMS.
9591 Specific methods are indexed under &"de-tainting"&.
9592 .wen
9593
9594
9595
9596 .section "Literal text in expanded strings" "SECTlittext"
9597 .cindex "expansion" "including literal text"
9598 An uninterpreted dollar can be included in an expanded string by putting a
9599 backslash in front of it. A backslash can be used to prevent any special
9600 character being treated specially in an expansion, including backslash itself.
9601 If the string appears in quotes in the configuration file, two backslashes are
9602 required because the quotes themselves cause interpretation of backslashes when
9603 the string is read in (see section &<<SECTstrings>>&).
9604
9605 .cindex "expansion" "non-expandable substrings"
9606 A portion of the string can specified as non-expandable by placing it between
9607 two occurrences of &`\N`&. This is particularly useful for protecting regular
9608 expressions, which often contain backslashes and dollar signs. For example:
9609 .code
9610 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9611 .endd
9612 On encountering the first &`\N`&, the expander copies subsequent characters
9613 without interpretation until it reaches the next &`\N`& or the end of the
9614 string.
9615
9616
9617
9618 .section "Character escape sequences in expanded strings" "SECID82"
9619 .cindex "expansion" "escape sequences"
9620 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9621 expanded string is recognized as an escape sequence for the character newline,
9622 carriage return, or tab, respectively. A backslash followed by up to three
9623 octal digits is recognized as an octal encoding for a single character, and a
9624 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9625 encoding.
9626
9627 These escape sequences are also recognized in quoted strings when they are read
9628 in. Their interpretation in expansions as well is useful for unquoted strings,
9629 and for other cases such as looked-up strings that are then expanded.
9630
9631
9632 .section "Testing string expansions" "SECID83"
9633 .cindex "expansion" "testing"
9634 .cindex "testing" "string expansion"
9635 .oindex "&%-be%&"
9636 Many expansions can be tested by calling Exim with the &%-be%& option. This
9637 takes the command arguments, or lines from the standard input if there are no
9638 arguments, runs them through the string expansion code, and writes the results
9639 to the standard output. Variables based on configuration values are set up, but
9640 since no message is being processed, variables such as &$local_part$& have no
9641 value. Nevertheless the &%-be%& option can be useful for checking out file and
9642 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9643 and &%nhash%&.
9644
9645 Exim gives up its root privilege when it is called with the &%-be%& option, and
9646 instead runs under the uid and gid it was called with, to prevent users from
9647 using &%-be%& for reading files to which they do not have access.
9648
9649 .oindex "&%-bem%&"
9650 If you want to test expansions that include variables whose values are taken
9651 from a message, there are two other options that can be used. The &%-bem%&
9652 option is like &%-be%& except that it is followed by a filename. The file is
9653 read as a message before doing the test expansions. For example:
9654 .code
9655 exim -bem /tmp/test.message '$h_subject:'
9656 .endd
9657 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9658 Exim message identifier. For example:
9659 .code
9660 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9661 .endd
9662 This loads the message from Exim's spool before doing the test expansions, and
9663 is therefore restricted to admin users.
9664
9665
9666 .section "Forced expansion failure" "SECTforexpfai"
9667 .cindex "expansion" "forced failure"
9668 A number of expansions that are described in the following section have
9669 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9670 (which are sometimes called &"curly brackets"&). Which of the two strings is
9671 used depends on some condition that is evaluated as part of the expansion. If,
9672 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9673 the entire string expansion fails in a way that can be detected by the code
9674 that requested the expansion. This is called &"forced expansion failure"&, and
9675 its consequences depend on the circumstances. In some cases it is no different
9676 from any other expansion failure, but in others a different action may be
9677 taken. Such variations are mentioned in the documentation of the option that is
9678 being expanded.
9679
9680
9681
9682
9683 .section "Expansion items" "SECTexpansionitems"
9684 The following items are recognized in expanded strings. White space may be used
9685 between sub-items that are keywords or substrings enclosed in braces inside an
9686 outer set of braces, to improve readability. &*Warning*&: Within braces,
9687 white space is significant.
9688
9689 .vlist
9690 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9691 .cindex "expansion" "variables"
9692 Substitute the contents of the named variable, for example:
9693 .code
9694 $local_part
9695 ${domain}
9696 .endd
9697 The second form can be used to separate the name from subsequent alphanumeric
9698 characters. This form (using braces) is available only for variables; it does
9699 &'not'& apply to message headers. The names of the variables are given in
9700 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9701 given, the expansion fails.
9702
9703 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9704 .cindex "expansion" "operators"
9705 The string is first itself expanded, and then the operation specified by
9706 <&'op'&> is applied to it. For example:
9707 .code
9708 ${lc:$local_part}
9709 .endd
9710 The string starts with the first character after the colon, which may be
9711 leading white space. A list of operators is given in section &<<SECTexpop>>&
9712 below. The operator notation is used for simple expansion items that have just
9713 one argument, because it reduces the number of braces and therefore makes the
9714 string easier to understand.
9715
9716 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9717 This item inserts &"basic"& header lines. It is described with the &%header%&
9718 expansion item below.
9719
9720
9721 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9722 .cindex "expansion" "calling an acl"
9723 .cindex "&%acl%&" "call from expansion"
9724 The name and zero to nine argument strings are first expanded separately.  The expanded
9725 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9726 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9727 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9728 and may use the variables; if another acl expansion is used the values
9729 are restored after it returns.  If the ACL sets
9730 a value using a "message =" modifier and returns accept or deny, the value becomes
9731 the result of the expansion.
9732 If no message is set and the ACL returns accept or deny
9733 the expansion result is an empty string.
9734 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9735
9736
9737 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9738 .cindex authentication "results header"
9739 .chindex Authentication-Results:
9740 .cindex authentication "expansion item"
9741 This item returns a string suitable for insertion as an
9742 &'Authentication-Results:'&
9743 header line.
9744 The given <&'authserv-id'&> is included in the result; typically this
9745 will be a domain name identifying the system performing the authentications.
9746 Methods that might be present in the result include:
9747 .code
9748 none
9749 iprev
9750 auth
9751 spf
9752 dkim
9753 .endd
9754
9755 Example use (as an ACL modifier):
9756 .code
9757       add_header = :at_start:${authresults {$primary_hostname}}
9758 .endd
9759 This is safe even if no authentication results are available.
9760
9761
9762 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9763        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9764 .cindex "expansion" "extracting certificate fields"
9765 .cindex "&%certextract%&" "certificate fields"
9766 .cindex "certificate" "extracting fields"
9767 The <&'certificate'&> must be a variable of type certificate.
9768 The field name is expanded and used to retrieve the relevant field from
9769 the certificate.  Supported fields are:
9770 .display
9771 &`version        `&
9772 &`serial_number  `&
9773 &`subject        `& RFC4514 DN
9774 &`issuer         `& RFC4514 DN
9775 &`notbefore      `& time
9776 &`notafter       `& time
9777 &`sig_algorithm  `&
9778 &`signature      `&
9779 &`subj_altname   `& tagged list
9780 &`ocsp_uri       `& list
9781 &`crl_uri        `& list
9782 .endd
9783 If the field is found,
9784 <&'string2'&> is expanded, and replaces the whole item;
9785 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9786 variable &$value$& contains the value that has been extracted. Afterwards, it
9787 is restored to any previous value it might have had.
9788
9789 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9790 key is not found. If {<&'string2'&>} is also omitted, the value that was
9791 extracted is used.
9792
9793 Some field names take optional modifiers, appended and separated by commas.
9794
9795 The field selectors marked as "RFC4514" above
9796 output a Distinguished Name string which is
9797 not quite
9798 parseable by Exim as a comma-separated tagged list
9799 (the exceptions being elements containing commas).
9800 RDN elements of a single type may be selected by
9801 a modifier of the type label; if so the expansion
9802 result is a list (newline-separated by default).
9803 The separator may be changed by another modifier of
9804 a right angle-bracket followed immediately by the new separator.
9805 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9806
9807 The field selectors marked as "time" above
9808 take an optional modifier of "int"
9809 for which the result is the number of seconds since epoch.
9810 Otherwise the result is a human-readable string
9811 in the timezone selected by the main "timezone" option.
9812
9813 The field selectors marked as "list" above return a list,
9814 newline-separated by default,
9815 (embedded separator characters in elements are doubled).
9816 The separator may be changed by a modifier of
9817 a right angle-bracket followed immediately by the new separator.
9818
9819 The field selectors marked as "tagged" above
9820 prefix each list element with a type string and an equals sign.
9821 Elements of only one type may be selected by a modifier
9822 which is one of "dns", "uri" or "mail";
9823 if so the element tags are omitted.
9824
9825 If not otherwise noted field values are presented in human-readable form.
9826
9827 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9828        {*&<&'arg'&>&*}...}*&"
9829 .cindex &%dlfunc%&
9830 This expansion dynamically loads and then calls a locally-written C function.
9831 This functionality is available only if Exim is compiled with
9832 .code
9833 EXPAND_DLFUNC=yes
9834 .endd
9835 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9836 object so that it doesn't reload the same object file in the same Exim process
9837 (but of course Exim does start new processes frequently).
9838
9839 There may be from zero to eight arguments to the function.
9840
9841 When compiling
9842 a local function that is to be called in this way,
9843 first &_DLFUNC_IMPL_& should be defined,
9844 and second &_local_scan.h_& should be included.
9845 The Exim variables and functions that are defined by that API
9846 are also available for dynamically loaded functions. The function itself
9847 must have the following type:
9848 .code
9849 int dlfunction(uschar **yield, int argc, uschar *argv[])
9850 .endd
9851 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9852 function should return one of the following values:
9853
9854 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9855 into the expanded string that is being built.
9856
9857 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9858 from &'yield'&, if it is set.
9859
9860 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9861 taken from &'yield'& if it is set.
9862
9863 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9864
9865 When compiling a function that is to be used in this way with gcc,
9866 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9867 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9868
9869
9870 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9871 .cindex "expansion" "extracting value from environment"
9872 .cindex "environment" "values from"
9873 The key is first expanded separately, and leading and trailing white space
9874 removed.
9875 This is then searched for as a name in the environment.
9876 If a variable is found then its value is placed in &$value$&
9877 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9878
9879 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9880 appear, for example:
9881 .code
9882 ${env{USER}{$value} fail }
9883 .endd
9884 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9885 {<&'string1'&>} must be present for &"fail"& to be recognized.
9886
9887 If {<&'string2'&>} is omitted an empty string is substituted on
9888 search failure.
9889 If {<&'string1'&>} is omitted the search result is substituted on
9890 search success.
9891
9892 The environment is adjusted by the &%keep_environment%& and
9893 &%add_environment%& main section options.
9894
9895
9896 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9897        {*&<&'string3'&>&*}}*&"
9898 .cindex "expansion" "extracting substrings by key"
9899 .cindex "&%extract%&" "substrings by key"
9900 The key and <&'string1'&> are first expanded separately. Leading and trailing
9901 white space is removed from the key (but not from any of the strings). The key
9902 must not be empty and must not consist entirely of digits.
9903 The expanded <&'string1'&> must be of the form:
9904 .display
9905 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9906 .endd
9907 .vindex "&$value$&"
9908 where the equals signs and spaces (but not both) are optional. If any of the
9909 values contain white space, they must be enclosed in double quotes, and any
9910 values that are enclosed in double quotes are subject to escape processing as
9911 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9912 for the value that corresponds to the key. The search is case-insensitive. If
9913 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9914 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9915 variable &$value$& contains the value that has been extracted. Afterwards, it
9916 is restored to any previous value it might have had.
9917
9918 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9919 key is not found. If {<&'string2'&>} is also omitted, the value that was
9920 extracted is used. Thus, for example, these two expansions are identical, and
9921 yield &"2001"&:
9922 .code
9923 ${extract{gid}{uid=1984 gid=2001}}
9924 ${extract{gid}{uid=1984 gid=2001}{$value}}
9925 .endd
9926 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9927 appear, for example:
9928 .code
9929 ${extract{Z}{A=... B=...}{$value} fail }
9930 .endd
9931 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9932 {<&'string2'&>} must be present for &"fail"& to be recognized.
9933
9934 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9935        {*&<&'string3'&>&*}}*&" &&&
9936        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9937        {*&<&'string3'&>&*}}*&"
9938 .cindex "expansion" "extracting from JSON object"
9939 .cindex JSON expansions
9940 The key and <&'string1'&> are first expanded separately. Leading and trailing
9941 white space is removed from the key (but not from any of the strings). The key
9942 must not be empty and must not consist entirely of digits.
9943 The expanded <&'string1'&> must be of the form:
9944 .display
9945 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9946 .endd
9947 .vindex "&$value$&"
9948 The braces, commas and colons, and the quoting of the member name are required;
9949 the spaces are optional.
9950 Matching of the key against the member names is done case-sensitively.
9951 For the &"json"& variant,
9952 if a returned value is a JSON string, it retains its leading and
9953 trailing quotes.
9954 For the &"jsons"& variant, which is intended for use with JSON strings, the
9955 leading and trailing quotes are removed from the returned value.
9956 . XXX should be a UTF-8 compare
9957
9958 The results of matching are handled as above.
9959
9960
9961 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9962         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9963 .cindex "expansion" "extracting substrings by number"
9964 .cindex "&%extract%&" "substrings by number"
9965 The <&'number'&> argument must consist entirely of decimal digits,
9966 apart from leading and trailing white space, which is ignored.
9967 This is what distinguishes this form of &%extract%& from the previous kind. It
9968 behaves in the same way, except that, instead of extracting a named field, it
9969 extracts from <&'string1'&> the field whose number is given as the first
9970 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9971 <&'string3'&> as before.
9972
9973 The fields in the string are separated by any one of the characters in the
9974 separator string. These may include space or tab characters.
9975 The first field is numbered one. If the number is negative, the fields are
9976 counted from the end of the string, with the rightmost one numbered -1. If the
9977 number given is zero, the entire string is returned. If the modulus of the
9978 number is greater than the number of fields in the string, the result is the
9979 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9980 provided. For example:
9981 .code
9982 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9983 .endd
9984 yields &"42"&, and
9985 .code
9986 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9987 .endd
9988 yields &"99"&. Two successive separators mean that the field between them is
9989 empty (for example, the fifth field above).
9990
9991
9992 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9993         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9994        "&*${extract jsons{*&<&'number'&>&*}}&&&
9995         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9996 .cindex "expansion" "extracting from JSON array"
9997 .cindex JSON expansions
9998 The <&'number'&> argument must consist entirely of decimal digits,
9999 apart from leading and trailing white space, which is ignored.
10000
10001 Field selection and result handling is as above;
10002 there is no choice of field separator.
10003 For the &"json"& variant,
10004 if a returned value is a JSON string, it retains its leading and
10005 trailing quotes.
10006 For the &"jsons"& variant, which is intended for use with JSON strings, the
10007 leading and trailing quotes are removed from the returned value.
10008
10009
10010 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
10011 .cindex "list" "selecting by condition"
10012 .cindex "expansion" "selecting from list by condition"
10013 .vindex "&$item$&"
10014 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10015 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10016 For each item
10017 in this list, its value is place in &$item$&, and then the condition is
10018 evaluated. If the condition is true, &$item$& is added to the output as an
10019 item in a new list; if the condition is false, the item is discarded. The
10020 separator used for the output list is the same as the one used for the
10021 input, but a separator setting is not included in the output. For example:
10022 .code
10023 ${filter{a:b:c}{!eq{$item}{b}}}
10024 .endd
10025 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
10026 to what it was before. See also the &%map%& and &%reduce%& expansion items.
10027
10028
10029 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10030 .cindex "hash function" "textual"
10031 .cindex "expansion" "textual hash"
10032 This is a textual hashing function, and was the first to be implemented in
10033 early versions of Exim. In current releases, there are other hashing functions
10034 (numeric, MD5, and SHA-1), which are described below.
10035
10036 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
10037 <&'n'&>. If you are using fixed values for these numbers, that is, if
10038 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
10039 use the simpler operator notation that avoids some of the braces:
10040 .code
10041 ${hash_<n>_<m>:<string>}
10042 .endd
10043 The second number is optional (in both notations). If <&'n'&> is greater than
10044 or equal to the length of the string, the expansion item returns the string.
10045 Otherwise it computes a new string of length <&'n'&> by applying a hashing
10046 function to the string. The new string consists of characters taken from the
10047 first <&'m'&> characters of the string
10048 .code
10049 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
10050 .endd
10051 If <&'m'&> is not present the value 26 is used, so that only lower case
10052 letters appear. For example:
10053 .display
10054 &`$hash{3}{monty}}           `&   yields  &`jmg`&
10055 &`$hash{5}{monty}}           `&   yields  &`monty`&
10056 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
10057 .endd
10058
10059 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
10060         &*$h_*&<&'header&~name'&>&*:*&" &&&
10061        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10062         &*$bh_*&<&'header&~name'&>&*:*&" &&&
10063        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10064         &*$lh_*&<&'header&~name'&>&*:*&" &&&
10065        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
10066         &*$rh_*&<&'header&~name'&>&*:*&"
10067 .cindex "expansion" "header insertion"
10068 .vindex "&$header_$&"
10069 .vindex "&$bheader_$&"
10070 .vindex "&$lheader_$&"
10071 .vindex "&$rheader_$&"
10072 .cindex "header lines" "in expansion strings"
10073 .cindex "header lines" "character sets"
10074 .cindex "header lines" "decoding"
10075 Substitute the contents of the named message header line, for example
10076 .code
10077 $header_reply-to:
10078 .endd
10079 The newline that terminates a header line is not included in the expansion, but
10080 internal newlines (caused by splitting the header line over several physical
10081 lines) may be present.
10082
10083 The difference between the four pairs of expansions is in the way
10084 the data in the header line is interpreted.
10085
10086 .ilist
10087 .cindex "white space" "in header lines"
10088 &%rheader%& gives the original &"raw"& content of the header line, with no
10089 processing at all, and without the removal of leading and trailing white space.
10090
10091 .next
10092 .cindex "list" "of header lines"
10093 &%lheader%& gives a colon-separated list, one element per header when there
10094 are multiple headers with a given name.
10095 Any embedded colon characters within an element are doubled, so normal Exim
10096 list-processing facilities can be used.
10097 The terminating newline of each element is removed; in other respects
10098 the content is &"raw"&.
10099
10100 .next
10101 .cindex "base64 encoding" "in header lines"
10102 &%bheader%& removes leading and trailing white space, and then decodes base64
10103 or quoted-printable MIME &"words"& within the header text, but does no
10104 character set translation. If decoding of what looks superficially like a MIME
10105 &"word"& fails, the raw string is returned. If decoding
10106 .cindex "binary zero" "in header line"
10107 produces a binary zero character, it is replaced by a question mark &-- this is
10108 what Exim does for binary zeros that are actually received in header lines.
10109
10110 .next
10111 &%header%& tries to translate the string as decoded by &%bheader%& to a
10112 standard character set. This is an attempt to produce the same string as would
10113 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
10114 returned. Translation is attempted only on operating systems that support the
10115 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
10116 a system Makefile or in &_Local/Makefile_&.
10117 .endlist ilist
10118
10119 In a filter file, the target character set for &%header%& can be specified by a
10120 command of the following form:
10121 .code
10122 headers charset "UTF-8"
10123 .endd
10124 This command affects all references to &$h_$& (or &$header_$&) expansions in
10125 subsequently obeyed filter commands. In the absence of this command, the target
10126 character set in a filter is taken from the setting of the &%headers_charset%&
10127 option in the runtime configuration. The value of this option defaults to the
10128 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
10129 ISO-8859-1.
10130
10131 Header names follow the syntax of RFC 2822, which states that they may contain
10132 any printing characters except space and colon. Consequently, curly brackets
10133 &'do not'& terminate header names, and should not be used to enclose them as
10134 if they were variables. Attempting to do so causes a syntax error.
10135
10136 Only header lines that are common to all copies of a message are visible to
10137 this mechanism. These are the original header lines that are received with the
10138 message, and any that are added by an ACL statement or by a system
10139 filter. Header lines that are added to a particular copy of a message by a
10140 router or transport are not accessible.
10141
10142 For incoming SMTP messages, no header lines are visible in
10143 ACLs that are obeyed before the data phase completes,
10144 because the header structure is not set up until the message is received.
10145 They are visible in DKIM, PRDR and DATA ACLs.
10146 Header lines that are added in a RCPT ACL (for example)
10147 are saved until the message's incoming header lines are available, at which
10148 point they are added.
10149 When any of the above ACLs ar
10150 running, however, header lines added by earlier ACLs are visible.
10151
10152 Upper case and lower case letters are synonymous in header names. If the
10153 following character is white space, the terminating colon may be omitted, but
10154 this is not recommended, because you may then forget it when it is needed. When
10155 white space terminates the header name, this white space is included in the
10156 expanded string.  If the message does not contain the given header, the
10157 expansion item is replaced by an empty string. (See the &%def%& condition in
10158 section &<<SECTexpcond>>& for a means of testing for the existence of a
10159 header.)
10160
10161 If there is more than one header with the same name, they are all concatenated
10162 to form the substitution string, up to a maximum length of 64K. Unless
10163 &%rheader%& is being used, leading and trailing white space is removed from
10164 each header before concatenation, and a completely empty header is ignored. A
10165 newline character is then inserted between non-empty headers, but there is no
10166 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10167 those headers that contain lists of addresses, a comma is also inserted at the
10168 junctions between headers. This does not happen for the &%rheader%& expansion.
10169
10170 .cindex "tainted data" "message headers"
10171 When the headers are from an incoming message,
10172 the result of expanding any of these variables is tainted.
10173
10174
10175 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10176 .cindex "expansion" "hmac hashing"
10177 .cindex &%hmac%&
10178 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10179 shared secret and some text into a message authentication code, as specified in
10180 RFC 2104. This differs from &`${md5:secret_text...}`& or
10181 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10182 cryptographic hash, allowing for authentication that is not possible with MD5
10183 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10184 present. For example:
10185 .code
10186 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10187 .endd
10188 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10189 produces:
10190 .code
10191 dd97e3ba5d1a61b5006108f8c8252953
10192 .endd
10193 As an example of how this might be used, you might put in the main part of
10194 an Exim configuration:
10195 .code
10196 SPAMSCAN_SECRET=cohgheeLei2thahw
10197 .endd
10198 In a router or a transport you could then have:
10199 .code
10200 headers_add = \
10201   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10202   ${hmac{md5}{SPAMSCAN_SECRET}\
10203   {${primary_hostname},${message_exim_id},$h_message-id:}}
10204 .endd
10205 Then given a message, you can check where it was scanned by looking at the
10206 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10207 this header line is authentic by recomputing the authentication code from the
10208 host name, message ID and the &'Message-id:'& header line. This can be done
10209 using Exim's &%-be%& option, or by other means, for example, by using the
10210 &'hmac_md5_hex()'& function in Perl.
10211
10212
10213 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10214 .cindex "expansion" "conditional"
10215 .cindex "&%if%&, expansion item"
10216 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10217 item; otherwise <&'string2'&> is used. The available conditions are described
10218 in section &<<SECTexpcond>>& below. For example:
10219 .code
10220 ${if eq {$local_part}{postmaster} {yes}{no} }
10221 .endd
10222 The second string need not be present; if it is not and the condition is not
10223 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10224 be present instead of the second string (without any curly brackets). In this
10225 case, the expansion is forced to fail if the condition is not true (see section
10226 &<<SECTforexpfai>>&).
10227
10228 If both strings are omitted, the result is the string &`true`& if the condition
10229 is true, and the empty string if the condition is false. This makes it less
10230 cumbersome to write custom ACL and router conditions. For example, instead of
10231 .code
10232 condition = ${if >{$acl_m4}{3}{true}{false}}
10233 .endd
10234 you can use
10235 .code
10236 condition = ${if >{$acl_m4}{3}}
10237 .endd
10238
10239
10240
10241 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10242 .cindex expansion "imap folder"
10243 .cindex "&%imapfolder%& expansion item"
10244 This item converts a (possibly multilevel, or with non-ASCII characters)
10245 folder specification to a Maildir name for filesystem use.
10246 For information on internationalisation support see &<<SECTi18nMDA>>&.
10247
10248
10249
10250 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10251 .cindex "expansion" "string truncation"
10252 .cindex "&%length%& expansion item"
10253 The &%length%& item is used to extract the initial portion of a string. Both
10254 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10255 you are using a fixed value for the number, that is, if <&'string1'&> does not
10256 change when expanded, you can use the simpler operator notation that avoids
10257 some of the braces:
10258 .code
10259 ${length_<n>:<string>}
10260 .endd
10261 The result of this item is either the first <&'n'&> bytes or the whole
10262 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10263 &%strlen%&, which gives the length of a string.
10264 All measurement is done in bytes and is not UTF-8 aware.
10265
10266
10267 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10268         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10269 .cindex "expansion" "extracting list elements by number"
10270 .cindex "&%listextract%&" "extract list elements by number"
10271 .cindex "list" "extracting elements by number"
10272 The <&'number'&> argument must consist entirely of decimal digits,
10273 apart from an optional leading minus,
10274 and leading and trailing white space (which is ignored).
10275
10276 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10277 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10278
10279 The first field of the list is numbered one.
10280 If the number is negative, the fields are
10281 counted from the end of the list, with the rightmost one numbered -1.
10282 The numbered element of the list is extracted and placed in &$value$&,
10283 then <&'string2'&> is expanded as the result.
10284
10285 If the modulus of the
10286 number is zero or greater than the number of fields in the string,
10287 the result is the expansion of <&'string3'&>.
10288
10289 For example:
10290 .code
10291 ${listextract{2}{x:42:99}}
10292 .endd
10293 yields &"42"&, and
10294 .code
10295 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10296 .endd
10297 yields &"result: 42"&.
10298
10299 If {<&'string3'&>} is omitted, an empty string is used for string3.
10300 If {<&'string2'&>} is also omitted, the value that was
10301 extracted is used.
10302 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10303
10304
10305 .new
10306 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10307 .cindex quoting "for list"
10308 .cindex list quoting
10309 This item doubles any occurrence of the separator character
10310 in the given string.
10311 An empty string is replaced with a single space.
10312 This converts the string into a safe form for use as a list element,
10313 in a list using the given separator.
10314 .wen
10315
10316
10317 .vitem "&*${lookup&~{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10318         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&" &&&
10319        "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10320         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10321 .cindex "expansion" "lookup in"
10322 .cindex "file" "lookups"
10323 .cindex "lookup" "in expanded string"
10324 The two forms of lookup item specify data lookups in files and databases, as
10325 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10326 lookups, and the second is used for query-style lookups. The <&'key'&>,
10327 <&'file'&>, and <&'query'&> strings are expanded before use.
10328
10329 If there is any white space in a lookup item which is part of a filter command,
10330 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10331 other place where white space is significant, the lookup item must be enclosed
10332 in double quotes. The use of data lookups in users' filter files may be locked
10333 out by the system administrator.
10334
10335 .vindex "&$value$&"
10336 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10337 During its expansion, the variable &$value$& contains the data returned by the
10338 lookup. Afterwards it reverts to the value it had previously (at the outer
10339 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10340 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10341 string on failure. If <&'string2'&> is provided, it can itself be a nested
10342 lookup, thus providing a mechanism for looking up a default value when the
10343 original lookup fails.
10344
10345 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10346 data for the outer lookup while the parameters of the second lookup are
10347 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10348 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10349 appear, and in this case, if the lookup fails, the entire expansion is forced
10350 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10351 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10352 successful lookup, and nothing in the case of failure.
10353
10354 For single-key lookups, the string &"partial"& is permitted to precede the
10355 search type in order to do partial matching, and * or *@ may follow a search
10356 type to request default lookups if the key does not match (see sections
10357 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10358
10359 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10360 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10361 and non-wild parts of the key during the expansion of the replacement text.
10362 They return to their previous values at the end of the lookup item.
10363
10364 This example looks up the postmaster alias in the conventional alias file:
10365 .code
10366 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10367 .endd
10368 This example uses NIS+ to look up the full name of the user corresponding to
10369 the local part of an address, forcing the expansion to fail if it is not found:
10370 .code
10371 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10372   {$value}fail}
10373 .endd
10374
10375
10376 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10377 .cindex "expansion" "list creation"
10378 .vindex "&$item$&"
10379 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10380 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10381 For each item
10382 in this list, its value is place in &$item$&, and then <&'string2'&> is
10383 expanded and added to the output as an item in a new list. The separator used
10384 for the output list is the same as the one used for the input, but a separator
10385 setting is not included in the output. For example:
10386 .code
10387 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10388 .endd
10389 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10390 value of &$item$& is restored to what it was before. See also the &%filter%&
10391 and &%reduce%& expansion items.
10392
10393 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10394 .cindex "expansion" "numeric hash"
10395 .cindex "hash function" "numeric"
10396 The three strings are expanded; the first two must yield numbers. Call them
10397 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10398 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10399 can use the simpler operator notation that avoids some of the braces:
10400 .code
10401 ${nhash_<n>_<m>:<string>}
10402 .endd
10403 The second number is optional (in both notations). If there is only one number,
10404 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10405 processed by a div/mod hash function that returns two numbers, separated by a
10406 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10407 example,
10408 .code
10409 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10410 .endd
10411 returns the string &"6/33"&.
10412
10413
10414
10415 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10416 .cindex "Perl" "use in expanded string"
10417 .cindex "expansion" "calling Perl from"
10418 This item is available only if Exim has been built to include an embedded Perl
10419 interpreter. The subroutine name and the arguments are first separately
10420 expanded, and then the Perl subroutine is called with those arguments. No
10421 additional arguments need be given; the maximum number permitted, including the
10422 name of the subroutine, is nine.
10423
10424 The return value of the subroutine is inserted into the expanded string, unless
10425 the return value is &%undef%&. In that case, the expansion fails in the same
10426 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10427 Whatever you return is evaluated in a scalar context. For example, if you
10428 return the name of a Perl vector, the return value is the size of the vector,
10429 not its contents.
10430
10431 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10432 with the error message that was passed to &%die%&. More details of the embedded
10433 Perl facility are given in chapter &<<CHAPperl>>&.
10434
10435 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10436 out the use of this expansion item in filter files.
10437
10438
10439 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10440 .cindex "&%prvs%& expansion item"
10441 The first argument is a complete email address and the second is secret
10442 keystring. The third argument, specifying a key number, is optional. If absent,
10443 it defaults to 0. The result of the expansion is a prvs-signed email address,
10444 to be typically used with the &%return_path%& option on an &(smtp)& transport
10445 as part of a bounce address tag validation (BATV) scheme. For more discussion
10446 and an example, see section &<<SECTverifyPRVS>>&.
10447
10448 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10449         {*&<&'string'&>&*}}*&"
10450 .cindex "&%prvscheck%& expansion item"
10451 This expansion item is the complement of the &%prvs%& item. It is used for
10452 checking prvs-signed addresses. If the expansion of the first argument does not
10453 yield a syntactically valid prvs-signed address, the whole item expands to the
10454 empty string. When the first argument does expand to a syntactically valid
10455 prvs-signed address, the second argument is expanded, with the prvs-decoded
10456 version of the address and the key number extracted from the address in the
10457 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10458
10459 These two variables can be used in the expansion of the second argument to
10460 retrieve the secret. The validity of the prvs-signed address is then checked
10461 against the secret. The result is stored in the variable &$prvscheck_result$&,
10462 which is empty for failure or &"1"& for success.
10463
10464 The third argument is optional; if it is missing, it defaults to an empty
10465 string. This argument is now expanded. If the result is an empty string, the
10466 result of the expansion is the decoded version of the address. This is the case
10467 whether or not the signature was valid. Otherwise, the result of the expansion
10468 is the expansion of the third argument.
10469
10470 All three variables can be used in the expansion of the third argument.
10471 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10472 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10473
10474 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10475 .cindex "expansion" "inserting an entire file"
10476 .cindex "file" "inserting into expansion"
10477 .cindex "&%readfile%& expansion item"
10478 The filename and end-of-line string are first expanded separately. The file is
10479 then read, and its contents replace the entire item. All newline characters in
10480 the file are replaced by the end-of-line string if it is present. Otherwise,
10481 newlines are left in the string.
10482 String expansion is not applied to the contents of the file. If you want this,
10483 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10484 the string expansion fails.
10485
10486 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10487 locks out the use of this expansion item in filter files.
10488
10489
10490
10491 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10492         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10493 .cindex "expansion" "inserting from a socket"
10494 .cindex "socket, use of in expansion"
10495 .cindex "&%readsocket%& expansion item"
10496 This item inserts data from a Unix domain or TCP socket into the expanded
10497 string. The minimal way of using it uses just two arguments, as in these
10498 examples:
10499 .code
10500 ${readsocket{/socket/name}{request string}}
10501 ${readsocket{inet:some.host:1234}{request string}}
10502 .endd
10503 For a Unix domain socket, the first substring must be the path to the socket.
10504 For an Internet socket, the first substring must contain &`inet:`& followed by
10505 a host name or IP address, followed by a colon and a port, which can be a
10506 number or the name of a TCP port in &_/etc/services_&. An IP address may
10507 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10508 example:
10509 .code
10510 ${readsocket{inet:[::1]:1234}{request string}}
10511 .endd
10512 Only a single host name may be given, but if looking it up yields more than
10513 one IP address, they are each tried in turn until a connection is made. For
10514 both kinds of socket, Exim makes a connection, writes the request string
10515 unless it is an empty string; and no terminating NUL is ever sent)
10516 and reads from the socket until an end-of-file
10517 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10518 extend what can be done. Firstly, you can vary the timeout. For example:
10519 .code
10520 ${readsocket{/socket/name}{request string}{3s}}
10521 .endd
10522
10523 The third argument is a list of options, of which the first element is the timeout
10524 and must be present if any options are given.
10525 Further elements are options of form &'name=value'&.
10526 Example:
10527 .code
10528 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10529 .endd
10530
10531 The following option names are recognised:
10532 .ilist
10533 &*cache*&
10534 Defines if the result data can be cached for use by a later identical
10535 request in the same process.
10536 Values are &"yes"& or &"no"& (the default).
10537 If not, all cached results for this connection specification
10538 will be invalidated.
10539
10540 .next
10541 &*shutdown*&
10542 Defines whether or not a write-shutdown is done on the connection after
10543 sending the request. Values are &"yes"& (the default) or &"no"&
10544 (preferred, eg. by some webservers).
10545
10546 .next
10547 &*tls*&
10548 Controls the use of TLS on the connection.
10549 Values are &"yes"& or &"no"& (the default).
10550 If it is enabled, a shutdown as descripbed above is never done.
10551 .endlist
10552
10553
10554 A fourth argument allows you to change any newlines that are in the data
10555 that is read, in the same way as for &%readfile%& (see above). This example
10556 turns them into spaces:
10557 .code
10558 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10559 .endd
10560 As with all expansions, the substrings are expanded before the processing
10561 happens. Errors in these sub-expansions cause the expansion to fail. In
10562 addition, the following errors can occur:
10563
10564 .ilist
10565 Failure to create a socket file descriptor;
10566 .next
10567 Failure to connect the socket;
10568 .next
10569 Failure to write the request string;
10570 .next
10571 Timeout on reading from the socket.
10572 .endlist
10573
10574 By default, any of these errors causes the expansion to fail. However, if
10575 you supply a fifth substring, it is expanded and used when any of the above
10576 errors occurs. For example:
10577 .code
10578 ${readsocket{/socket/name}{request string}{3s}{\n}\
10579   {socket failure}}
10580 .endd
10581 You can test for the existence of a Unix domain socket by wrapping this
10582 expansion in &`${if exists`&, but there is a race condition between that test
10583 and the actual opening of the socket, so it is safer to use the fifth argument
10584 if you want to be absolutely sure of avoiding an expansion error for a
10585 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10586
10587 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10588 locks out the use of this expansion item in filter files.
10589
10590
10591 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10592 .cindex "expansion" "reducing a list to a scalar"
10593 .cindex "list" "reducing to a scalar"
10594 .vindex "&$value$&"
10595 .vindex "&$item$&"
10596 This operation reduces a list to a single, scalar string. After expansion,
10597 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10598 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10599 Then <&'string2'&> is expanded and
10600 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10601 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10602 them. The result of that expansion is assigned to &$value$& before the next
10603 iteration. When the end of the list is reached, the final value of &$value$& is
10604 added to the expansion output. The &%reduce%& expansion item can be used in a
10605 number of ways. For example, to add up a list of numbers:
10606 .code
10607 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10608 .endd
10609 The result of that expansion would be &`6`&. The maximum of a list of numbers
10610 can be found:
10611 .code
10612 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10613 .endd
10614 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10615 restored to what they were before. See also the &%filter%& and &%map%&
10616 expansion items.
10617
10618 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10619 This item inserts &"raw"& header lines. It is described with the &%header%&
10620 expansion item in section &<<SECTexpansionitems>>& above.
10621
10622 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10623         {*&<&'string2'&>&*}}*&"
10624 .cindex "expansion" "running a command"
10625 .cindex "&%run%& expansion item"
10626 The command and its arguments are first expanded as one string. The string is
10627 split apart into individual arguments by spaces, and then the command is run
10628 in a separate process, but under the same uid and gid.  As in other command
10629 executions from Exim, a shell is not used by default. If the command requires
10630 a shell, you must explicitly code it.
10631
10632 Since the arguments are split by spaces, when there is a variable expansion
10633 which has an empty result, it will cause the situation that the argument will
10634 simply be omitted when the program is actually executed by Exim. If the
10635 script/program requires a specific number of arguments and the expanded
10636 variable could possibly result in this empty expansion, the variable must be
10637 quoted. This is more difficult if the expanded variable itself could result
10638 in a string containing quotes, because it would interfere with the quotes
10639 around the command arguments. A possible guard against this is to wrap the
10640 variable in the &%sg%& operator to change any quote marks to some other
10641 character.
10642
10643 The standard input for the command exists, but is empty. The standard output
10644 and standard error are set to the same file descriptor.
10645 .cindex "return code" "from &%run%& expansion"
10646 .vindex "&$value$&"
10647 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10648 and replaces the entire item; during this expansion, the standard output/error
10649 from the command is in the variable &$value$&. If the command fails,
10650 <&'string2'&>, if present, is expanded and used. Once again, during the
10651 expansion, the standard output/error from the command is in the variable
10652 &$value$&.
10653
10654 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10655 can be the word &"fail"& (not in braces) to force expansion failure if the
10656 command does not succeed. If both strings are omitted, the result is contents
10657 of the standard output/error on success, and nothing on failure.
10658
10659 .vindex "&$run_in_acl$&"
10660 The standard output/error of the command is put in the variable &$value$&.
10661 In this ACL example, the output of a command is logged for the admin to
10662 troubleshoot:
10663 .code
10664 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10665       log_message  = Output of id: $value
10666 .endd
10667 If the command requires shell idioms, such as the > redirect operator, the
10668 shell must be invoked directly, such as with:
10669 .code
10670 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10671 .endd
10672
10673 .vindex "&$runrc$&"
10674 The return code from the command is put in the variable &$runrc$&, and this
10675 remains set afterwards, so in a filter file you can do things like this:
10676 .code
10677 if "${run{x y z}{}}$runrc" is 1 then ...
10678   elif $runrc is 2 then ...
10679   ...
10680 endif
10681 .endd
10682 If execution of the command fails (for example, the command does not exist),
10683 the return code is 127 &-- the same code that shells use for non-existent
10684 commands.
10685
10686 &*Warning*&: In a router or transport, you cannot assume the order in which
10687 option values are expanded, except for those preconditions whose order of
10688 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10689 by the expansion of one option, and use it in another.
10690
10691 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10692 out the use of this expansion item in filter files.
10693
10694
10695 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10696 .cindex "expansion" "string substitution"
10697 .cindex "&%sg%& expansion item"
10698 This item works like Perl's substitution operator (s) with the global (/g)
10699 option; hence its name. However, unlike the Perl equivalent, Exim does not
10700 modify the subject string; instead it returns the modified string for insertion
10701 into the overall expansion. The item takes three arguments: the subject string,
10702 a regular expression, and a substitution string. For example:
10703 .code
10704 ${sg{abcdefabcdef}{abc}{xyz}}
10705 .endd
10706 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10707 if any $, } or \ characters are required in the regular expression or in the
10708 substitution string, they have to be escaped. For example:
10709 .code
10710 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10711 .endd
10712 yields &"defabc"&, and
10713 .code
10714 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10715 .endd
10716 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10717 the regular expression from string expansion.
10718
10719 The regular expression is compiled in 8-bit mode, working against bytes
10720 rather than any Unicode-aware character handling.
10721
10722
10723 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10724 .cindex sorting "a list"
10725 .cindex list sorting
10726 .cindex expansion "list sorting"
10727 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10728 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10729 The <&'comparator'&> argument is interpreted as the operator
10730 of a two-argument expansion condition.
10731 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10732 The comparison should return true when applied to two values
10733 if the first value should sort before the second value.
10734 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10735 the element being placed in &$item$&,
10736 to give values for comparison.
10737
10738 The item result is a sorted list,
10739 with the original list separator,
10740 of the list elements (in full) of the original.
10741
10742 Examples:
10743 .code
10744 ${sort{3:2:1:4}{<}{$item}}
10745 .endd
10746 sorts a list of numbers, and
10747 .code
10748 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10749 .endd
10750 will sort an MX lookup into priority order.
10751
10752
10753
10754 .new
10755 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10756 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10757 .wen
10758
10759
10760
10761 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10762 .cindex "&%substr%& expansion item"
10763 .cindex "substring extraction"
10764 .cindex "expansion" "substring extraction"
10765 The three strings are expanded; the first two must yield numbers. Call them
10766 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10767 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10768 can use the simpler operator notation that avoids some of the braces:
10769 .code
10770 ${substr_<n>_<m>:<string>}
10771 .endd
10772 The second number is optional (in both notations).
10773 If it is absent in the simpler format, the preceding underscore must also be
10774 omitted.
10775
10776 The &%substr%& item can be used to extract more general substrings than
10777 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10778 length required. For example
10779 .code
10780 ${substr{3}{2}{$local_part}}
10781 .endd
10782 If the starting offset is greater than the string length the result is the
10783 null string; if the length plus starting offset is greater than the string
10784 length, the result is the right-hand part of the string, starting from the
10785 given offset. The first byte (character) in the string has offset zero.
10786
10787 The &%substr%& expansion item can take negative offset values to count
10788 from the right-hand end of its operand. The last byte (character) is offset -1,
10789 the second-last is offset -2, and so on. Thus, for example,
10790 .code
10791 ${substr{-5}{2}{1234567}}
10792 .endd
10793 yields &"34"&. If the absolute value of a negative offset is greater than the
10794 length of the string, the substring starts at the beginning of the string, and
10795 the length is reduced by the amount of overshoot. Thus, for example,
10796 .code
10797 ${substr{-5}{2}{12}}
10798 .endd
10799 yields an empty string, but
10800 .code
10801 ${substr{-3}{2}{12}}
10802 .endd
10803 yields &"1"&.
10804
10805 When the second number is omitted from &%substr%&, the remainder of the string
10806 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10807 string preceding the offset point are taken. For example, an offset of -1 and
10808 no length, as in these semantically identical examples:
10809 .code
10810 ${substr_-1:abcde}
10811 ${substr{-1}{abcde}}
10812 .endd
10813 yields all but the last character of the string, that is, &"abcd"&.
10814
10815 All measurement is done in bytes and is not UTF-8 aware.
10816
10817
10818
10819 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10820         {*&<&'replacements'&>&*}}*&"
10821 .cindex "expansion" "character translation"
10822 .cindex "&%tr%& expansion item"
10823 This item does single-character (in bytes) translation on its subject string. The second
10824 argument is a list of characters to be translated in the subject string. Each
10825 matching character is replaced by the corresponding character from the
10826 replacement list. For example
10827 .code
10828 ${tr{abcdea}{ac}{13}}
10829 .endd
10830 yields &`1b3de1`&. If there are duplicates in the second character string, the
10831 last occurrence is used. If the third string is shorter than the second, its
10832 last character is replicated. However, if it is empty, no translation takes
10833 place.
10834
10835 All character handling is done in bytes and is not UTF-8 aware.
10836
10837 .endlist
10838
10839
10840
10841 .section "Expansion operators" "SECTexpop"
10842 .cindex "expansion" "operators"
10843 For expansion items that perform transformations on a single argument string,
10844 the &"operator"& notation is used because it is simpler and uses fewer braces.
10845 The substring is first expanded before the operation is applied to it. The
10846 following operations can be performed:
10847
10848 .vlist
10849 .vitem &*${address:*&<&'string'&>&*}*&
10850 .cindex "expansion" "RFC 2822 address handling"
10851 .cindex "&%address%& expansion item"
10852 The string is interpreted as an RFC 2822 address, as it might appear in a
10853 header line, and the effective address is extracted from it. If the string does
10854 not parse successfully, the result is empty.
10855
10856 The parsing correctly handles SMTPUTF8 Unicode in the string.
10857
10858
10859 .vitem &*${addresses:*&<&'string'&>&*}*&
10860 .cindex "expansion" "RFC 2822 address handling"
10861 .cindex "&%addresses%& expansion item"
10862 The string (after expansion) is interpreted as a list of addresses in RFC
10863 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10864 operative address (&'local-part@domain'&) is extracted from each item, and the
10865 result of the expansion is a colon-separated list, with appropriate
10866 doubling of colons should any happen to be present in the email addresses.
10867 Syntactically invalid RFC2822 address items are omitted from the output.
10868
10869 It is possible to specify a character other than colon for the output
10870 separator by starting the string with > followed by the new separator
10871 character. For example:
10872 .code
10873 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10874 .endd
10875 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10876 first, so if the expanded string starts with >, it may change the output
10877 separator unintentionally. This can be avoided by setting the output
10878 separator explicitly:
10879 .code
10880 ${addresses:>:$h_from:}
10881 .endd
10882
10883 Compare the &%address%& (singular)
10884 expansion item, which extracts the working address from a single RFC2822
10885 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10886 processing lists.
10887
10888 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10889 a strict interpretation of header line formatting.  Exim parses the bare,
10890 unquoted portion of an email address and if it finds a comma, treats it as an
10891 email address separator. For the example header line:
10892 .code
10893 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10894 .endd
10895 The first example below demonstrates that Q-encoded email addresses are parsed
10896 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10897 It does not see the comma because it's still encoded as "=2C".  The second
10898 example below is passed the contents of &`$header_from:`&, meaning it gets
10899 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10900 The third example shows that the presence of a comma is skipped when it is
10901 quoted.  The fourth example shows SMTPUTF8 handling.
10902 .code
10903 # exim -be '${addresses:From: \
10904 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10905 user@example.com
10906 # exim -be '${addresses:From: Last, First <user@example.com>}'
10907 Last:user@example.com
10908 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10909 user@example.com
10910 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10911 フィリップ@example.jp
10912 .endd
10913
10914 .vitem &*${base32:*&<&'digits'&>&*}*&
10915 .cindex "&%base32%& expansion item"
10916 .cindex "expansion" "conversion to base 32"
10917 The string must consist entirely of decimal digits. The number is converted to
10918 base 32 and output as a (empty, for zero) string of characters.
10919 Only lowercase letters are used.
10920
10921 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10922 .cindex "&%base32d%& expansion item"
10923 .cindex "expansion" "conversion to base 32"
10924 The string must consist entirely of base-32 digits.
10925 The number is converted to decimal and output as a string.
10926
10927 .vitem &*${base62:*&<&'digits'&>&*}*&
10928 .cindex "&%base62%& expansion item"
10929 .cindex "expansion" "conversion to base 62"
10930 The string must consist entirely of decimal digits. The number is converted to
10931 base 62 and output as a string of six characters, including leading zeros. In
10932 the few operating environments where Exim uses base 36 instead of base 62 for
10933 its message identifiers (because those systems do not have case-sensitive
10934 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10935 to be absolutely clear: this is &'not'& base64 encoding.
10936
10937 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10938 .cindex "&%base62d%& expansion item"
10939 .cindex "expansion" "conversion to base 62"
10940 The string must consist entirely of base-62 digits, or, in operating
10941 environments where Exim uses base 36 instead of base 62 for its message
10942 identifiers, base-36 digits. The number is converted to decimal and output as a
10943 string.
10944
10945 .vitem &*${base64:*&<&'string'&>&*}*&
10946 .cindex "expansion" "base64 encoding"
10947 .cindex "base64 encoding" "in string expansion"
10948 .cindex "&%base64%& expansion item"
10949 .cindex certificate "base64 of DER"
10950 This operator converts a string into one that is base64 encoded.
10951
10952 If the string is a single variable of type certificate,
10953 returns the base64 encoding of the DER form of the certificate.
10954
10955
10956 .vitem &*${base64d:*&<&'string'&>&*}*&
10957 .cindex "expansion" "base64 decoding"
10958 .cindex "base64 decoding" "in string expansion"
10959 .cindex "&%base64d%& expansion item"
10960 This operator converts a base64-encoded string into the un-coded form.
10961
10962
10963 .vitem &*${domain:*&<&'string'&>&*}*&
10964 .cindex "domain" "extraction"
10965 .cindex "expansion" "domain extraction"
10966 The string is interpreted as an RFC 2822 address and the domain is extracted
10967 from it. If the string does not parse successfully, the result is empty.
10968
10969
10970 .vitem &*${escape:*&<&'string'&>&*}*&
10971 .cindex "expansion" "escaping non-printing characters"
10972 .cindex "&%escape%& expansion item"
10973 If the string contains any non-printing characters, they are converted to
10974 escape sequences starting with a backslash. Whether characters with the most
10975 significant bit set (so-called &"8-bit characters"&) count as printing or not
10976 is controlled by the &%print_topbitchars%& option.
10977
10978 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10979 .cindex "expansion" "escaping 8-bit characters"
10980 .cindex "&%escape8bit%& expansion item"
10981 If the string contains and characters with the most significant bit set,
10982 they are converted to escape sequences starting with a backslash.
10983 Backslashes and DEL characters are also converted.
10984
10985
10986 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10987 .cindex "expansion" "expression evaluation"
10988 .cindex "expansion" "arithmetic expression"
10989 .cindex "&%eval%& expansion item"
10990 These items supports simple arithmetic and bitwise logical operations in
10991 expansion strings. The string (after expansion) must be a conventional
10992 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10993 logical operators, and parentheses. All operations are carried out using
10994 integer arithmetic. The operator priorities are as follows (the same as in the
10995 C programming language):
10996 .table2 70pt 300pt
10997 .irow &'highest:'& "not (~), negate (-)"
10998 .irow ""   "multiply (*), divide (/), remainder (%)"
10999 .irow ""   "plus (+), minus (-)"
11000 .irow ""   "shift-left (<<), shift-right (>>)"
11001 .irow ""   "and (&&)"
11002 .irow ""   "xor (^)"
11003 .irow &'lowest:'&  "or (|)"
11004 .endtable
11005 Binary operators with the same priority are evaluated from left to right. White
11006 space is permitted before or after operators.
11007
11008 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
11009 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
11010 decimal, even if they start with a leading zero; hexadecimal numbers are not
11011 permitted. This can be useful when processing numbers extracted from dates or
11012 times, which often do have leading zeros.
11013
11014 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
11015 or 1024*1024*1024,
11016 respectively. Negative numbers are supported. The result of the computation is
11017 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
11018
11019 .display
11020 &`${eval:1+1}            `&  yields 2
11021 &`${eval:1+2*3}          `&  yields 7
11022 &`${eval:(1+2)*3}        `&  yields 9
11023 &`${eval:2+42%5}         `&  yields 4
11024 &`${eval:0xc&amp;5}          `&  yields 4
11025 &`${eval:0xc|5}          `&  yields 13
11026 &`${eval:0xc^5}          `&  yields 9
11027 &`${eval:0xc>>1}         `&  yields 6
11028 &`${eval:0xc<<1}         `&  yields 24
11029 &`${eval:~255&amp;0x1234}    `&  yields 4608
11030 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
11031 .endd
11032
11033 As a more realistic example, in an ACL you might have
11034 .code
11035 deny   condition =                    \
11036          ${if and {                   \
11037            {>{$rcpt_count}{10}}       \
11038            {                          \
11039            <                          \
11040              {$recipients_count}      \
11041              {${eval:$rcpt_count/2}}  \
11042            }                          \
11043          }{yes}{no}}
11044        message = Too many bad recipients
11045 .endd
11046 The condition is true if there have been more than 10 RCPT commands and
11047 fewer than half of them have resulted in a valid recipient.
11048
11049
11050 .vitem &*${expand:*&<&'string'&>&*}*&
11051 .cindex "expansion" "re-expansion of substring"
11052 The &%expand%& operator causes a string to be expanded for a second time. For
11053 example,
11054 .code
11055 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
11056 .endd
11057 first looks up a string in a file while expanding the operand for &%expand%&,
11058 and then re-expands what it has found.
11059
11060
11061 .vitem &*${from_utf8:*&<&'string'&>&*}*&
11062 .cindex "Unicode"
11063 .cindex "UTF-8" "conversion from"
11064 .cindex "expansion" "UTF-8 conversion"
11065 .cindex "&%from_utf8%& expansion item"
11066 The world is slowly moving towards Unicode, although there are no standards for
11067 email yet. However, other applications (including some databases) are starting
11068 to store data in Unicode, using UTF-8 encoding. This operator converts from a
11069 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
11070 converted to underscores. The input must be a valid UTF-8 string. If it is not,
11071 the result is an undefined sequence of bytes.
11072
11073 Unicode code points with values less than 256 are compatible with ASCII and
11074 ISO-8859-1 (also known as Latin-1).
11075 For example, character 169 is the copyright symbol in both cases, though the
11076 way it is encoded is different. In UTF-8, more than one byte is needed for
11077 characters with code values greater than 127, whereas ISO-8859-1 is a
11078 single-byte encoding (but thereby limited to 256 characters). This makes
11079 translation from UTF-8 to ISO-8859-1 straightforward.
11080
11081
11082 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11083 .cindex "hash function" "textual"
11084 .cindex "expansion" "textual hash"
11085 The &%hash%& operator is a simpler interface to the hashing function that can
11086 be used when the two parameters are fixed numbers (as opposed to strings that
11087 change when expanded). The effect is the same as
11088 .code
11089 ${hash{<n>}{<m>}{<string>}}
11090 .endd
11091 See the description of the general &%hash%& item above for details. The
11092 abbreviation &%h%& can be used when &%hash%& is used as an operator.
11093
11094
11095
11096 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
11097 .cindex "base64 encoding" "conversion from hex"
11098 .cindex "expansion" "hex to base64"
11099 .cindex "&%hex2b64%& expansion item"
11100 This operator converts a hex string into one that is base64 encoded. This can
11101 be useful for processing the output of the various hashing functions.
11102
11103
11104
11105 .vitem &*${hexquote:*&<&'string'&>&*}*&
11106 .cindex "quoting" "hex-encoded unprintable characters"
11107 .cindex "&%hexquote%& expansion item"
11108 This operator converts non-printable characters in a string into a hex
11109 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
11110 as is, and other byte values are converted to &`\xNN`&, for example, a
11111 byte value 127 is converted to &`\x7f`&.
11112
11113
11114 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
11115 .cindex "&%ipv6denorm%& expansion item"
11116 .cindex "IP address" normalisation
11117 This expands an IPv6 address to a full eight-element colon-separated set
11118 of hex digits including leading zeroes.
11119 A trailing ipv4-style dotted-decimal set is converted to hex.
11120 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11121
11122 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
11123 .cindex "&%ipv6norm%& expansion item"
11124 .cindex "IP address" normalisation
11125 .cindex "IP address" "canonical form"
11126 This converts an IPv6 address to canonical form.
11127 Leading zeroes of groups are omitted, and the longest
11128 set of zero-valued groups is replaced with a double colon.
11129 A trailing ipv4-style dotted-decimal set is converted to hex.
11130 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11131
11132
11133 .vitem &*${lc:*&<&'string'&>&*}*&
11134 .cindex "case forcing in strings"
11135 .cindex "string" "case forcing"
11136 .cindex "lower casing"
11137 .cindex "expansion" "case forcing"
11138 .cindex "&%lc%& expansion item"
11139 This forces the letters in the string into lower-case, for example:
11140 .code
11141 ${lc:$local_part}
11142 .endd
11143 Case is defined per the system C locale.
11144
11145 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11146 .cindex "expansion" "string truncation"
11147 .cindex "&%length%& expansion item"
11148 The &%length%& operator is a simpler interface to the &%length%& function that
11149 can be used when the parameter is a fixed number (as opposed to a string that
11150 changes when expanded). The effect is the same as
11151 .code
11152 ${length{<number>}{<string>}}
11153 .endd
11154 See the description of the general &%length%& item above for details. Note that
11155 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11156 when &%length%& is used as an operator.
11157 All measurement is done in bytes and is not UTF-8 aware.
11158
11159
11160 .vitem &*${listcount:*&<&'string'&>&*}*&
11161 .cindex "expansion" "list item count"
11162 .cindex "list" "item count"
11163 .cindex "list" "count of items"
11164 .cindex "&%listcount%& expansion item"
11165 The string is interpreted as a list and the number of items is returned.
11166
11167
11168 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11169 .cindex "expansion" "named list"
11170 .cindex "&%listnamed%& expansion item"
11171 The name is interpreted as a named list and the content of the list is returned,
11172 expanding any referenced lists, re-quoting as needed for colon-separation.
11173 If the optional type is given it must be one of "a", "d", "h" or "l"
11174 and selects address-, domain-, host- or localpart- lists to search among respectively.
11175 Otherwise all types are searched in an undefined order and the first
11176 matching list is returned.
11177
11178
11179 .vitem &*${local_part:*&<&'string'&>&*}*&
11180 .cindex "expansion" "local part extraction"
11181 .cindex "&%local_part%& expansion item"
11182 The string is interpreted as an RFC 2822 address and the local part is
11183 extracted from it. If the string does not parse successfully, the result is
11184 empty.
11185 The parsing correctly handles SMTPUTF8 Unicode in the string.
11186
11187
11188 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11189 .cindex "masked IP address"
11190 .cindex "IP address" "masking"
11191 .cindex "CIDR notation"
11192 .cindex "expansion" "IP address masking"
11193 .cindex "&%mask%& expansion item"
11194 If the form of the string to be operated on is not an IP address followed by a
11195 slash and an integer (that is, a network address in CIDR notation), the
11196 expansion fails. Otherwise, this operator converts the IP address to binary,
11197 masks off the least significant bits according to the bit count, and converts
11198 the result back to text, with mask appended. For example,
11199 .code
11200 ${mask:10.111.131.206/28}
11201 .endd
11202 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11203 be mostly used for looking up masked addresses in files, the result for an IPv6
11204 address uses dots to separate components instead of colons, because colon
11205 terminates a key string in lsearch files. So, for example,
11206 .code
11207 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11208 .endd
11209 returns the string
11210 .code
11211 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11212 .endd
11213 Letters in IPv6 addresses are always output in lower case.
11214
11215
11216 .vitem &*${md5:*&<&'string'&>&*}*&
11217 .cindex "MD5 hash"
11218 .cindex "expansion" "MD5 hash"
11219 .cindex certificate fingerprint
11220 .cindex "&%md5%& expansion item"
11221 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11222 as a 32-digit hexadecimal number, in which any letters are in lower case.
11223
11224 If the string is a single variable of type certificate,
11225 returns the MD5 hash fingerprint of the certificate.
11226
11227
11228 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11229 .cindex "expansion" "numeric hash"
11230 .cindex "hash function" "numeric"
11231 The &%nhash%& operator is a simpler interface to the numeric hashing function
11232 that can be used when the two parameters are fixed numbers (as opposed to
11233 strings that change when expanded). The effect is the same as
11234 .code
11235 ${nhash{<n>}{<m>}{<string>}}
11236 .endd
11237 See the description of the general &%nhash%& item above for details.
11238
11239
11240 .vitem &*${quote:*&<&'string'&>&*}*&
11241 .cindex "quoting" "in string expansions"
11242 .cindex "expansion" "quoting"
11243 .cindex "&%quote%& expansion item"
11244 The &%quote%& operator puts its argument into double quotes if it
11245 is an empty string or
11246 contains anything other than letters, digits, underscores, dots, and hyphens.
11247 Any occurrences of double quotes and backslashes are escaped with a backslash.
11248 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11249 respectively For example,
11250 .code
11251 ${quote:ab"*"cd}
11252 .endd
11253 becomes
11254 .code
11255 "ab\"*\"cd"
11256 .endd
11257 The place where this is useful is when the argument is a substitution from a
11258 variable or a message header.
11259
11260 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11261 .cindex "&%quote_local_part%& expansion item"
11262 This operator is like &%quote%&, except that it quotes the string only if
11263 required to do so by the rules of RFC 2822 for quoting local parts. For
11264 example, a plus sign would not cause quoting (but it would for &%quote%&).
11265 If you are creating a new email address from the contents of &$local_part$&
11266 (or any other unknown data), you should always use this operator.
11267
11268 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11269 will likely use the quoting form.
11270 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11271
11272
11273 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11274 .cindex "quoting" "lookup-specific"
11275 This operator applies lookup-specific quoting rules to the string. Each
11276 query-style lookup type has its own quoting rules which are described with
11277 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11278 .code
11279 ${quote_ldap:two * two}
11280 .endd
11281 returns
11282 .code
11283 two%20%5C2A%20two
11284 .endd
11285 For single-key lookup types, no quoting is ever necessary and this operator
11286 yields an unchanged string.
11287
11288
11289 .vitem &*${randint:*&<&'n'&>&*}*&
11290 .cindex "random number"
11291 This operator returns a somewhat random number which is less than the
11292 supplied number and is at least 0.  The quality of this randomness depends
11293 on how Exim was built; the values are not suitable for keying material.
11294 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11295 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11296 for versions of GnuTLS with that function.
11297 Otherwise, the implementation may be arc4random(), random() seeded by
11298 srandomdev() or srandom(), or a custom implementation even weaker than
11299 random().
11300
11301
11302 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11303 .cindex "expansion" "IP address"
11304 This operator reverses an IP address; for IPv4 addresses, the result is in
11305 dotted-quad decimal form, while for IPv6 addresses the result is in
11306 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11307 for DNS.  For example,
11308 .code
11309 ${reverse_ip:192.0.2.4}
11310 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11311 .endd
11312 returns
11313 .code
11314 4.2.0.192
11315 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
11316 .endd
11317
11318
11319 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11320 .cindex "expansion" "RFC 2047"
11321 .cindex "RFC 2047" "expansion operator"
11322 .cindex "&%rfc2047%& expansion item"
11323 This operator encodes text according to the rules of RFC 2047. This is an
11324 encoding that is used in header lines to encode non-ASCII characters. It is
11325 assumed that the input string is in the encoding specified by the
11326 &%headers_charset%& option, which gets its default at build time. If the string
11327 contains only characters in the range 33&--126, and no instances of the
11328 characters
11329 .code
11330 ? = ( ) < > @ , ; : \ " . [ ] _
11331 .endd
11332 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11333 string, using as many &"encoded words"& as necessary to encode all the
11334 characters.
11335
11336
11337 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11338 .cindex "expansion" "RFC 2047"
11339 .cindex "RFC 2047" "decoding"
11340 .cindex "&%rfc2047d%& expansion item"
11341 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11342 bytes are replaced by question marks. Characters are converted into the
11343 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11344 not recognized unless &%check_rfc2047_length%& is set false.
11345
11346 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11347 access a header line, RFC 2047 decoding is done automatically. You do not need
11348 to use this operator as well.
11349
11350
11351
11352 .vitem &*${rxquote:*&<&'string'&>&*}*&
11353 .cindex "quoting" "in regular expressions"
11354 .cindex "regular expressions" "quoting"
11355 .cindex "&%rxquote%& expansion item"
11356 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11357 characters in its argument. This is useful when substituting the values of
11358 variables or headers inside regular expressions.
11359
11360
11361 .vitem &*${sha1:*&<&'string'&>&*}*&
11362 .cindex "SHA-1 hash"
11363 .cindex "expansion" "SHA-1 hashing"
11364 .cindex certificate fingerprint
11365 .cindex "&%sha1%& expansion item"
11366 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11367 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11368
11369 If the string is a single variable of type certificate,
11370 returns the SHA-1 hash fingerprint of the certificate.
11371
11372
11373 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11374        &*${sha2:*&<&'string'&>&*}*& &&&
11375        &*${sha2_<n>:*&<&'string'&>&*}*&
11376 .cindex "SHA-256 hash"
11377 .cindex "SHA-2 hash"
11378 .cindex certificate fingerprint
11379 .cindex "expansion" "SHA-256 hashing"
11380 .cindex "&%sha256%& expansion item"
11381 .cindex "&%sha2%& expansion item"
11382 The &%sha256%& operator computes the SHA-256 hash value of the string
11383 and returns
11384 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11385
11386 If the string is a single variable of type certificate,
11387 returns the SHA-256 hash fingerprint of the certificate.
11388
11389 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11390 (except for certificates, which are not supported).
11391 Finally, if an underbar
11392 and a number is appended it specifies the output length, selecting a
11393 member of the SHA-2 family of hash functions.
11394 Values of 256, 384 and 512 are accepted, with 256 being the default.
11395
11396
11397 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11398        &*${sha3_<n>:*&<&'string'&>&*}*&
11399 .cindex "SHA3 hash"
11400 .cindex "expansion" "SHA3 hashing"
11401 .cindex "&%sha3%& expansion item"
11402 The &%sha3%& operator computes the SHA3-256 hash value of the string
11403 and returns
11404 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11405
11406 If a number is appended, separated by an underbar, it specifies
11407 the output length.  Values of 224, 256, 384 and 512 are accepted;
11408 with 256 being the default.
11409
11410 The &%sha3%& expansion item is only supported if Exim has been
11411 compiled with GnuTLS 3.5.0 or later,
11412 or OpenSSL 1.1.1 or later.
11413 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11414
11415
11416 .vitem &*${stat:*&<&'string'&>&*}*&
11417 .cindex "expansion" "statting a file"
11418 .cindex "file" "extracting characteristics"
11419 .cindex "&%stat%& expansion item"
11420 The string, after expansion, must be a file path. A call to the &[stat()]&
11421 function is made for this path. If &[stat()]& fails, an error occurs and the
11422 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11423 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11424 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11425 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11426 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11427 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11428 can extract individual fields using the &%extract%& expansion item.
11429
11430 The use of the &%stat%& expansion in users' filter files can be locked out by
11431 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11432 systems for files larger than 2GB.
11433
11434 .vitem &*${str2b64:*&<&'string'&>&*}*&
11435 .cindex "&%str2b64%& expansion item"
11436 Now deprecated, a synonym for the &%base64%& expansion operator.
11437
11438
11439
11440 .vitem &*${strlen:*&<&'string'&>&*}*&
11441 .cindex "expansion" "string length"
11442 .cindex "string" "length in expansion"
11443 .cindex "&%strlen%& expansion item"
11444 The item is replace by the length of the expanded string, expressed as a
11445 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11446 All measurement is done in bytes and is not UTF-8 aware.
11447
11448
11449 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11450 .cindex "&%substr%& expansion item"
11451 .cindex "substring extraction"
11452 .cindex "expansion" "substring expansion"
11453 The &%substr%& operator is a simpler interface to the &%substr%& function that
11454 can be used when the two parameters are fixed numbers (as opposed to strings
11455 that change when expanded). The effect is the same as
11456 .code
11457 ${substr{<start>}{<length>}{<string>}}
11458 .endd
11459 See the description of the general &%substr%& item above for details. The
11460 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11461 All measurement is done in bytes and is not UTF-8 aware.
11462
11463 .vitem &*${time_eval:*&<&'string'&>&*}*&
11464 .cindex "&%time_eval%& expansion item"
11465 .cindex "time interval" "decoding"
11466 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11467 seconds.
11468
11469 .vitem &*${time_interval:*&<&'string'&>&*}*&
11470 .cindex "&%time_interval%& expansion item"
11471 .cindex "time interval" "formatting"
11472 The argument (after sub-expansion) must be a sequence of decimal digits that
11473 represents an interval of time as a number of seconds. It is converted into a
11474 number of larger units and output in Exim's normal time format, for example,
11475 &`1w3d4h2m6s`&.
11476
11477 .vitem &*${uc:*&<&'string'&>&*}*&
11478 .cindex "case forcing in strings"
11479 .cindex "string" "case forcing"
11480 .cindex "upper casing"
11481 .cindex "expansion" "case forcing"
11482 .cindex "&%uc%& expansion item"
11483 This forces the letters in the string into upper-case.
11484 Case is defined per the system C locale.
11485
11486 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11487 .cindex "correction of invalid utf-8 sequences in strings"
11488 .cindex "utf-8" "utf-8 sequences"
11489 .cindex "incorrect utf-8"
11490 .cindex "expansion" "utf-8 forcing"
11491 .cindex "&%utf8clean%& expansion item"
11492 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11493 In versions of Exim before 4.92, this did not correctly do so for a truncated
11494 final codepoint's encoding, and the character would be silently dropped.
11495 If you must handle detection of this scenario across both sets of Exim behavior,
11496 the complexity will depend upon the task.
11497 For instance, to detect if the first character is multibyte and a 1-byte
11498 extraction can be successfully used as a path component (as is common for
11499 dividing up delivery folders), you might use:
11500 .code
11501 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11502 .endd
11503 (which will false-positive if the first character of the local part is a
11504 literal question mark).
11505
11506 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11507        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11508        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11509        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11510 .cindex expansion UTF-8
11511 .cindex UTF-8 expansion
11512 .cindex EAI
11513 .cindex internationalisation
11514 .cindex "&%utf8_domain_to_alabel%& expansion item"
11515 .cindex "&%utf8_domain_from_alabel%& expansion item"
11516 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11517 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11518 These convert EAI mail name components between UTF-8 and a-label forms.
11519 For information on internationalisation support see &<<SECTi18nMTA>>&.
11520 .endlist
11521
11522
11523
11524
11525
11526
11527 .section "Expansion conditions" "SECTexpcond"
11528 .scindex IIDexpcond "expansion" "conditions"
11529 The following conditions are available for testing by the &%${if%& construct
11530 while expanding strings:
11531
11532 .vlist
11533 .vitem &*!*&<&'condition'&>
11534 .cindex "expansion" "negating a condition"
11535 .cindex "negation" "in expansion condition"
11536 Preceding any condition with an exclamation mark negates the result of the
11537 condition.
11538
11539 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11540 .cindex "numeric comparison"
11541 .cindex "expansion" "numeric comparison"
11542 There are a number of symbolic operators for doing numeric comparisons. They
11543 are:
11544 .display
11545 &`=   `&   equal
11546 &`==  `&   equal
11547 &`>   `&   greater
11548 &`>=  `&   greater or equal
11549 &`<   `&   less
11550 &`<=  `&   less or equal
11551 .endd
11552 For example:
11553 .code
11554 ${if >{$message_size}{10M} ...
11555 .endd
11556 Note that the general negation operator provides for inequality testing. The
11557 two strings must take the form of optionally signed decimal integers,
11558 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11559 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11560 As a special case, the numerical value of an empty string is taken as
11561 zero.
11562
11563 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11564 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11565 10M, not if 10M is larger than &$message_size$&.
11566
11567
11568 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11569         {*&<&'arg2'&>&*}...}*&
11570 .cindex "expansion" "calling an acl"
11571 .cindex "&%acl%&" "expansion condition"
11572 The name and zero to nine argument strings are first expanded separately.  The expanded
11573 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11574 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11575 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11576 and may use the variables; if another acl expansion is used the values
11577 are restored after it returns.  If the ACL sets
11578 a value using a "message =" modifier the variable $value becomes
11579 the result of the expansion, otherwise it is empty.
11580 If the ACL returns accept the condition is true; if deny, false.
11581 If the ACL returns defer the result is a forced-fail.
11582
11583 .vitem &*bool&~{*&<&'string'&>&*}*&
11584 .cindex "expansion" "boolean parsing"
11585 .cindex "&%bool%& expansion condition"
11586 This condition turns a string holding a true or false representation into
11587 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11588 (case-insensitively); also integer numbers map to true if non-zero,
11589 false if zero.
11590 An empty string is treated as false.
11591 Leading and trailing whitespace is ignored;
11592 thus a string consisting only of whitespace is false.
11593 All other string values will result in expansion failure.
11594
11595 When combined with ACL variables, this expansion condition will let you
11596 make decisions in one place and act on those decisions in another place.
11597 For example:
11598 .code
11599 ${if bool{$acl_m_privileged_sender} ...
11600 .endd
11601
11602
11603 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11604 .cindex "expansion" "boolean parsing"
11605 .cindex "&%bool_lax%& expansion condition"
11606 Like &%bool%&, this condition turns a string into a boolean state.  But
11607 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11608 loose definition that the Router &%condition%& option uses.  The empty string
11609 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11610 true.  Leading and trailing whitespace is ignored.
11611
11612 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11613
11614 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11615 .cindex "expansion" "encrypted comparison"
11616 .cindex "encrypted strings, comparing"
11617 .cindex "&%crypteq%& expansion condition"
11618 This condition is included in the Exim binary if it is built to support any
11619 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11620 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11621 included in the binary.
11622
11623 The &%crypteq%& condition has two arguments. The first is encrypted and
11624 compared against the second, which is already encrypted. The second string may
11625 be in the LDAP form for storing encrypted strings, which starts with the
11626 encryption type in curly brackets, followed by the data. If the second string
11627 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11628 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11629 Typically this will be a field from a password file. An example of an encrypted
11630 string in LDAP form is:
11631 .code
11632 {md5}CY9rzUYh03PK3k6DJie09g==
11633 .endd
11634 If such a string appears directly in an expansion, the curly brackets have to
11635 be quoted, because they are part of the expansion syntax. For example:
11636 .code
11637 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11638 .endd
11639 The following encryption types (whose names are matched case-independently) are
11640 supported:
11641
11642 .ilist
11643 .cindex "MD5 hash"
11644 .cindex "base64 encoding" "in encrypted password"
11645 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11646 printable characters to compare with the remainder of the second string. If the
11647 length of the comparison string is 24, Exim assumes that it is base64 encoded
11648 (as in the above example). If the length is 32, Exim assumes that it is a
11649 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11650 comparison fails.
11651
11652 .next
11653 .cindex "SHA-1 hash"
11654 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11655 printable characters to compare with the remainder of the second string. If the
11656 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11657 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11658 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11659
11660 .next
11661 .cindex "&[crypt()]&"
11662 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11663 only the first eight characters of the password. However, in modern operating
11664 systems this is no longer true, and in many cases the entire password is used,
11665 whatever its length.
11666
11667 .next
11668 .cindex "&[crypt16()]&"
11669 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11670 use up to 16 characters of the password in some operating systems. Again, in
11671 modern operating systems, more characters may be used.
11672 .endlist
11673 Exim has its own version of &[crypt16()]&, which is just a double call to
11674 &[crypt()]&. For operating systems that have their own version, setting
11675 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11676 operating system version instead of its own. This option is set by default in
11677 the OS-dependent &_Makefile_& for those operating systems that are known to
11678 support &[crypt16()]&.
11679
11680 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11681 it was not using the same algorithm as some operating systems' versions. It
11682 turns out that as well as &[crypt16()]& there is a function called
11683 &[bigcrypt()]& in some operating systems. This may or may not use the same
11684 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11685
11686 However, since there is now a move away from the traditional &[crypt()]&
11687 functions towards using SHA1 and other algorithms, tidying up this area of
11688 Exim is seen as very low priority.
11689
11690 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11691 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11692 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11693 default is &`{crypt}`&. Whatever the default, you can always use either
11694 function by specifying it explicitly in curly brackets.
11695
11696 .vitem &*def:*&<&'variable&~name'&>
11697 .cindex "expansion" "checking for empty variable"
11698 .cindex "&%def%& expansion condition"
11699 The &%def%& condition must be followed by the name of one of the expansion
11700 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11701 variable does not contain the empty string. For example:
11702 .code
11703 ${if def:sender_ident {from $sender_ident}}
11704 .endd
11705 Note that the variable name is given without a leading &%$%& character. If the
11706 variable does not exist, the expansion fails.
11707
11708 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11709         &~&*def:h_*&<&'header&~name'&>&*:*&"
11710 .cindex "expansion" "checking header line existence"
11711 This condition is true if a message is being processed and the named header
11712 exists in the message. For example,
11713 .code
11714 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11715 .endd
11716 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11717 the header name must be terminated by a colon if white space does not follow.
11718
11719 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11720        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11721 .cindex "string" "comparison"
11722 .cindex "expansion" "string comparison"
11723 .cindex "&%eq%& expansion condition"
11724 .cindex "&%eqi%& expansion condition"
11725 The two substrings are first expanded. The condition is true if the two
11726 resulting strings are identical. For &%eq%& the comparison includes the case of
11727 letters, whereas for &%eqi%& the comparison is case-independent, where
11728 case is defined per the system C locale.
11729
11730 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11731 .cindex "expansion" "file existence test"
11732 .cindex "file" "existence test"
11733 .cindex "&%exists%&, expansion condition"
11734 The substring is first expanded and then interpreted as an absolute path. The
11735 condition is true if the named file (or directory) exists. The existence test
11736 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11737 users' filter files may be locked out by the system administrator.
11738
11739 .new
11740 &*Note:*& Testing a path using this condition is not a sufficient way of
11741 de-tainting it.
11742 Consider using a dsearch lookup.
11743 .wen
11744
11745 .vitem &*first_delivery*&
11746 .cindex "delivery" "first"
11747 .cindex "first delivery"
11748 .cindex "expansion" "first delivery test"
11749 .cindex "&%first_delivery%& expansion condition"
11750 This condition, which has no data, is true during a message's first delivery
11751 attempt. It is false during any subsequent delivery attempts.
11752
11753
11754 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11755        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11756 .cindex "list" "iterative conditions"
11757 .cindex "expansion" "&*forall*& condition"
11758 .cindex "expansion" "&*forany*& condition"
11759 .vindex "&$item$&"
11760 These conditions iterate over a list. The first argument is expanded to form
11761 the list. By default, the list separator is a colon, but it can be changed by
11762 the normal method (&<<SECTlistsepchange>>&).
11763 The second argument is interpreted as a condition that is to
11764 be applied to each item in the list in turn. During the interpretation of the
11765 condition, the current list item is placed in a variable called &$item$&.
11766 .ilist
11767 For &*forany*&, interpretation stops if the condition is true for any item, and
11768 the result of the whole condition is true. If the condition is false for all
11769 items in the list, the overall condition is false.
11770 .next
11771 For &*forall*&, interpretation stops if the condition is false for any item,
11772 and the result of the whole condition is false. If the condition is true for
11773 all items in the list, the overall condition is true.
11774 .endlist
11775 Note that negation of &*forany*& means that the condition must be false for all
11776 items for the overall condition to succeed, and negation of &*forall*& means
11777 that the condition must be false for at least one item. In this example, the
11778 list separator is changed to a comma:
11779 .code
11780 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11781 .endd
11782 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11783 being processed, to enable these expansion items to be nested.
11784
11785 To scan a named list, expand it with the &*listnamed*& operator.
11786
11787 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11788        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11789        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11790        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11791 .cindex JSON "iterative conditions"
11792 .cindex JSON expansions
11793 .cindex expansion "&*forall_json*& condition"
11794 .cindex expansion "&*forany_json*& condition"
11795 .cindex expansion "&*forall_jsons*& condition"
11796 .cindex expansion "&*forany_jsons*& condition"
11797 As for the above, except that the first argument must, after expansion,
11798 be a JSON array.
11799 The array separator is not changeable.
11800 For the &"jsons"& variants the elements are expected to be JSON strings
11801 and have their quotes removed before the evaluation of the condition.
11802
11803
11804
11805 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11806        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11807 .cindex "string" "comparison"
11808 .cindex "expansion" "string comparison"
11809 .cindex "&%ge%& expansion condition"
11810 .cindex "&%gei%& expansion condition"
11811 The two substrings are first expanded. The condition is true if the first
11812 string is lexically greater than or equal to the second string. For &%ge%& the
11813 comparison includes the case of letters, whereas for &%gei%& the comparison is
11814 case-independent.
11815 Case and collation order are defined per the system C locale.
11816
11817 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11818        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11819 .cindex "string" "comparison"
11820 .cindex "expansion" "string comparison"
11821 .cindex "&%gt%& expansion condition"
11822 .cindex "&%gti%& expansion condition"
11823 The two substrings are first expanded. The condition is true if the first
11824 string is lexically greater than the second string. For &%gt%& the comparison
11825 includes the case of letters, whereas for &%gti%& the comparison is
11826 case-independent.
11827 Case and collation order are defined per the system C locale.
11828
11829
11830 .new
11831 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11832 SRS decode.  See SECT &<<SECTSRS>>& for details.
11833 .wen
11834
11835
11836 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11837        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11838 .cindex "string" "comparison"
11839 .cindex "list" "iterative conditions"
11840 Both strings are expanded; the second string is treated as a list of simple
11841 strings; if the first string is a member of the second, then the condition
11842 is true.
11843 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11844
11845 These are simpler to use versions of the more powerful &*forany*& condition.
11846 Examples, and the &*forany*& equivalents:
11847 .code
11848 ${if inlist{needle}{foo:needle:bar}}
11849   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11850 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11851   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11852 .endd
11853
11854 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11855        &*isip4&~{*&<&'string'&>&*}*& &&&
11856        &*isip6&~{*&<&'string'&>&*}*&
11857 .cindex "IP address" "testing string format"
11858 .cindex "string" "testing for IP address"
11859 .cindex "&%isip%& expansion condition"
11860 .cindex "&%isip4%& expansion condition"
11861 .cindex "&%isip6%& expansion condition"
11862 The substring is first expanded, and then tested to see if it has the form of
11863 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11864 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11865
11866 For an IPv4 address, the test is for four dot-separated components, each of
11867 which consists of from one to three digits. For an IPv6 address, up to eight
11868 colon-separated components are permitted, each containing from one to four
11869 hexadecimal digits. There may be fewer than eight components if an empty
11870 component (adjacent colons) is present. Only one empty component is permitted.
11871
11872 &*Note*&: The checks used to be just on the form of the address; actual numerical
11873 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11874 check.
11875 This is no longer the case.
11876
11877 The main use of these tests is to distinguish between IP addresses and
11878 host names, or between IPv4 and IPv6 addresses. For example, you could use
11879 .code
11880 ${if isip4{$sender_host_address}...
11881 .endd
11882 to test which IP version an incoming SMTP connection is using.
11883
11884 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11885 .cindex "LDAP" "use for authentication"
11886 .cindex "expansion" "LDAP authentication test"
11887 .cindex "&%ldapauth%& expansion condition"
11888 This condition supports user authentication using LDAP. See section
11889 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11890 queries. For this use, the query must contain a user name and password. The
11891 query itself is not used, and can be empty. The condition is true if the
11892 password is not empty, and the user name and password are accepted by the LDAP
11893 server. An empty password is rejected without calling LDAP because LDAP binds
11894 with an empty password are considered anonymous regardless of the username, and
11895 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11896 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11897 this can be used.
11898
11899
11900 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11901        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11902 .cindex "string" "comparison"
11903 .cindex "expansion" "string comparison"
11904 .cindex "&%le%& expansion condition"
11905 .cindex "&%lei%& expansion condition"
11906 The two substrings are first expanded. The condition is true if the first
11907 string is lexically less than or equal to the second string. For &%le%& the
11908 comparison includes the case of letters, whereas for &%lei%& the comparison is
11909 case-independent.
11910 Case and collation order are defined per the system C locale.
11911
11912 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11913        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11914 .cindex "string" "comparison"
11915 .cindex "expansion" "string comparison"
11916 .cindex "&%lt%& expansion condition"
11917 .cindex "&%lti%& expansion condition"
11918 The two substrings are first expanded. The condition is true if the first
11919 string is lexically less than the second string. For &%lt%& the comparison
11920 includes the case of letters, whereas for &%lti%& the comparison is
11921 case-independent.
11922 Case and collation order are defined per the system C locale.
11923
11924
11925 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11926 .cindex "expansion" "regular expression comparison"
11927 .cindex "regular expressions" "match in expanded string"
11928 .cindex "&%match%& expansion condition"
11929 The two substrings are first expanded. The second is then treated as a regular
11930 expression and applied to the first. Because of the pre-expansion, if the
11931 regular expression contains dollar, or backslash characters, they must be
11932 escaped. Care must also be taken if the regular expression contains braces
11933 (curly brackets). A closing brace must be escaped so that it is not taken as a
11934 premature termination of <&'string2'&>. The easiest approach is to use the
11935 &`\N`& feature to disable expansion of the regular expression.
11936 For example,
11937 .code
11938 ${if match {$local_part}{\N^\d{3}\N} ...
11939 .endd
11940 If the whole expansion string is in double quotes, further escaping of
11941 backslashes is also required.
11942
11943 The condition is true if the regular expression match succeeds.
11944 The regular expression is not required to begin with a circumflex
11945 metacharacter, but if there is no circumflex, the expression is not anchored,
11946 and it may match anywhere in the subject, not just at the start. If you want
11947 the pattern to match at the end of the subject, you must include the &`$`&
11948 metacharacter at an appropriate point.
11949 All character handling is done in bytes and is not UTF-8 aware,
11950 but we might change this in a future Exim release.
11951
11952 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11953 At the start of an &%if%& expansion the values of the numeric variable
11954 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11955 succeeds causes them to be reset to the substrings of that condition and they
11956 will have these values during the expansion of the success string. At the end
11957 of the &%if%& expansion, the previous values are restored. After testing a
11958 combination of conditions using &%or%&, the subsequent values of the numeric
11959 variables are those of the condition that succeeded.
11960
11961 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11962 .cindex "&%match_address%& expansion condition"
11963 See &*match_local_part*&.
11964
11965 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11966 .cindex "&%match_domain%& expansion condition"
11967 See &*match_local_part*&.
11968
11969 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11970 .cindex "&%match_ip%& expansion condition"
11971 This condition matches an IP address to a list of IP address patterns. It must
11972 be followed by two argument strings. The first (after expansion) must be an IP
11973 address or an empty string. The second (not expanded) is a restricted host
11974 list that can match only an IP address, not a host name. For example:
11975 .code
11976 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11977 .endd
11978 The specific types of host list item that are permitted in the list are:
11979
11980 .ilist
11981 An IP address, optionally with a CIDR mask.
11982 .next
11983 A single asterisk, which matches any IP address.
11984 .next
11985 An empty item, which matches only if the IP address is empty. This could be
11986 useful for testing for a locally submitted message or one from specific hosts
11987 in a single test such as
11988 . ==== As this is a nested list, any displays it contains must be indented
11989 . ==== as otherwise they are too far to the left. This comment applies to
11990 . ==== the use of xmlto plus fop. There's no problem when formatting with
11991 . ==== sdop, with or without the extra indent.
11992 .code
11993   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11994 .endd
11995 where the first item in the list is the empty string.
11996 .next
11997 The item @[] matches any of the local host's interface addresses.
11998 .next
11999 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
12000 even if &`net-`& is not specified. There is never any attempt to turn the IP
12001 address into a host name. The most common type of linear search for
12002 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
12003 masks. For example:
12004 .code
12005   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
12006 .endd
12007 It is of course possible to use other kinds of lookup, and in such a case, you
12008 do need to specify the &`net-`& prefix if you want to specify a specific
12009 address mask, for example:
12010 .code
12011   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
12012 .endd
12013 However, unless you are combining a &%match_ip%& condition with others, it is
12014 just as easy to use the fact that a lookup is itself a condition, and write:
12015 .code
12016   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
12017 .endd
12018 .endlist ilist
12019
12020 Note that <&'string2'&> is not itself subject to string expansion, unless
12021 Exim was built with the EXPAND_LISTMATCH_RHS option.
12022
12023 Consult section &<<SECThoslispatip>>& for further details of these patterns.
12024
12025 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
12026 .cindex "domain list" "in expansion condition"
12027 .cindex "address list" "in expansion condition"
12028 .cindex "local part" "list, in expansion condition"
12029 .cindex "&%match_local_part%& expansion condition"
12030 This condition, together with &%match_address%& and &%match_domain%&, make it
12031 possible to test domain, address, and local part lists within expansions. Each
12032 condition requires two arguments: an item and a list to match. A trivial
12033 example is:
12034 .code
12035 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
12036 .endd
12037 In each case, the second argument may contain any of the allowable items for a
12038 list of the appropriate type. Also, because the second argument
12039 is a standard form of list, it is possible to refer to a named list.
12040 Thus, you can use conditions like this:
12041 .code
12042 ${if match_domain{$domain}{+local_domains}{...
12043 .endd
12044 .cindex "&`+caseful`&"
12045 For address lists, the matching starts off caselessly, but the &`+caseful`&
12046 item can be used, as in all address lists, to cause subsequent items to
12047 have their local parts matched casefully. Domains are always matched
12048 caselessly.
12049
12050 Note that <&'string2'&> is not itself subject to string expansion, unless
12051 Exim was built with the EXPAND_LISTMATCH_RHS option.
12052
12053 &*Note*&: Host lists are &'not'& supported in this way. This is because
12054 hosts have two identities: a name and an IP address, and it is not clear
12055 how to specify cleanly how such a test would work. However, IP addresses can be
12056 matched using &%match_ip%&.
12057
12058 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
12059 .cindex "PAM authentication"
12060 .cindex "AUTH" "with PAM"
12061 .cindex "Solaris" "PAM support"
12062 .cindex "expansion" "PAM authentication test"
12063 .cindex "&%pam%& expansion condition"
12064 &'Pluggable Authentication Modules'&
12065 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
12066 available in the latest releases of Solaris and in some GNU/Linux
12067 distributions. The Exim support, which is intended for use in conjunction with
12068 the SMTP AUTH command, is available only if Exim is compiled with
12069 .code
12070 SUPPORT_PAM=yes
12071 .endd
12072 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
12073 in some releases of GNU/Linux &%-ldl%& is also needed.
12074
12075 The argument string is first expanded, and the result must be a
12076 colon-separated list of strings. Leading and trailing white space is ignored.
12077 The PAM module is initialized with the service name &"exim"& and the user name
12078 taken from the first item in the colon-separated data string (<&'string1'&>).
12079 The remaining items in the data string are passed over in response to requests
12080 from the authentication function. In the simple case there will only be one
12081 request, for a password, so the data consists of just two strings.
12082
12083 There can be problems if any of the strings are permitted to contain colon
12084 characters. In the usual way, these have to be doubled to avoid being taken as
12085 separators.
12086 The &%listquote%& expansion item can be used for this.
12087 For example, the configuration
12088 of a LOGIN authenticator might contain this setting:
12089 .code
12090 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
12091 .endd
12092 In some operating systems, PAM authentication can be done only from a process
12093 running as root. Since Exim is running as the Exim user when receiving
12094 messages, this means that PAM cannot be used directly in those systems.
12095 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
12096
12097
12098 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
12099 .cindex "&'pwcheck'& daemon"
12100 .cindex "Cyrus"
12101 .cindex "expansion" "&'pwcheck'& authentication test"
12102 .cindex "&%pwcheck%& expansion condition"
12103 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
12104 This is one way of making it possible for passwords to be checked by a process
12105 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
12106 deprecated. Its replacement is &'saslauthd'& (see below).
12107
12108 The pwcheck support is not included in Exim by default. You need to specify
12109 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
12110 building Exim. For example:
12111 .code
12112 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
12113 .endd
12114 You do not need to install the full Cyrus software suite in order to use
12115 the pwcheck daemon. You can compile and install just the daemon alone
12116 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
12117 access to the &_/var/pwcheck_& directory.
12118
12119 The &%pwcheck%& condition takes one argument, which must be the user name and
12120 password, separated by a colon. For example, in a LOGIN authenticator
12121 configuration, you might have this:
12122 .code
12123 server_condition = ${if pwcheck{$auth1:$auth2}}
12124 .endd
12125 Again, for a PLAIN authenticator configuration, this would be:
12126 .code
12127 server_condition = ${if pwcheck{$auth2:$auth3}}
12128 .endd
12129 .vitem &*queue_running*&
12130 .cindex "queue runner" "detecting when delivering from"
12131 .cindex "expansion" "queue runner test"
12132 .cindex "&%queue_running%& expansion condition"
12133 This condition, which has no data, is true during delivery attempts that are
12134 initiated by queue runner processes, and false otherwise.
12135
12136
12137 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12138 .cindex "Radius"
12139 .cindex "expansion" "Radius authentication"
12140 .cindex "&%radius%& expansion condition"
12141 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12142 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12143 the Radius client configuration file in order to build Exim with Radius
12144 support.
12145
12146 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12147 library, using the original API. If you are using release 0.4.0 or later of
12148 this library, you need to set
12149 .code
12150 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12151 .endd
12152 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12153 &%libradius%& library that comes with FreeBSD. To do this, set
12154 .code
12155 RADIUS_LIB_TYPE=RADLIB
12156 .endd
12157 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12158 You may also have to supply a suitable setting in EXTRALIBS so that the
12159 Radius library can be found when Exim is linked.
12160
12161 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12162 Radius client library, which calls the Radius server. The condition is true if
12163 the authentication is successful. For example:
12164 .code
12165 server_condition = ${if radius{<arguments>}}
12166 .endd
12167
12168
12169 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12170         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12171 .cindex "&'saslauthd'& daemon"
12172 .cindex "Cyrus"
12173 .cindex "expansion" "&'saslauthd'& authentication test"
12174 .cindex "&%saslauthd%& expansion condition"
12175 This condition supports user authentication using the Cyrus &'saslauthd'&
12176 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12177 Using this daemon is one way of making it possible for passwords to be checked
12178 by a process that is not running as root.
12179
12180 The saslauthd support is not included in Exim by default. You need to specify
12181 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12182 building Exim. For example:
12183 .code
12184 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12185 .endd
12186 You do not need to install the full Cyrus software suite in order to use
12187 the saslauthd daemon. You can compile and install just the daemon alone
12188 from the Cyrus SASL library.
12189
12190 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12191 two are mandatory. For example:
12192 .code
12193 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12194 .endd
12195 The service and the realm are optional (which is why the arguments are enclosed
12196 in their own set of braces). For details of the meaning of the service and
12197 realm, and how to run the daemon, consult the Cyrus documentation.
12198 .endlist vlist
12199
12200
12201
12202 .section "Combining expansion conditions" "SECID84"
12203 .cindex "expansion" "combining conditions"
12204 Several conditions can be tested at once by combining them using the &%and%&
12205 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12206 conditions on their own, and precede their lists of sub-conditions. Each
12207 sub-condition must be enclosed in braces within the overall braces that contain
12208 the list. No repetition of &%if%& is used.
12209
12210
12211 .vlist
12212 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12213 .cindex "&""or""& expansion condition"
12214 .cindex "expansion" "&""or""& of conditions"
12215 The sub-conditions are evaluated from left to right. The condition is true if
12216 any one of the sub-conditions is true.
12217 For example,
12218 .code
12219 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12220 .endd
12221 When a true sub-condition is found, the following ones are parsed but not
12222 evaluated. If there are several &"match"& sub-conditions the values of the
12223 numeric variables afterwards are taken from the first one that succeeds.
12224
12225 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12226 .cindex "&""and""& expansion condition"
12227 .cindex "expansion" "&""and""& of conditions"
12228 The sub-conditions are evaluated from left to right. The condition is true if
12229 all of the sub-conditions are true. If there are several &"match"&
12230 sub-conditions, the values of the numeric variables afterwards are taken from
12231 the last one. When a false sub-condition is found, the following ones are
12232 parsed but not evaluated.
12233 .endlist
12234 .ecindex IIDexpcond
12235
12236
12237
12238
12239 .section "Expansion variables" "SECTexpvar"
12240 .cindex "expansion" "variables, list of"
12241 This section contains an alphabetical list of all the expansion variables. Some
12242 of them are available only when Exim is compiled with specific options such as
12243 support for TLS or the content scanning extension.
12244
12245 .vlist
12246 .vitem "&$0$&, &$1$&, etc"
12247 .cindex "numerical variables (&$1$& &$2$& etc)"
12248 When a &%match%& expansion condition succeeds, these variables contain the
12249 captured substrings identified by the regular expression during subsequent
12250 processing of the success string of the containing &%if%& expansion item.
12251 In the expansion condition case
12252 they do not retain their values afterwards; in fact, their previous
12253 values are restored at the end of processing an &%if%& item. The numerical
12254 variables may also be set externally by some other matching process which
12255 precedes the expansion of the string. For example, the commands available in
12256 Exim filter files include an &%if%& command with its own regular expression
12257 matching condition.
12258
12259 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12260 Within an acl condition, expansion condition or expansion item
12261 any arguments are copied to these variables,
12262 any unused variables being made empty.
12263
12264 .vitem "&$acl_c...$&"
12265 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12266 can be given any name that starts with &$acl_c$& and is at least six characters
12267 long, but the sixth character must be either a digit or an underscore. For
12268 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12269 variables persist throughout the lifetime of an SMTP connection. They can be
12270 used to pass information between ACLs and between different invocations of the
12271 same ACL. When a message is received, the values of these variables are saved
12272 with the message, and can be accessed by filters, routers, and transports
12273 during subsequent delivery.
12274
12275 .vitem "&$acl_m...$&"
12276 These variables are like the &$acl_c...$& variables, except that their values
12277 are reset after a message has been received. Thus, if several messages are
12278 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12279 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12280 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12281 message is received, the values of these variables are saved with the message,
12282 and can be accessed by filters, routers, and transports during subsequent
12283 delivery.
12284
12285 .vitem &$acl_narg$&
12286 Within an acl condition, expansion condition or expansion item
12287 this variable has the number of arguments.
12288
12289 .vitem &$acl_verify_message$&
12290 .vindex "&$acl_verify_message$&"
12291 After an address verification has failed, this variable contains the failure
12292 message. It retains its value for use in subsequent modifiers. The message can
12293 be preserved by coding like this:
12294 .code
12295 warn !verify = sender
12296      set acl_m0 = $acl_verify_message
12297 .endd
12298 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12299 &%log_message%& modifiers, to include information about the verification
12300 failure.
12301
12302 .vitem &$address_data$&
12303 .vindex "&$address_data$&"
12304 This variable is set by means of the &%address_data%& option in routers. The
12305 value then remains with the address while it is processed by subsequent routers
12306 and eventually a transport. If the transport is handling multiple addresses,
12307 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12308 for more details. &*Note*&: The contents of &$address_data$& are visible in
12309 user filter files.
12310
12311 If &$address_data$& is set when the routers are called from an ACL to verify
12312 a recipient address, the final value is still in the variable for subsequent
12313 conditions and modifiers of the ACL statement. If routing the address caused it
12314 to be redirected to just one address, the child address is also routed as part
12315 of the verification, and in this case the final value of &$address_data$& is
12316 from the child's routing.
12317
12318 If &$address_data$& is set when the routers are called from an ACL to verify a
12319 sender address, the final value is also preserved, but this time in
12320 &$sender_address_data$&, to distinguish it from data from a recipient
12321 address.
12322
12323 In both cases (recipient and sender verification), the value does not persist
12324 after the end of the current ACL statement. If you want to preserve
12325 these values for longer, you can save them in ACL variables.
12326
12327 .vitem &$address_file$&
12328 .vindex "&$address_file$&"
12329 When, as a result of aliasing, forwarding, or filtering, a message is directed
12330 to a specific file, this variable holds the name of the file when the transport
12331 is running. At other times, the variable is empty. For example, using the
12332 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12333 .code
12334 /home/r2d2/savemail
12335 .endd
12336 then when the &(address_file)& transport is running, &$address_file$&
12337 contains the text string &`/home/r2d2/savemail`&.
12338 .cindex "Sieve filter" "value of &$address_file$&"
12339 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12340 then up to the transport configuration to generate an appropriate absolute path
12341 to the relevant file.
12342
12343 .vitem &$address_pipe$&
12344 .vindex "&$address_pipe$&"
12345 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12346 this variable holds the pipe command when the transport is running.
12347
12348 .vitem "&$auth1$& &-- &$auth4$&"
12349 .vindex "&$auth1$&, &$auth2$&, etc"
12350 These variables are used in SMTP authenticators (see chapters
12351 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12352
12353 .vitem &$authenticated_id$&
12354 .cindex "authentication" "id"
12355 .vindex "&$authenticated_id$&"
12356 When a server successfully authenticates a client it may be configured to
12357 preserve some of the authentication information in the variable
12358 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12359 user/password authenticator configuration might preserve the user name for use
12360 in the routers. Note that this is not the same information that is saved in
12361 &$sender_host_authenticated$&.
12362
12363 When a message is submitted locally (that is, not over a TCP connection)
12364 the value of &$authenticated_id$& is normally the login name of the calling
12365 process. However, a trusted user can override this by means of the &%-oMai%&
12366 command line option.
12367 This second case also sets up information used by the
12368 &$authresults$& expansion item.
12369
12370 .vitem &$authenticated_fail_id$&
12371 .cindex "authentication" "fail" "id"
12372 .vindex "&$authenticated_fail_id$&"
12373 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12374 will contain the failed authentication id. If more than one authentication
12375 id is attempted, it will contain only the last one. The variable is
12376 available for processing in the ACL's, generally the quit or notquit ACL.
12377 A message to a local recipient could still be accepted without requiring
12378 authentication, which means this variable could also be visible in all of
12379 the ACL's as well.
12380
12381
12382 .vitem &$authenticated_sender$&
12383 .cindex "sender" "authenticated"
12384 .cindex "authentication" "sender"
12385 .cindex "AUTH" "on MAIL command"
12386 .vindex "&$authenticated_sender$&"
12387 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12388 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12389 described in section &<<SECTauthparamail>>&. Unless the data is the string
12390 &"<>"&, it is set as the authenticated sender of the message, and the value is
12391 available during delivery in the &$authenticated_sender$& variable. If the
12392 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12393
12394 .vindex "&$qualify_domain$&"
12395 When a message is submitted locally (that is, not over a TCP connection), the
12396 value of &$authenticated_sender$& is an address constructed from the login
12397 name of the calling process and &$qualify_domain$&, except that a trusted user
12398 can override this by means of the &%-oMas%& command line option.
12399
12400
12401 .vitem &$authentication_failed$&
12402 .cindex "authentication" "failure"
12403 .vindex "&$authentication_failed$&"
12404 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12405 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12406 possible to distinguish between &"did not try to authenticate"&
12407 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12408 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12409 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12410 negative response to an AUTH command, including (for example) an attempt to use
12411 an undefined mechanism.
12412
12413 .vitem &$av_failed$&
12414 .cindex "content scanning" "AV scanner failure"
12415 This variable is available when Exim is compiled with the content-scanning
12416 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12417 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12418 the ACL malware condition.
12419
12420 .vitem &$body_linecount$&
12421 .cindex "message body" "line count"
12422 .cindex "body of message" "line count"
12423 .vindex "&$body_linecount$&"
12424 When a message is being received or delivered, this variable contains the
12425 number of lines in the message's body. See also &$message_linecount$&.
12426
12427 .vitem &$body_zerocount$&
12428 .cindex "message body" "binary zero count"
12429 .cindex "body of message" "binary zero count"
12430 .cindex "binary zero" "in message body"
12431 .vindex "&$body_zerocount$&"
12432 When a message is being received or delivered, this variable contains the
12433 number of binary zero bytes (ASCII NULs) in the message's body.
12434
12435 .vitem &$bounce_recipient$&
12436 .vindex "&$bounce_recipient$&"
12437 This is set to the recipient address of a bounce message while Exim is creating
12438 it. It is useful if a customized bounce message text file is in use (see
12439 chapter &<<CHAPemsgcust>>&).
12440
12441 .vitem &$bounce_return_size_limit$&
12442 .vindex "&$bounce_return_size_limit$&"
12443 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12444 up to a multiple of 1000. It is useful when a customized error message text
12445 file is in use (see chapter &<<CHAPemsgcust>>&).
12446
12447 .vitem &$caller_gid$&
12448 .cindex "gid (group id)" "caller"
12449 .vindex "&$caller_gid$&"
12450 The real group id under which the process that called Exim was running. This is
12451 not the same as the group id of the originator of a message (see
12452 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12453 incarnation normally contains the Exim gid.
12454
12455 .vitem &$caller_uid$&
12456 .cindex "uid (user id)" "caller"
12457 .vindex "&$caller_uid$&"
12458 The real user id under which the process that called Exim was running. This is
12459 not the same as the user id of the originator of a message (see
12460 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12461 incarnation normally contains the Exim uid.
12462
12463 .vitem &$callout_address$&
12464 .vindex "&$callout_address$&"
12465 After a callout for verification, spamd or malware daemon service, the
12466 address that was connected to.
12467
12468 .vitem &$compile_number$&
12469 .vindex "&$compile_number$&"
12470 The building process for Exim keeps a count of the number
12471 of times it has been compiled. This serves to distinguish different
12472 compilations of the same version of Exim.
12473
12474 .vitem &$config_dir$&
12475 .vindex "&$config_dir$&"
12476 The directory name of the main configuration file. That is, the content of
12477 &$config_file$& with the last component stripped. The value does not
12478 contain the trailing slash. If &$config_file$& does not contain a slash,
12479 &$config_dir$& is ".".
12480
12481 .vitem &$config_file$&
12482 .vindex "&$config_file$&"
12483 The name of the main configuration file Exim is using.
12484
12485 .vitem &$dkim_verify_status$&
12486 Results of DKIM verification.
12487 For details see section &<<SECDKIMVFY>>&.
12488
12489 .vitem &$dkim_cur_signer$& &&&
12490        &$dkim_verify_reason$& &&&
12491        &$dkim_domain$& &&&
12492        &$dkim_identity$& &&&
12493        &$dkim_selector$& &&&
12494        &$dkim_algo$& &&&
12495        &$dkim_canon_body$& &&&
12496        &$dkim_canon_headers$& &&&
12497        &$dkim_copiedheaders$& &&&
12498        &$dkim_bodylength$& &&&
12499        &$dkim_created$& &&&
12500        &$dkim_expires$& &&&
12501        &$dkim_headernames$& &&&
12502        &$dkim_key_testing$& &&&
12503        &$dkim_key_nosubdomains$& &&&
12504        &$dkim_key_srvtype$& &&&
12505        &$dkim_key_granularity$& &&&
12506        &$dkim_key_notes$& &&&
12507        &$dkim_key_length$&
12508 These variables are only available within the DKIM ACL.
12509 For details see section &<<SECDKIMVFY>>&.
12510
12511 .vitem &$dkim_signers$&
12512 .vindex &$dkim_signers$&
12513 When a message has been received this variable contains
12514 a colon-separated list of signer domains and identities for the message.
12515 For details see section &<<SECDKIMVFY>>&.
12516
12517 .vitem &$dmarc_domain_policy$& &&&
12518        &$dmarc_status$& &&&
12519        &$dmarc_status_text$& &&&
12520        &$dmarc_used_domains$&
12521 Results of DMARC verification.
12522 For details see section &<<SECDMARC>>&.
12523
12524 .vitem &$dnslist_domain$& &&&
12525        &$dnslist_matched$& &&&
12526        &$dnslist_text$& &&&
12527        &$dnslist_value$&
12528 .vindex "&$dnslist_domain$&"
12529 .vindex "&$dnslist_matched$&"
12530 .vindex "&$dnslist_text$&"
12531 .vindex "&$dnslist_value$&"
12532 .cindex "black list (DNS)"
12533 When a DNS (black) list lookup succeeds, these variables are set to contain
12534 the following data from the lookup: the list's domain name, the key that was
12535 looked up, the contents of any associated TXT record, and the value from the
12536 main A record. See section &<<SECID204>>& for more details.
12537
12538 .vitem &$domain$&
12539 .vindex "&$domain$&"
12540 When an address is being routed, or delivered on its own, this variable
12541 contains the domain. Uppercase letters in the domain are converted into lower
12542 case for &$domain$&.
12543
12544 Global address rewriting happens when a message is received, so the value of
12545 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12546 is set during user filtering, but not during system filtering, because a
12547 message may have many recipients and the system filter is called just once.
12548
12549 When more than one address is being delivered at once (for example, several
12550 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12551 have the same domain. Transports can be restricted to handling only one domain
12552 at a time if the value of &$domain$& is required at transport time &-- this is
12553 the default for local transports. For further details of the environment in
12554 which local transports are run, see chapter &<<CHAPenvironment>>&.
12555
12556 .oindex "&%delay_warning_condition%&"
12557 At the end of a delivery, if all deferred addresses have the same domain, it is
12558 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12559
12560 The &$domain$& variable is also used in some other circumstances:
12561
12562 .ilist
12563 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12564 the recipient address. The domain of the &'sender'& address is in
12565 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12566 normally set during the running of the MAIL ACL. However, if the sender address
12567 is verified with a callout during the MAIL ACL, the sender domain is placed in
12568 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12569 the &(smtp)& transport.
12570
12571 .next
12572 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12573 &$domain$& contains the domain portion of the address that is being rewritten;
12574 it can be used in the expansion of the replacement address, for example, to
12575 rewrite domains by file lookup.
12576
12577 .next
12578 With one important exception, whenever a domain list is being scanned,
12579 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12580 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12581 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12582 that, in a RCPT ACL, the sender domain list can be dependent on the
12583 recipient domain (which is what is in &$domain$& at this time).
12584
12585 .next
12586 .cindex "ETRN" "value of &$domain$&"
12587 .oindex "&%smtp_etrn_command%&"
12588 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12589 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12590 .endlist
12591
12592 .cindex "tainted data"
12593 If the origin of the data is an incoming message,
12594 the result of expanding this variable is tainted and may not
12595 be further expanded or used as a filename.
12596 When an untainted version is needed, one should be obtained from
12597 looking up the value in a local (therefore trusted) database.
12598 Often &$domain_data$& is usable in this role.
12599
12600
12601 .vitem &$domain_data$&
12602 .vindex "&$domain_data$&"
12603 When the &%domains%& condition on a router
12604 .new
12605 or an ACL
12606 matches a domain
12607 against a list, the match value is copied to &$domain_data$&.
12608 This is an enhancement over previous versions of Exim, when it only
12609 applied to the data read by a lookup.
12610 For details on match values see section &<<SECTlistresults>>& et. al.
12611 .wen
12612
12613 If the router routes the
12614 address to a transport, the value is available in that transport. If the
12615 transport is handling multiple addresses, the value from the first address is
12616 used.
12617
12618 &$domain_data$& set in an ACL is available during
12619 the rest of the ACL statement.
12620
12621 .vitem &$exim_gid$&
12622 .vindex "&$exim_gid$&"
12623 This variable contains the numerical value of the Exim group id.
12624
12625 .vitem &$exim_path$&
12626 .vindex "&$exim_path$&"
12627 This variable contains the path to the Exim binary.
12628
12629 .vitem &$exim_uid$&
12630 .vindex "&$exim_uid$&"
12631 This variable contains the numerical value of the Exim user id.
12632
12633 .vitem &$exim_version$&
12634 .vindex "&$exim_version$&"
12635 This variable contains the version string of the Exim build.
12636 The first character is a major version number, currently 4.
12637 Then after a dot, the next group of digits is a minor version number.
12638 There may be other characters following the minor version.
12639 This value may be overridden by the &%exim_version%& main config option.
12640
12641 .vitem &$header_$&<&'name'&>
12642 This is not strictly an expansion variable. It is expansion syntax for
12643 inserting the message header line with the given name. Note that the name must
12644 be terminated by colon or white space, because it may contain a wide variety of
12645 characters. Note also that braces must &'not'& be used.
12646 See the full description in section &<<SECTexpansionitems>>& above.
12647
12648 .vitem &$headers_added$&
12649 .vindex "&$headers_added$&"
12650 Within an ACL this variable contains the headers added so far by
12651 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12652 The headers are a newline-separated list.
12653
12654 .vitem &$home$&
12655 .vindex "&$home$&"
12656 When the &%check_local_user%& option is set for a router, the user's home
12657 directory is placed in &$home$& when the check succeeds. In particular, this
12658 means it is set during the running of users' filter files. A router may also
12659 explicitly set a home directory for use by a transport; this can be overridden
12660 by a setting on the transport itself.
12661
12662 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12663 of the environment variable HOME, which is subject to the
12664 &%keep_environment%& and &%add_environment%& main config options.
12665
12666 .vitem &$host$&
12667 .vindex "&$host$&"
12668 If a router assigns an address to a transport (any transport), and passes a
12669 list of hosts with the address, the value of &$host$& when the transport starts
12670 to run is the name of the first host on the list. Note that this applies both
12671 to local and remote transports.
12672
12673 .cindex "transport" "filter"
12674 .cindex "filter" "transport filter"
12675 For the &(smtp)& transport, if there is more than one host, the value of
12676 &$host$& changes as the transport works its way through the list. In
12677 particular, when the &(smtp)& transport is expanding its options for encryption
12678 using TLS, or for specifying a transport filter (see chapter
12679 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12680 is connected.
12681
12682 When used in the client part of an authenticator configuration (see chapter
12683 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12684 client is connected.
12685
12686
12687 .vitem &$host_address$&
12688 .vindex "&$host_address$&"
12689 This variable is set to the remote host's IP address whenever &$host$& is set
12690 for a remote connection. It is also set to the IP address that is being checked
12691 when the &%ignore_target_hosts%& option is being processed.
12692
12693 .vitem &$host_data$&
12694 .vindex "&$host_data$&"
12695 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12696 result of the lookup is made available in the &$host_data$& variable. This
12697 allows you, for example, to do things like this:
12698 .code
12699 deny  hosts = net-lsearch;/some/file
12700       message = $host_data
12701 .endd
12702 .vitem &$host_lookup_deferred$&
12703 .cindex "host name" "lookup, failure of"
12704 .vindex "&$host_lookup_deferred$&"
12705 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12706 message comes from a remote host and there is an attempt to look up the host's
12707 name from its IP address, and the attempt is not successful, one of these
12708 variables is set to &"1"&.
12709
12710 .ilist
12711 If the lookup receives a definite negative response (for example, a DNS lookup
12712 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12713
12714 .next
12715 If there is any kind of problem during the lookup, such that Exim cannot
12716 tell whether or not the host name is defined (for example, a timeout for a DNS
12717 lookup), &$host_lookup_deferred$& is set to &"1"&.
12718 .endlist ilist
12719
12720 Looking up a host's name from its IP address consists of more than just a
12721 single reverse lookup. Exim checks that a forward lookup of at least one of the
12722 names it receives from a reverse lookup yields the original IP address. If this
12723 is not the case, Exim does not accept the looked up name(s), and
12724 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12725 IP address (for example, the existence of a PTR record in the DNS) is not
12726 sufficient on its own for the success of a host name lookup. If the reverse
12727 lookup succeeds, but there is a lookup problem such as a timeout when checking
12728 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12729 &"1"&. See also &$sender_host_name$&.
12730
12731 .cindex authentication "expansion item"
12732 Performing these checks sets up information used by the
12733 &%authresults%& expansion item.
12734
12735
12736 .vitem &$host_lookup_failed$&
12737 .vindex "&$host_lookup_failed$&"
12738 See &$host_lookup_deferred$&.
12739
12740 .vitem &$host_port$&
12741 .vindex "&$host_port$&"
12742 This variable is set to the remote host's TCP port whenever &$host$& is set
12743 for an outbound connection.
12744
12745 .vitem &$initial_cwd$&
12746 .vindex "&$initial_cwd$&
12747 This variable contains the full path name of the initial working
12748 directory of the current Exim process. This may differ from the current
12749 working directory, as Exim changes this to "/" during early startup, and
12750 to &$spool_directory$& later.
12751
12752 .vitem &$inode$&
12753 .vindex "&$inode$&"
12754 The only time this variable is set is while expanding the &%directory_file%&
12755 option in the &(appendfile)& transport. The variable contains the inode number
12756 of the temporary file which is about to be renamed. It can be used to construct
12757 a unique name for the file.
12758
12759 .vitem &$interface_address$&
12760 .vindex "&$interface_address$&"
12761 This is an obsolete name for &$received_ip_address$&.
12762
12763 .vitem &$interface_port$&
12764 .vindex "&$interface_port$&"
12765 This is an obsolete name for &$received_port$&.
12766
12767 .vitem &$item$&
12768 .vindex "&$item$&"
12769 This variable is used during the expansion of &*forall*& and &*forany*&
12770 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12771 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12772 empty.
12773
12774 .vitem &$ldap_dn$&
12775 .vindex "&$ldap_dn$&"
12776 This variable, which is available only when Exim is compiled with LDAP support,
12777 contains the DN from the last entry in the most recently successful LDAP
12778 lookup.
12779
12780 .vitem &$load_average$&
12781 .vindex "&$load_average$&"
12782 This variable contains the system load average, multiplied by 1000 so that it
12783 is an integer. For example, if the load average is 0.21, the value of the
12784 variable is 210. The value is recomputed every time the variable is referenced.
12785
12786 .vitem &$local_part$&
12787 .vindex "&$local_part$&"
12788 When an address is being routed, or delivered on its own, this
12789 variable contains the local part. When a number of addresses are being
12790 delivered together (for example, multiple RCPT commands in an SMTP
12791 session), &$local_part$& is not set.
12792
12793 Global address rewriting happens when a message is received, so the value of
12794 &$local_part$& during routing and delivery is the value after rewriting.
12795 &$local_part$& is set during user filtering, but not during system filtering,
12796 because a message may have many recipients and the system filter is called just
12797 once.
12798
12799 .cindex "tainted data"
12800 If the origin of the data is an incoming message,
12801 the result of expanding this variable is tainted and
12802 may not be further expanded or used as a filename.
12803
12804 &*Warning*&: the content of this variable is usually provided by a potential
12805 attacker.
12806 Consider carefully the implications of using it unvalidated as a name
12807 for file access.
12808 This presents issues for users' &_.forward_& and filter files.
12809 For traditional full user accounts, use &%check_local_users%& and the
12810 &$local_part_data$& variable rather than this one.
12811 For virtual users, store a suitable pathname component in the database
12812 which is used for account name validation, and use that retrieved value
12813 rather than this variable.
12814 Often &$local_part_data$& is usable in this role.
12815 If needed, use a router &%address_data%& or &%set%& option for
12816 the retrieved data.
12817
12818 When a message is being delivered to a file, pipe, or autoreply transport as a
12819 result of aliasing or forwarding, &$local_part$& is set to the local part of
12820 the parent address, not to the filename or command (see &$address_file$& and
12821 &$address_pipe$&).
12822
12823 When an ACL is running for a RCPT command, &$local_part$& contains the
12824 local part of the recipient address.
12825
12826 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12827 &$local_part$& contains the local part of the address that is being rewritten;
12828 it can be used in the expansion of the replacement address, for example.
12829
12830 In all cases, all quoting is removed from the local part. For example, for both
12831 the addresses
12832 .code
12833 "abc:xyz"@test.example
12834 abc\:xyz@test.example
12835 .endd
12836 the value of &$local_part$& is
12837 .code
12838 abc:xyz
12839 .endd
12840 If you use &$local_part$& to create another address, you should always wrap it
12841 inside a quoting operator. For example, in a &(redirect)& router you could
12842 have:
12843 .code
12844 data = ${quote_local_part:$local_part}@new.domain.example
12845 .endd
12846 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12847 to process local parts in a case-dependent manner in a router, you can set the
12848 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12849
12850 .vitem &$local_part_data$&
12851 .vindex "&$local_part_data$&"
12852 When the &%local_parts%& condition on a router or ACL
12853 matches a local part list
12854 .new
12855 the match value is copied to &$local_part_data$&.
12856 This is an enhancement over previous versions of Exim, when it only
12857 applied to the data read by a lookup.
12858 For details on match values see section &<<SECTlistresults>>& et. al.
12859 .wen
12860
12861 The &%check_local_user%& router option also sets this variable.
12862
12863 .vindex &$local_part_prefix$& &&&
12864         &$local_part_prefix_v$& &&&
12865         &$local_part_suffix$& &&&
12866         &$local_part_suffix_v$&
12867 .cindex affix variables
12868 If a local part prefix or suffix has been recognized, it is not included in the
12869 value of &$local_part$& during routing and subsequent delivery. The values of
12870 any prefix or suffix are in &$local_part_prefix$& and
12871 &$local_part_suffix$&, respectively.
12872 .cindex "tainted data"
12873 If the specification did not include a wildcard then
12874 the affix variable value is not tainted.
12875
12876 If the affix specification included a wildcard then the portion of
12877 the affix matched by the wildcard is in
12878 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12879 and both the whole and varying values are tainted.
12880
12881 .vitem &$local_scan_data$&
12882 .vindex "&$local_scan_data$&"
12883 This variable contains the text returned by the &[local_scan()]& function when
12884 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12885
12886 .vitem &$local_user_gid$&
12887 .vindex "&$local_user_gid$&"
12888 See &$local_user_uid$&.
12889
12890 .vitem &$local_user_uid$&
12891 .vindex "&$local_user_uid$&"
12892 This variable and &$local_user_gid$& are set to the uid and gid after the
12893 &%check_local_user%& router precondition succeeds. This means that their values
12894 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12895 and &%condition%&), for the &%address_data%& expansion, and for any
12896 router-specific expansions. At all other times, the values in these variables
12897 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12898
12899 .vitem &$localhost_number$&
12900 .vindex "&$localhost_number$&"
12901 This contains the expanded value of the
12902 &%localhost_number%& option. The expansion happens after the main options have
12903 been read.
12904
12905 .vitem &$log_inodes$&
12906 .vindex "&$log_inodes$&"
12907 The number of free inodes in the disk partition where Exim's
12908 log files are being written. The value is recalculated whenever the variable is
12909 referenced. If the relevant file system does not have the concept of inodes,
12910 the value of is -1. See also the &%check_log_inodes%& option.
12911
12912 .vitem &$log_space$&
12913 .vindex "&$log_space$&"
12914 The amount of free space (as a number of kilobytes) in the disk
12915 partition where Exim's log files are being written. The value is recalculated
12916 whenever the variable is referenced. If the operating system does not have the
12917 ability to find the amount of free space (only true for experimental systems),
12918 the space value is -1. See also the &%check_log_space%& option.
12919
12920
12921 .vitem &$lookup_dnssec_authenticated$&
12922 .vindex "&$lookup_dnssec_authenticated$&"
12923 This variable is set after a DNS lookup done by
12924 a dnsdb lookup expansion, dnslookup router or smtp transport.
12925 .cindex "DNS" "DNSSEC"
12926 It will be empty if &(DNSSEC)& was not requested,
12927 &"no"& if the result was not labelled as authenticated data
12928 and &"yes"& if it was.
12929 Results that are labelled as authoritative answer that match
12930 the &%dns_trust_aa%& configuration variable count also
12931 as authenticated data.
12932
12933 .vitem &$mailstore_basename$&
12934 .vindex "&$mailstore_basename$&"
12935 This variable is set only when doing deliveries in &"mailstore"& format in the
12936 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12937 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12938 contains the basename of the files that are being written, that is, the name
12939 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12940 variable is empty.
12941
12942 .vitem &$malware_name$&
12943 .vindex "&$malware_name$&"
12944 This variable is available when Exim is compiled with the
12945 content-scanning extension. It is set to the name of the virus that was found
12946 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12947
12948 .vitem &$max_received_linelength$&
12949 .vindex "&$max_received_linelength$&"
12950 .cindex "maximum" "line length"
12951 .cindex "line length" "maximum"
12952 This variable contains the number of bytes in the longest line that was
12953 received as part of the message, not counting the line termination
12954 character(s).
12955 It is not valid if the &%spool_files_wireformat%& option is used.
12956
12957 .vitem &$message_age$&
12958 .cindex "message" "age of"
12959 .vindex "&$message_age$&"
12960 This variable is set at the start of a delivery attempt to contain the number
12961 of seconds since the message was received. It does not change during a single
12962 delivery attempt.
12963
12964 .vitem &$message_body$&
12965 .cindex "body of message" "expansion variable"
12966 .cindex "message body" "in expansion"
12967 .cindex "binary zero" "in message body"
12968 .vindex "&$message_body$&"
12969 .oindex "&%message_body_visible%&"
12970 This variable contains the initial portion of a message's body while it is
12971 being delivered, and is intended mainly for use in filter files. The maximum
12972 number of characters of the body that are put into the variable is set by the
12973 &%message_body_visible%& configuration option; the default is 500.
12974
12975 .oindex "&%message_body_newlines%&"
12976 By default, newlines are converted into spaces in &$message_body$&, to make it
12977 easier to search for phrases that might be split over a line break. However,
12978 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12979 zeros are always converted into spaces.
12980
12981 .vitem &$message_body_end$&
12982 .cindex "body of message" "expansion variable"
12983 .cindex "message body" "in expansion"
12984 .vindex "&$message_body_end$&"
12985 This variable contains the final portion of a message's
12986 body while it is being delivered. The format and maximum size are as for
12987 &$message_body$&.
12988
12989 .vitem &$message_body_size$&
12990 .cindex "body of message" "size"
12991 .cindex "message body" "size"
12992 .vindex "&$message_body_size$&"
12993 When a message is being delivered, this variable contains the size of the body
12994 in bytes. The count starts from the character after the blank line that
12995 separates the body from the header. Newlines are included in the count. See
12996 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12997
12998 If the spool file is wireformat
12999 (see the &%spool_files_wireformat%& main option)
13000 the CRLF line-terminators are included in the count.
13001
13002 .vitem &$message_exim_id$&
13003 .vindex "&$message_exim_id$&"
13004 When a message is being received or delivered, this variable contains the
13005 unique message id that is generated and used by Exim to identify the message.
13006 An id is not created for a message until after its header has been successfully
13007 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
13008 line; it is the local id that Exim assigns to the message, for example:
13009 &`1BXTIK-0001yO-VA`&.
13010
13011 .vitem &$message_headers$&
13012 .vindex &$message_headers$&
13013 This variable contains a concatenation of all the header lines when a message
13014 is being processed, except for lines added by routers or transports. The header
13015 lines are separated by newline characters. Their contents are decoded in the
13016 same way as a header line that is inserted by &%bheader%&.
13017
13018 .vitem &$message_headers_raw$&
13019 .vindex &$message_headers_raw$&
13020 This variable is like &$message_headers$& except that no processing of the
13021 contents of header lines is done.
13022
13023 .vitem &$message_id$&
13024 This is an old name for &$message_exim_id$&. It is now deprecated.
13025
13026 .vitem &$message_linecount$&
13027 .vindex "&$message_linecount$&"
13028 This variable contains the total number of lines in the header and body of the
13029 message. Compare &$body_linecount$&, which is the count for the body only.
13030 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
13031 number of lines received. Before delivery happens (that is, before filters,
13032 routers, and transports run) the count is increased to include the
13033 &'Received:'& header line that Exim standardly adds, and also any other header
13034 lines that are added by ACLs. The blank line that separates the message header
13035 from the body is not counted.
13036
13037 As with the special case of &$message_size$&, during the expansion of the
13038 appendfile transport's maildir_tag option in maildir format, the value of
13039 &$message_linecount$& is the precise size of the number of newlines in the
13040 file that has been written (minus one for the blank line between the
13041 header and the body).
13042
13043 Here is an example of the use of this variable in a DATA ACL:
13044 .code
13045 deny condition = \
13046       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
13047      message   = Too many lines in message header
13048 .endd
13049 In the MAIL and RCPT ACLs, the value is zero because at that stage the
13050 message has not yet been received.
13051
13052 This variable is not valid if the &%spool_files_wireformat%& option is used.
13053
13054 .vitem &$message_size$&
13055 .cindex "size" "of message"
13056 .cindex "message" "size"
13057 .vindex "&$message_size$&"
13058 When a message is being processed, this variable contains its size in bytes. In
13059 most cases, the size includes those headers that were received with the
13060 message, but not those (such as &'Envelope-to:'&) that are added to individual
13061 deliveries as they are written. However, there is one special case: during the
13062 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
13063 doing a delivery in maildir format, the value of &$message_size$& is the
13064 precise size of the file that has been written. See also
13065 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
13066
13067 .cindex "RCPT" "value of &$message_size$&"
13068 While running a per message ACL (mail/rcpt/predata), &$message_size$&
13069 contains the size supplied on the MAIL command, or -1 if no size was given. The
13070 value may not, of course, be truthful.
13071
13072 .vitem &$mime_$&&'xxx'&
13073 A number of variables whose names start with &$mime$& are
13074 available when Exim is compiled with the content-scanning extension. For
13075 details, see section &<<SECTscanmimepart>>&.
13076
13077 .vitem "&$n0$& &-- &$n9$&"
13078 These variables are counters that can be incremented by means
13079 of the &%add%& command in filter files.
13080
13081 .vitem &$original_domain$&
13082 .vindex "&$domain$&"
13083 .vindex "&$original_domain$&"
13084 When a top-level address is being processed for delivery, this contains the
13085 same value as &$domain$&. However, if a &"child"& address (for example,
13086 generated by an alias, forward, or filter file) is being processed, this
13087 variable contains the domain of the original address (lower cased). This
13088 differs from &$parent_domain$& only when there is more than one level of
13089 aliasing or forwarding. When more than one address is being delivered in a
13090 single transport run, &$original_domain$& is not set.
13091
13092 If a new address is created by means of a &%deliver%& command in a system
13093 filter, it is set up with an artificial &"parent"& address. This has the local
13094 part &'system-filter'& and the default qualify domain.
13095
13096 .vitem &$original_local_part$&
13097 .vindex "&$local_part$&"
13098 .vindex "&$original_local_part$&"
13099 When a top-level address is being processed for delivery, this contains the
13100 same value as &$local_part$&, unless a prefix or suffix was removed from the
13101 local part, because &$original_local_part$& always contains the full local
13102 part. When a &"child"& address (for example, generated by an alias, forward, or
13103 filter file) is being processed, this variable contains the full local part of
13104 the original address.
13105
13106 If the router that did the redirection processed the local part
13107 case-insensitively, the value in &$original_local_part$& is in lower case.
13108 This variable differs from &$parent_local_part$& only when there is more than
13109 one level of aliasing or forwarding. When more than one address is being
13110 delivered in a single transport run, &$original_local_part$& is not set.
13111
13112 If a new address is created by means of a &%deliver%& command in a system
13113 filter, it is set up with an artificial &"parent"& address. This has the local
13114 part &'system-filter'& and the default qualify domain.
13115
13116 .vitem &$originator_gid$&
13117 .cindex "gid (group id)" "of originating user"
13118 .cindex "sender" "gid"
13119 .vindex "&$caller_gid$&"
13120 .vindex "&$originator_gid$&"
13121 This variable contains the value of &$caller_gid$& that was set when the
13122 message was received. For messages received via the command line, this is the
13123 gid of the sending user. For messages received by SMTP over TCP/IP, this is
13124 normally the gid of the Exim user.
13125
13126 .vitem &$originator_uid$&
13127 .cindex "uid (user id)" "of originating user"
13128 .cindex "sender" "uid"
13129 .vindex "&$caller_uid$&"
13130 .vindex "&$originator_uid$&"
13131 The value of &$caller_uid$& that was set when the message was received. For
13132 messages received via the command line, this is the uid of the sending user.
13133 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
13134 user.
13135
13136 .vitem &$parent_domain$&
13137 .vindex "&$parent_domain$&"
13138 This variable is similar to &$original_domain$& (see
13139 above), except that it refers to the immediately preceding parent address.
13140
13141 .vitem &$parent_local_part$&
13142 .vindex "&$parent_local_part$&"
13143 This variable is similar to &$original_local_part$&
13144 (see above), except that it refers to the immediately preceding parent address.
13145
13146 .vitem &$pid$&
13147 .cindex "pid (process id)" "of current process"
13148 .vindex "&$pid$&"
13149 This variable contains the current process id.
13150
13151 .vitem &$pipe_addresses$&
13152 .cindex "filter" "transport filter"
13153 .cindex "transport" "filter"
13154 .vindex "&$pipe_addresses$&"
13155 This is not an expansion variable, but is mentioned here because the string
13156 &`$pipe_addresses`& is handled specially in the command specification for the
13157 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13158 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13159 It cannot be used in general expansion strings, and provokes an &"unknown
13160 variable"& error if encountered.
13161
13162 .vitem &$primary_hostname$&
13163 .vindex "&$primary_hostname$&"
13164 This variable contains the value set by &%primary_hostname%& in the
13165 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13166 a single-component name, Exim calls &[gethostbyname()]& (or
13167 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13168 qualified host name. See also &$smtp_active_hostname$&.
13169
13170
13171 .vitem &$proxy_external_address$& &&&
13172        &$proxy_external_port$& &&&
13173        &$proxy_local_address$& &&&
13174        &$proxy_local_port$& &&&
13175        &$proxy_session$&
13176 These variables are only available when built with Proxy Protocol
13177 or SOCKS5 support.
13178 For details see chapter &<<SECTproxyInbound>>&.
13179
13180 .vitem &$prdr_requested$&
13181 .cindex "PRDR" "variable for"
13182 This variable is set to &"yes"& if PRDR was requested by the client for the
13183 current message, otherwise &"no"&.
13184
13185 .vitem &$prvscheck_address$&
13186 This variable is used in conjunction with the &%prvscheck%& expansion item,
13187 which is described in sections &<<SECTexpansionitems>>& and
13188 &<<SECTverifyPRVS>>&.
13189
13190 .vitem &$prvscheck_keynum$&
13191 This variable is used in conjunction with the &%prvscheck%& expansion item,
13192 which is described in sections &<<SECTexpansionitems>>& and
13193 &<<SECTverifyPRVS>>&.
13194
13195 .vitem &$prvscheck_result$&
13196 This variable is used in conjunction with the &%prvscheck%& expansion item,
13197 which is described in sections &<<SECTexpansionitems>>& and
13198 &<<SECTverifyPRVS>>&.
13199
13200 .vitem &$qualify_domain$&
13201 .vindex "&$qualify_domain$&"
13202 The value set for the &%qualify_domain%& option in the configuration file.
13203
13204 .vitem &$qualify_recipient$&
13205 .vindex "&$qualify_recipient$&"
13206 The value set for the &%qualify_recipient%& option in the configuration file,
13207 or if not set, the value of &$qualify_domain$&.
13208
13209 .vitem &$queue_name$&
13210 .vindex &$queue_name$&
13211 .cindex "named queues" variable
13212 .cindex queues named
13213 The name of the spool queue in use; empty for the default queue.
13214
13215 .vitem &$queue_size$&
13216 .vindex "&$queue_size$&"
13217 .cindex "queue" "size of"
13218 .cindex "spool" "number of messages"
13219 This variable contains the number of messages queued.
13220 It is evaluated on demand, but no more often than once every minute.
13221 If there is no daemon notifier socket open, the value will be
13222 an empty string.
13223
13224 .vitem &$r_...$&
13225 .vindex &$r_...$&
13226 .cindex router variables
13227 Values can be placed in these variables by the &%set%& option of a router.
13228 They can be given any name that starts with &$r_$&.
13229 The values persist for the address being handled through subsequent routers
13230 and the eventual transport.
13231
13232 .vitem &$rcpt_count$&
13233 .vindex "&$rcpt_count$&"
13234 When a message is being received by SMTP, this variable contains the number of
13235 RCPT commands received for the current message. If this variable is used in a
13236 RCPT ACL, its value includes the current command.
13237
13238 .vitem &$rcpt_defer_count$&
13239 .vindex "&$rcpt_defer_count$&"
13240 .cindex "4&'xx'& responses" "count of"
13241 When a message is being received by SMTP, this variable contains the number of
13242 RCPT commands in the current message that have previously been rejected with a
13243 temporary (4&'xx'&) response.
13244
13245 .vitem &$rcpt_fail_count$&
13246 .vindex "&$rcpt_fail_count$&"
13247 When a message is being received by SMTP, this variable contains the number of
13248 RCPT commands in the current message that have previously been rejected with a
13249 permanent (5&'xx'&) response.
13250
13251 .vitem &$received_count$&
13252 .vindex "&$received_count$&"
13253 This variable contains the number of &'Received:'& header lines in the message,
13254 including the one added by Exim (so its value is always greater than zero). It
13255 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13256 delivering.
13257
13258 .vitem &$received_for$&
13259 .vindex "&$received_for$&"
13260 If there is only a single recipient address in an incoming message, this
13261 variable contains that address when the &'Received:'& header line is being
13262 built. The value is copied after recipient rewriting has happened, but before
13263 the &[local_scan()]& function is run.
13264
13265 .vitem &$received_ip_address$&
13266 .vindex "&$received_ip_address$&"
13267 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13268 variable is set to the address of the local IP interface, and &$received_port$&
13269 is set to the local port number. (The remote IP address and port are in
13270 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13271 the port value is -1 unless it has been set using the &%-oMi%& command line
13272 option.
13273
13274 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13275 could be used, for example, to make the filename for a TLS certificate depend
13276 on which interface and/or port is being used for the incoming connection. The
13277 values of &$received_ip_address$& and &$received_port$& are saved with any
13278 messages that are received, thus making these variables available at delivery
13279 time.
13280 For outbound connections see &$sending_ip_address$&.
13281
13282 .vitem &$received_port$&
13283 .vindex "&$received_port$&"
13284 See &$received_ip_address$&.
13285
13286 .vitem &$received_protocol$&
13287 .vindex "&$received_protocol$&"
13288 When a message is being processed, this variable contains the name of the
13289 protocol by which it was received. Most of the names used by Exim are defined
13290 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13291 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13292 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13293 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13294 connection and the client was successfully authenticated.
13295
13296 Exim uses the protocol name &"smtps"& for the case when encryption is
13297 automatically set up on connection without the use of STARTTLS (see
13298 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13299 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13300 where the client initially uses EHLO, sets up an encrypted connection using
13301 STARTTLS, and then uses HELO afterwards.
13302
13303 The &%-oMr%& option provides a way of specifying a custom protocol name for
13304 messages that are injected locally by trusted callers. This is commonly used to
13305 identify messages that are being re-injected after some kind of scanning.
13306
13307 .vitem &$received_time$&
13308 .vindex "&$received_time$&"
13309 This variable contains the date and time when the current message was received,
13310 as a number of seconds since the start of the Unix epoch.
13311
13312 .vitem &$recipient_data$&
13313 .vindex "&$recipient_data$&"
13314 This variable is set after an indexing lookup success in an ACL &%recipients%&
13315 condition. It contains the data from the lookup, and the value remains set
13316 until the next &%recipients%& test. Thus, you can do things like this:
13317 .display
13318 &`require recipients  = cdb*@;/some/file`&
13319 &`deny    `&&'some further test involving'& &`$recipient_data`&
13320 .endd
13321 &*Warning*&: This variable is set only when a lookup is used as an indexing
13322 method in the address list, using the semicolon syntax as in the example above.
13323 The variable is not set for a lookup that is used as part of the string
13324 expansion that all such lists undergo before being interpreted.
13325
13326 .vitem &$recipient_verify_failure$&
13327 .vindex "&$recipient_verify_failure$&"
13328 In an ACL, when a recipient verification fails, this variable contains
13329 information about the failure. It is set to one of the following words:
13330
13331 .ilist
13332 &"qualify"&: The address was unqualified (no domain), and the message
13333 was neither local nor came from an exempted host.
13334
13335 .next
13336 &"route"&: Routing failed.
13337
13338 .next
13339 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13340 or before the MAIL command (that is, on initial connection, HELO, or
13341 MAIL).
13342
13343 .next
13344 &"recipient"&: The RCPT command in a callout was rejected.
13345 .next
13346
13347 &"postmaster"&: The postmaster check in a callout was rejected.
13348 .endlist
13349
13350 The main use of this variable is expected to be to distinguish between
13351 rejections of MAIL and rejections of RCPT.
13352
13353 .vitem &$recipients$&
13354 .vindex "&$recipients$&"
13355 This variable contains a list of envelope recipients for a message. A comma and
13356 a space separate the addresses in the replacement text. However, the variable
13357 is not generally available, to prevent exposure of Bcc recipients in
13358 unprivileged users' filter files. You can use &$recipients$& only in these
13359 cases:
13360
13361 .olist
13362 In a system filter file.
13363 .next
13364 In the ACLs associated with the DATA command and with non-SMTP messages, that
13365 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13366 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13367 &%acl_not_smtp_mime%&.
13368 .next
13369 From within a &[local_scan()]& function.
13370 .endlist
13371
13372
13373 .vitem &$recipients_count$&
13374 .vindex "&$recipients_count$&"
13375 When a message is being processed, this variable contains the number of
13376 envelope recipients that came with the message. Duplicates are not excluded
13377 from the count. While a message is being received over SMTP, the number
13378 increases for each accepted recipient. It can be referenced in an ACL.
13379
13380
13381 .vitem &$regex_match_string$&
13382 .vindex "&$regex_match_string$&"
13383 This variable is set to contain the matching regular expression after a
13384 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13385
13386 .vitem "&$regex1$&, &$regex2$&, etc"
13387 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13388 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13389 these variables contain the
13390 captured substrings identified by the regular expression.
13391
13392
13393 .vitem &$reply_address$&
13394 .vindex "&$reply_address$&"
13395 When a message is being processed, this variable contains the contents of the
13396 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13397 contents of the &'From:'& header line. Apart from the removal of leading
13398 white space, the value is not processed in any way. In particular, no RFC 2047
13399 decoding or character code translation takes place.
13400
13401 .vitem &$return_path$&
13402 .vindex "&$return_path$&"
13403 When a message is being delivered, this variable contains the return path &--
13404 the sender field that will be sent as part of the envelope. It is not enclosed
13405 in <> characters. At the start of routing an address, &$return_path$& has the
13406 same value as &$sender_address$&, but if, for example, an incoming message to a
13407 mailing list has been expanded by a router which specifies a different address
13408 for bounce messages, &$return_path$& subsequently contains the new bounce
13409 address, whereas &$sender_address$& always contains the original sender address
13410 that was received with the message. In other words, &$sender_address$& contains
13411 the incoming envelope sender, and &$return_path$& contains the outgoing
13412 envelope sender.
13413
13414 .vitem &$return_size_limit$&
13415 .vindex "&$return_size_limit$&"
13416 This is an obsolete name for &$bounce_return_size_limit$&.
13417
13418 .vitem &$router_name$&
13419 .cindex "router" "name"
13420 .cindex "name" "of router"
13421 .vindex "&$router_name$&"
13422 During the running of a router this variable contains its name.
13423
13424 .vitem &$runrc$&
13425 .cindex "return code" "from &%run%& expansion"
13426 .vindex "&$runrc$&"
13427 This variable contains the return code from a command that is run by the
13428 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13429 assume the order in which option values are expanded, except for those
13430 preconditions whose order of testing is documented. Therefore, you cannot
13431 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13432 another.
13433
13434 .vitem &$self_hostname$&
13435 .oindex "&%self%&" "value of host name"
13436 .vindex "&$self_hostname$&"
13437 When an address is routed to a supposedly remote host that turns out to be the
13438 local host, what happens is controlled by the &%self%& generic router option.
13439 One of its values causes the address to be passed to another router. When this
13440 happens, &$self_hostname$& is set to the name of the local host that the
13441 original router encountered. In other circumstances its contents are null.
13442
13443 .vitem &$sender_address$&
13444 .vindex "&$sender_address$&"
13445 When a message is being processed, this variable contains the sender's address
13446 that was received in the message's envelope. The case of letters in the address
13447 is retained, in both the local part and the domain. For bounce messages, the
13448 value of this variable is the empty string. See also &$return_path$&.
13449
13450 .vitem &$sender_address_data$&
13451 .vindex "&$address_data$&"
13452 .vindex "&$sender_address_data$&"
13453 If &$address_data$& is set when the routers are called from an ACL to verify a
13454 sender address, the final value is preserved in &$sender_address_data$&, to
13455 distinguish it from data from a recipient address. The value does not persist
13456 after the end of the current ACL statement. If you want to preserve it for
13457 longer, you can save it in an ACL variable.
13458
13459 .vitem &$sender_address_domain$&
13460 .vindex "&$sender_address_domain$&"
13461 The domain portion of &$sender_address$&.
13462
13463 .vitem &$sender_address_local_part$&
13464 .vindex "&$sender_address_local_part$&"
13465 The local part portion of &$sender_address$&.
13466
13467 .vitem &$sender_data$&
13468 .vindex "&$sender_data$&"
13469 This variable is set after a lookup success in an ACL &%senders%& condition or
13470 in a router &%senders%& option. It contains the data from the lookup, and the
13471 value remains set until the next &%senders%& test. Thus, you can do things like
13472 this:
13473 .display
13474 &`require senders      = cdb*@;/some/file`&
13475 &`deny    `&&'some further test involving'& &`$sender_data`&
13476 .endd
13477 &*Warning*&: This variable is set only when a lookup is used as an indexing
13478 method in the address list, using the semicolon syntax as in the example above.
13479 The variable is not set for a lookup that is used as part of the string
13480 expansion that all such lists undergo before being interpreted.
13481
13482 .vitem &$sender_fullhost$&
13483 .vindex "&$sender_fullhost$&"
13484 When a message is received from a remote host, this variable contains the host
13485 name and IP address in a single string. It ends with the IP address in square
13486 brackets, followed by a colon and a port number if the logging of ports is
13487 enabled. The format of the rest of the string depends on whether the host
13488 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13489 looking up its IP address. (Looking up the IP address can be forced by the
13490 &%host_lookup%& option, independent of verification.) A plain host name at the
13491 start of the string is a verified host name; if this is not present,
13492 verification either failed or was not requested. A host name in parentheses is
13493 the argument of a HELO or EHLO command. This is omitted if it is identical to
13494 the verified host name or to the host's IP address in square brackets.
13495
13496 .vitem &$sender_helo_dnssec$&
13497 .vindex "&$sender_helo_dnssec$&"
13498 This boolean variable is true if a successful HELO verification was
13499 .cindex "DNS" "DNSSEC"
13500 done using DNS information the resolver library stated was authenticated data.
13501
13502 .vitem &$sender_helo_name$&
13503 .vindex "&$sender_helo_name$&"
13504 When a message is received from a remote host that has issued a HELO or EHLO
13505 command, the argument of that command is placed in this variable. It is also
13506 set if HELO or EHLO is used when a message is received using SMTP locally via
13507 the &%-bs%& or &%-bS%& options.
13508
13509 .vitem &$sender_host_address$&
13510 .vindex "&$sender_host_address$&"
13511 When a message is received from a remote host using SMTP,
13512 this variable contains that
13513 host's IP address. For locally non-SMTP submitted messages, it is empty.
13514
13515 .vitem &$sender_host_authenticated$&
13516 .vindex "&$sender_host_authenticated$&"
13517 This variable contains the name (not the public name) of the authenticator
13518 driver that successfully authenticated the client from which the message was
13519 received. It is empty if there was no successful authentication. See also
13520 &$authenticated_id$&.
13521
13522 .vitem &$sender_host_dnssec$&
13523 .vindex "&$sender_host_dnssec$&"
13524 If an attempt to populate &$sender_host_name$& has been made
13525 (by reference, &%hosts_lookup%& or
13526 otherwise) then this boolean will have been set true if, and only if, the
13527 resolver library states that both
13528 the reverse and forward DNS were authenticated data.  At all
13529 other times, this variable is false.
13530
13531 .cindex "DNS" "DNSSEC"
13532 It is likely that you will need to coerce DNSSEC support on in the resolver
13533 library, by setting:
13534 .code
13535 dns_dnssec_ok = 1
13536 .endd
13537
13538 In addition, on Linux with glibc 2.31 or newer the resolver library will
13539 default to stripping out a successful validation status.
13540 This will break a previously working Exim installation.
13541 Provided that you do trust the resolver (ie, is on localhost) you can tell
13542 glibc to pass through any successful validation with a new option in
13543 &_/etc/resolv.conf_&:
13544 .code
13545 options trust-ad
13546 .endd
13547
13548 Exim does not perform DNSSEC validation itself, instead leaving that to a
13549 validating resolver (e.g. unbound, or bind with suitable configuration).
13550
13551 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13552 mechanism in the list, then this variable will be false.
13553
13554 This requires that your system resolver library support EDNS0 (and that
13555 DNSSEC flags exist in the system headers).  If the resolver silently drops
13556 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13557 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13558
13559
13560 .vitem &$sender_host_name$&
13561 .vindex "&$sender_host_name$&"
13562 When a message is received from a remote host, this variable contains the
13563 host's name as obtained by looking up its IP address. For messages received by
13564 other means, this variable is empty.
13565
13566 .vindex "&$host_lookup_failed$&"
13567 If the host name has not previously been looked up, a reference to
13568 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13569 A looked up name is accepted only if it leads back to the original IP address
13570 via a forward lookup. If either the reverse or the forward lookup fails to find
13571 any data, or if the forward lookup does not yield the original IP address,
13572 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13573
13574 .vindex "&$host_lookup_deferred$&"
13575 However, if either of the lookups cannot be completed (for example, there is a
13576 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13577 &$host_lookup_failed$& remains set to &"0"&.
13578
13579 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13580 host name again if there is a subsequent reference to &$sender_host_name$&
13581 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13582 is set to &"1"&.
13583
13584 Exim does not automatically look up every calling host's name. If you want
13585 maximum efficiency, you should arrange your configuration so that it avoids
13586 these lookups altogether. The lookup happens only if one or more of the
13587 following are true:
13588
13589 .ilist
13590 A string containing &$sender_host_name$& is expanded.
13591 .next
13592 The calling host matches the list in &%host_lookup%&. In the default
13593 configuration, this option is set to *, so it must be changed if lookups are
13594 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13595 .next
13596 Exim needs the host name in order to test an item in a host list. The items
13597 that require this are described in sections &<<SECThoslispatnam>>& and
13598 &<<SECThoslispatnamsk>>&.
13599 .next
13600 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13601 In this case, the host name is required to compare with the name quoted in any
13602 EHLO or HELO commands that the client issues.
13603 .next
13604 The remote host issues a EHLO or HELO command that quotes one of the
13605 domains in &%helo_lookup_domains%&. The default value of this option is
13606 . ==== As this is a nested list, any displays it contains must be indented
13607 . ==== as otherwise they are too far to the left.
13608 .code
13609   helo_lookup_domains = @ : @[]
13610 .endd
13611 which causes a lookup if a remote host (incorrectly) gives the server's name or
13612 IP address in an EHLO or HELO command.
13613 .endlist
13614
13615
13616 .vitem &$sender_host_port$&
13617 .vindex "&$sender_host_port$&"
13618 When a message is received from a remote host, this variable contains the port
13619 number that was used on the remote host.
13620
13621 .vitem &$sender_ident$&
13622 .vindex "&$sender_ident$&"
13623 When a message is received from a remote host, this variable contains the
13624 identification received in response to an RFC 1413 request. When a message has
13625 been received locally, this variable contains the login name of the user that
13626 called Exim.
13627
13628 .vitem &$sender_rate_$&&'xxx'&
13629 A number of variables whose names begin &$sender_rate_$& are set as part of the
13630 &%ratelimit%& ACL condition. Details are given in section
13631 &<<SECTratelimiting>>&.
13632
13633 .vitem &$sender_rcvhost$&
13634 .cindex "DNS" "reverse lookup"
13635 .cindex "reverse DNS lookup"
13636 .vindex "&$sender_rcvhost$&"
13637 This is provided specifically for use in &'Received:'& headers. It starts with
13638 either the verified host name (as obtained from a reverse DNS lookup) or, if
13639 there is no verified host name, the IP address in square brackets. After that
13640 there may be text in parentheses. When the first item is a verified host name,
13641 the first thing in the parentheses is the IP address in square brackets,
13642 followed by a colon and a port number if port logging is enabled. When the
13643 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13644 the parentheses.
13645
13646 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13647 was used and its argument was not identical to the real host name or IP
13648 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13649 all three items are present in the parentheses, a newline and tab are inserted
13650 into the string, to improve the formatting of the &'Received:'& header.
13651
13652 .vitem &$sender_verify_failure$&
13653 .vindex "&$sender_verify_failure$&"
13654 In an ACL, when a sender verification fails, this variable contains information
13655 about the failure. The details are the same as for
13656 &$recipient_verify_failure$&.
13657
13658 .vitem &$sending_ip_address$&
13659 .vindex "&$sending_ip_address$&"
13660 This variable is set whenever an outgoing SMTP connection to another host has
13661 been set up. It contains the IP address of the local interface that is being
13662 used. This is useful if a host that has more than one IP address wants to take
13663 on different personalities depending on which one is being used. For incoming
13664 connections, see &$received_ip_address$&.
13665
13666 .vitem &$sending_port$&
13667 .vindex "&$sending_port$&"
13668 This variable is set whenever an outgoing SMTP connection to another host has
13669 been set up. It contains the local port that is being used. For incoming
13670 connections, see &$received_port$&.
13671
13672 .vitem &$smtp_active_hostname$&
13673 .vindex "&$smtp_active_hostname$&"
13674 During an incoming SMTP session, this variable contains the value of the active
13675 host name, as specified by the &%smtp_active_hostname%& option. The value of
13676 &$smtp_active_hostname$& is saved with any message that is received, so its
13677 value can be consulted during routing and delivery.
13678
13679 .vitem &$smtp_command$&
13680 .vindex "&$smtp_command$&"
13681 During the processing of an incoming SMTP command, this variable contains the
13682 entire command. This makes it possible to distinguish between HELO and EHLO in
13683 the HELO ACL, and also to distinguish between commands such as these:
13684 .code
13685 MAIL FROM:<>
13686 MAIL FROM: <>
13687 .endd
13688 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13689 command, the address in &$smtp_command$& is the original address before any
13690 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13691 the address after SMTP-time rewriting.
13692
13693 .vitem &$smtp_command_argument$&
13694 .cindex "SMTP" "command, argument for"
13695 .vindex "&$smtp_command_argument$&"
13696 While an ACL is running to check an SMTP command, this variable contains the
13697 argument, that is, the text that follows the command name, with leading white
13698 space removed. Following the introduction of &$smtp_command$&, this variable is
13699 somewhat redundant, but is retained for backwards compatibility.
13700
13701 .vitem &$smtp_command_history$&
13702 .cindex SMTP "command history"
13703 .vindex "&$smtp_command_history$&"
13704 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13705 received, in time-order left to right.  Only a limited number of commands
13706 are remembered.
13707
13708 .vitem &$smtp_count_at_connection_start$&
13709 .vindex "&$smtp_count_at_connection_start$&"
13710 This variable is set greater than zero only in processes spawned by the Exim
13711 daemon for handling incoming SMTP connections. The name is deliberately long,
13712 in order to emphasize what the contents are. When the daemon accepts a new
13713 connection, it increments this variable. A copy of the variable is passed to
13714 the child process that handles the connection, but its value is fixed, and
13715 never changes. It is only an approximation of how many incoming connections
13716 there actually are, because many other connections may come and go while a
13717 single connection is being processed. When a child process terminates, the
13718 daemon decrements its copy of the variable.
13719
13720 .vitem "&$sn0$& &-- &$sn9$&"
13721 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13722 that were current at the end of the system filter file. This allows a system
13723 filter file to set values that can be tested in users' filter files. For
13724 example, a system filter could set a value indicating how likely it is that a
13725 message is junk mail.
13726
13727 .vitem &$spam_score$& &&&
13728        &$spam_score_int$& &&&
13729        &$spam_bar$& &&&
13730        &$spam_report$& &&&
13731        &$spam_action$&
13732 A number of variables whose names start with &$spam$& are available when Exim
13733 is compiled with the content-scanning extension. For details, see section
13734 &<<SECTscanspamass>>&.
13735
13736 .vitem &$spf_header_comment$& &&&
13737        &$spf_received$& &&&
13738        &$spf_result$& &&&
13739        &$spf_result_guessed$& &&&
13740        &$spf_smtp_comment$&
13741 These variables are only available if Exim is built with SPF support.
13742 For details see section &<<SECSPF>>&.
13743
13744 .vitem &$spool_directory$&
13745 .vindex "&$spool_directory$&"
13746 The name of Exim's spool directory.
13747
13748 .vitem &$spool_inodes$&
13749 .vindex "&$spool_inodes$&"
13750 The number of free inodes in the disk partition where Exim's spool files are
13751 being written. The value is recalculated whenever the variable is referenced.
13752 If the relevant file system does not have the concept of inodes, the value of
13753 is -1. See also the &%check_spool_inodes%& option.
13754
13755 .vitem &$spool_space$&
13756 .vindex "&$spool_space$&"
13757 The amount of free space (as a number of kilobytes) in the disk partition where
13758 Exim's spool files are being written. The value is recalculated whenever the
13759 variable is referenced. If the operating system does not have the ability to
13760 find the amount of free space (only true for experimental systems), the space
13761 value is -1. For example, to check in an ACL that there is at least 50
13762 megabytes free on the spool, you could write:
13763 .code
13764 condition = ${if > {$spool_space}{50000}}
13765 .endd
13766 See also the &%check_spool_space%& option.
13767
13768
13769 .vitem &$thisaddress$&
13770 .vindex "&$thisaddress$&"
13771 This variable is set only during the processing of the &%foranyaddress%&
13772 command in a filter file. Its use is explained in the description of that
13773 command, which can be found in the separate document entitled &'Exim's
13774 interfaces to mail filtering'&.
13775
13776 .vitem &$tls_in_bits$&
13777 .vindex "&$tls_in_bits$&"
13778 Contains an approximation of the TLS cipher's bit-strength
13779 on the inbound connection; the meaning of
13780 this depends upon the TLS implementation used.
13781 If TLS has not been negotiated, the value will be 0.
13782 The value of this is automatically fed into the Cyrus SASL authenticator
13783 when acting as a server, to specify the "external SSF" (a SASL term).
13784
13785 The deprecated &$tls_bits$& variable refers to the inbound side
13786 except when used in the context of an outbound SMTP delivery, when it refers to
13787 the outbound.
13788
13789 .vitem &$tls_out_bits$&
13790 .vindex "&$tls_out_bits$&"
13791 Contains an approximation of the TLS cipher's bit-strength
13792 on an outbound SMTP connection; the meaning of
13793 this depends upon the TLS implementation used.
13794 If TLS has not been negotiated, the value will be 0.
13795
13796 .vitem &$tls_in_ourcert$&
13797 .vindex "&$tls_in_ourcert$&"
13798 .cindex certificate variables
13799 This variable refers to the certificate presented to the peer of an
13800 inbound connection when the message was received.
13801 It is only useful as the argument of a
13802 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13803 or a &%def%& condition.
13804
13805 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13806 when a list of more than one
13807 file is used for &%tls_certificate%&, this variable is not reliable.
13808 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13809
13810 .vitem &$tls_in_peercert$&
13811 .vindex "&$tls_in_peercert$&"
13812 This variable refers to the certificate presented by the peer of an
13813 inbound connection when the message was received.
13814 It is only useful as the argument of a
13815 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13816 or a &%def%& condition.
13817 If certificate verification fails it may refer to a failing chain element
13818 which is not the leaf.
13819
13820 .vitem &$tls_out_ourcert$&
13821 .vindex "&$tls_out_ourcert$&"
13822 This variable refers to the certificate presented to the peer of an
13823 outbound connection.  It is only useful as the argument of a
13824 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13825 or a &%def%& condition.
13826
13827 .vitem &$tls_out_peercert$&
13828 .vindex "&$tls_out_peercert$&"
13829 This variable refers to the certificate presented by the peer of an
13830 outbound connection.  It is only useful as the argument of a
13831 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13832 or a &%def%& condition.
13833 If certificate verification fails it may refer to a failing chain element
13834 which is not the leaf.
13835
13836 .vitem &$tls_in_certificate_verified$&
13837 .vindex "&$tls_in_certificate_verified$&"
13838 This variable is set to &"1"& if a TLS certificate was verified when the
13839 message was received, and &"0"& otherwise.
13840
13841 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13842 except when used in the context of an outbound SMTP delivery, when it refers to
13843 the outbound.
13844
13845 .vitem &$tls_out_certificate_verified$&
13846 .vindex "&$tls_out_certificate_verified$&"
13847 This variable is set to &"1"& if a TLS certificate was verified when an
13848 outbound SMTP connection was made,
13849 and &"0"& otherwise.
13850
13851 .vitem &$tls_in_cipher$&
13852 .vindex "&$tls_in_cipher$&"
13853 .vindex "&$tls_cipher$&"
13854 When a message is received from a remote host over an encrypted SMTP
13855 connection, this variable is set to the cipher suite that was negotiated, for
13856 example DES-CBC3-SHA. In other circumstances, in particular, for message
13857 received over unencrypted connections, the variable is empty. Testing
13858 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13859 non-encrypted connections during ACL processing.
13860
13861 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13862 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13863 becomes the same as &$tls_out_cipher$&.
13864
13865 .vitem &$tls_in_cipher_std$&
13866 .vindex "&$tls_in_cipher_std$&"
13867 As above, but returning the RFC standard name for the cipher suite.
13868
13869 .vitem &$tls_out_cipher$&
13870 .vindex "&$tls_out_cipher$&"
13871 This variable is
13872 cleared before any outgoing SMTP connection is made,
13873 and then set to the outgoing cipher suite if one is negotiated. See chapter
13874 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13875 details of the &(smtp)& transport.
13876
13877 .vitem &$tls_out_cipher_std$&
13878 .vindex "&$tls_out_cipher_std$&"
13879 As above, but returning the RFC standard name for the cipher suite.
13880
13881 .vitem &$tls_out_dane$&
13882 .vindex &$tls_out_dane$&
13883 DANE active status.  See section &<<SECDANE>>&.
13884
13885 .vitem &$tls_in_ocsp$&
13886 .vindex "&$tls_in_ocsp$&"
13887 When a message is received from a remote client connection
13888 the result of any OCSP request from the client is encoded in this variable:
13889 .code
13890 0 OCSP proof was not requested (default value)
13891 1 No response to request
13892 2 Response not verified
13893 3 Verification failed
13894 4 Verification succeeded
13895 .endd
13896
13897 .vitem &$tls_out_ocsp$&
13898 .vindex "&$tls_out_ocsp$&"
13899 When a message is sent to a remote host connection
13900 the result of any OCSP request made is encoded in this variable.
13901 See &$tls_in_ocsp$& for values.
13902
13903 .vitem &$tls_in_peerdn$&
13904 .vindex "&$tls_in_peerdn$&"
13905 .vindex "&$tls_peerdn$&"
13906 .cindex certificate "extracting fields"
13907 When a message is received from a remote host over an encrypted SMTP
13908 connection, and Exim is configured to request a certificate from the client,
13909 the value of the Distinguished Name of the certificate is made available in the
13910 &$tls_in_peerdn$& during subsequent processing.
13911 If certificate verification fails it may refer to a failing chain element
13912 which is not the leaf.
13913
13914 The deprecated &$tls_peerdn$& variable refers to the inbound side
13915 except when used in the context of an outbound SMTP delivery, when it refers to
13916 the outbound.
13917
13918 .vitem &$tls_out_peerdn$&
13919 .vindex "&$tls_out_peerdn$&"
13920 When a message is being delivered to a remote host over an encrypted SMTP
13921 connection, and Exim is configured to request a certificate from the server,
13922 the value of the Distinguished Name of the certificate is made available in the
13923 &$tls_out_peerdn$& during subsequent processing.
13924 If certificate verification fails it may refer to a failing chain element
13925 which is not the leaf.
13926
13927
13928 .new
13929 .vitem &$tls_in_resumption$& &&&
13930        &$tls_out_resumption$&
13931 .vindex &$tls_in_resumption$&
13932 .vindex &$tls_out_resumption$&
13933 .cindex TLS resumption
13934 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13935 .wen
13936
13937
13938 .vitem &$tls_in_sni$&
13939 .vindex "&$tls_in_sni$&"
13940 .vindex "&$tls_sni$&"
13941 .cindex "TLS" "Server Name Indication"
13942 .cindex "TLS" SNI
13943 .cindex SNI "observability on server"
13944 When a TLS session is being established, if the client sends the Server
13945 Name Indication extension, the value will be placed in this variable.
13946 If the variable appears in &%tls_certificate%& then this option and
13947 some others, described in &<<SECTtlssni>>&,
13948 will be re-expanded early in the TLS session, to permit
13949 a different certificate to be presented (and optionally a different key to be
13950 used) to the client, based upon the value of the SNI extension.
13951
13952 The deprecated &$tls_sni$& variable refers to the inbound side
13953 except when used in the context of an outbound SMTP delivery, when it refers to
13954 the outbound.
13955
13956 .vitem &$tls_out_sni$&
13957 .vindex "&$tls_out_sni$&"
13958 .cindex "TLS" "Server Name Indication"
13959 .cindex "TLS" SNI
13960 .cindex SNI "observability in client"
13961 During outbound
13962 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13963 the transport.
13964
13965 .vitem &$tls_out_tlsa_usage$&
13966 .vindex &$tls_out_tlsa_usage$&
13967 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13968
13969 .vitem &$tls_in_ver$&
13970 .vindex "&$tls_in_ver$&"
13971 When a message is received from a remote host over an encrypted SMTP connection
13972 this variable is set to the protocol version, eg &'TLS1.2'&.
13973
13974 .vitem &$tls_out_ver$&
13975 .vindex "&$tls_out_ver$&"
13976 When a message is being delivered to a remote host over an encrypted SMTP connection
13977 this variable is set to the protocol version.
13978
13979
13980 .vitem &$tod_bsdinbox$&
13981 .vindex "&$tod_bsdinbox$&"
13982 The time of day and the date, in the format required for BSD-style mailbox
13983 files, for example: Thu Oct 17 17:14:09 1995.
13984
13985 .vitem &$tod_epoch$&
13986 .vindex "&$tod_epoch$&"
13987 The time and date as a number of seconds since the start of the Unix epoch.
13988
13989 .vitem &$tod_epoch_l$&
13990 .vindex "&$tod_epoch_l$&"
13991 The time and date as a number of microseconds since the start of the Unix epoch.
13992
13993 .vitem &$tod_full$&
13994 .vindex "&$tod_full$&"
13995 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13996 +0100. The timezone is always given as a numerical offset from UTC, with
13997 positive values used for timezones that are ahead (east) of UTC, and negative
13998 values for those that are behind (west).
13999
14000 .vitem &$tod_log$&
14001 .vindex "&$tod_log$&"
14002 The time and date in the format used for writing Exim's log files, for example:
14003 1995-10-12 15:32:29, but without a timezone.
14004
14005 .vitem &$tod_logfile$&
14006 .vindex "&$tod_logfile$&"
14007 This variable contains the date in the format yyyymmdd. This is the format that
14008 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
14009 flag.
14010
14011 .vitem &$tod_zone$&
14012 .vindex "&$tod_zone$&"
14013 This variable contains the numerical value of the local timezone, for example:
14014 -0500.
14015
14016 .vitem &$tod_zulu$&
14017 .vindex "&$tod_zulu$&"
14018 This variable contains the UTC date and time in &"Zulu"& format, as specified
14019 by ISO 8601, for example: 20030221154023Z.
14020
14021 .vitem &$transport_name$&
14022 .cindex "transport" "name"
14023 .cindex "name" "of transport"
14024 .vindex "&$transport_name$&"
14025 During the running of a transport, this variable contains its name.
14026
14027 .vitem &$value$&
14028 .vindex "&$value$&"
14029 This variable contains the result of an expansion lookup, extraction operation,
14030 or external command, as described above. It is also used during a
14031 &*reduce*& expansion.
14032
14033 .vitem &$verify_mode$&
14034 .vindex "&$verify_mode$&"
14035 While a router or transport is being run in verify mode or for cutthrough delivery,
14036 contains "S" for sender-verification or "R" for recipient-verification.
14037 Otherwise, empty.
14038
14039 .vitem &$version_number$&
14040 .vindex "&$version_number$&"
14041 The version number of Exim. Same as &$exim_version$&, may be overridden
14042 by the &%exim_version%& main config option.
14043
14044 .vitem &$warn_message_delay$&
14045 .vindex "&$warn_message_delay$&"
14046 This variable is set only during the creation of a message warning about a
14047 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14048
14049 .vitem &$warn_message_recipients$&
14050 .vindex "&$warn_message_recipients$&"
14051 This variable is set only during the creation of a message warning about a
14052 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
14053 .endlist
14054 .ecindex IIDstrexp
14055
14056
14057
14058 . ////////////////////////////////////////////////////////////////////////////
14059 . ////////////////////////////////////////////////////////////////////////////
14060
14061 .chapter "Embedded Perl" "CHAPperl"
14062 .scindex IIDperl "Perl" "calling from Exim"
14063 Exim can be built to include an embedded Perl interpreter. When this is done,
14064 Perl subroutines can be called as part of the string expansion process. To make
14065 use of the Perl support, you need version 5.004 or later of Perl installed on
14066 your system. To include the embedded interpreter in the Exim binary, include
14067 the line
14068 .code
14069 EXIM_PERL = perl.o
14070 .endd
14071 in your &_Local/Makefile_& and then build Exim in the normal way.
14072
14073
14074 .section "Setting up so Perl can be used" "SECID85"
14075 .oindex "&%perl_startup%&"
14076 Access to Perl subroutines is via a global configuration option called
14077 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
14078 no &%perl_startup%& option in the Exim configuration file then no Perl
14079 interpreter is started and there is almost no overhead for Exim (since none of
14080 the Perl library will be paged in unless used). If there is a &%perl_startup%&
14081 option then the associated value is taken to be Perl code which is executed in
14082 a newly created Perl interpreter.
14083
14084 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
14085 need backslashes before any characters to escape special meanings. The option
14086 should usually be something like
14087 .code
14088 perl_startup = do '/etc/exim.pl'
14089 .endd
14090 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
14091 use from Exim. Exim can be configured either to start up a Perl interpreter as
14092 soon as it is entered, or to wait until the first time it is needed. Starting
14093 the interpreter at the beginning ensures that it is done while Exim still has
14094 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
14095 fact used in a particular run. Also, note that this does not mean that Exim is
14096 necessarily running as root when Perl is called at a later time. By default,
14097 the interpreter is started only when it is needed, but this can be changed in
14098 two ways:
14099
14100 .ilist
14101 .oindex "&%perl_at_start%&"
14102 Setting &%perl_at_start%& (a boolean option) in the configuration requests
14103 a startup when Exim is entered.
14104 .next
14105 The command line option &%-ps%& also requests a startup when Exim is entered,
14106 overriding the setting of &%perl_at_start%&.
14107 .endlist
14108
14109 There is also a command line option &%-pd%& (for delay) which suppresses the
14110 initial startup, even if &%perl_at_start%& is set.
14111
14112 .ilist
14113 .oindex "&%perl_taintmode%&"
14114 .cindex "Perl" "taintmode"
14115 To provide more security executing Perl code via the embedded Perl
14116 interpreter, the &%perl_taintmode%& option can be set. This enables the
14117 taint mode of the Perl interpreter. You are encouraged to set this
14118 option to a true value. To avoid breaking existing installations, it
14119 defaults to false.
14120
14121 .new
14122 &*Note*&: This is entirely separate from Exim's tainted-data tracking.
14123 .wen
14124
14125
14126 .section "Calling Perl subroutines" "SECID86"
14127 When the configuration file includes a &%perl_startup%& option you can make use
14128 of the string expansion item to call the Perl subroutines that are defined
14129 by the &%perl_startup%& code. The operator is used in any of the following
14130 forms:
14131 .code
14132 ${perl{foo}}
14133 ${perl{foo}{argument}}
14134 ${perl{foo}{argument1}{argument2} ... }
14135 .endd
14136 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
14137 arguments may be passed. Passing more than this results in an expansion failure
14138 with an error message of the form
14139 .code
14140 Too many arguments passed to Perl subroutine "foo" (max is 8)
14141 .endd
14142 The return value of the Perl subroutine is evaluated in a scalar context before
14143 it is passed back to Exim to be inserted into the expanded string. If the
14144 return value is &'undef'&, the expansion is forced to fail in the same way as
14145 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
14146 by obeying Perl's &%die%& function, the expansion fails with the error message
14147 that was passed to &%die%&.
14148
14149
14150 .section "Calling Exim functions from Perl" "SECID87"
14151 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
14152 is available to call back into Exim's string expansion function. For example,
14153 the Perl code
14154 .code
14155 my $lp = Exim::expand_string('$local_part');
14156 .endd
14157 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14158 Note those are single quotes and not double quotes to protect against
14159 &$local_part$& being interpolated as a Perl variable.
14160
14161 If the string expansion is forced to fail by a &"fail"& item, the result of
14162 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14163 expansion string, the Perl call from the original expansion string fails with
14164 an appropriate error message, in the same way as if &%die%& were used.
14165
14166 .cindex "debugging" "from embedded Perl"
14167 .cindex "log" "writing from embedded Perl"
14168 Two other Exim functions are available for use from within Perl code.
14169 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14170 debugging is enabled. If you want a newline at the end, you must supply it.
14171 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14172 timestamp. In this case, you should not supply a terminating newline.
14173
14174
14175 .section "Use of standard output and error by Perl" "SECID88"
14176 .cindex "Perl" "standard output and error"
14177 You should not write to the standard error or output streams from within your
14178 Perl code, as it is not defined how these are set up. In versions of Exim
14179 before 4.50, it is possible for the standard output or error to refer to the
14180 SMTP connection during message reception via the daemon. Writing to this stream
14181 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14182 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14183 avoided, but the output is lost.
14184
14185 .cindex "Perl" "use of &%warn%&"
14186 The Perl &%warn%& statement writes to the standard error stream by default.
14187 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14188 you have no control. When Exim starts up the Perl interpreter, it arranges for
14189 output from the &%warn%& statement to be written to the Exim main log. You can
14190 change this by including appropriate Perl magic somewhere in your Perl code.
14191 For example, to discard &%warn%& output completely, you need this:
14192 .code
14193 $SIG{__WARN__} = sub { };
14194 .endd
14195 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14196 example, the code for the subroutine is empty, so it does nothing, but you can
14197 include any Perl code that you like. The text of the &%warn%& message is passed
14198 as the first subroutine argument.
14199 .ecindex IIDperl
14200
14201
14202 . ////////////////////////////////////////////////////////////////////////////
14203 . ////////////////////////////////////////////////////////////////////////////
14204
14205 .chapter "Starting the daemon and the use of network interfaces" &&&
14206          "CHAPinterfaces" &&&
14207          "Starting the daemon"
14208 .cindex "daemon" "starting"
14209 .cindex "interface" "listening"
14210 .cindex "network interface"
14211 .cindex "interface" "network"
14212 .cindex "IP address" "for listening"
14213 .cindex "daemon" "listening IP addresses"
14214 .cindex "TCP/IP" "setting listening interfaces"
14215 .cindex "TCP/IP" "setting listening ports"
14216 A host that is connected to a TCP/IP network may have one or more physical
14217 hardware network interfaces. Each of these interfaces may be configured as one
14218 or more &"logical"& interfaces, which are the entities that a program actually
14219 works with. Each of these logical interfaces is associated with an IP address.
14220 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14221 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14222 knowledge about the host's interfaces for use in three different circumstances:
14223
14224 .olist
14225 When a listening daemon is started, Exim needs to know which interfaces
14226 and ports to listen on.
14227 .next
14228 When Exim is routing an address, it needs to know which IP addresses
14229 are associated with local interfaces. This is required for the correct
14230 processing of MX lists by removing the local host and others with the
14231 same or higher priority values. Also, Exim needs to detect cases
14232 when an address is routed to an IP address that in fact belongs to the
14233 local host. Unless the &%self%& router option or the &%allow_localhost%&
14234 option of the smtp transport is set (as appropriate), this is treated
14235 as an error situation.
14236 .next
14237 When Exim connects to a remote host, it may need to know which interface to use
14238 for the outgoing connection.
14239 .endlist
14240
14241
14242 Exim's default behaviour is likely to be appropriate in the vast majority
14243 of cases. If your host has only one interface, and you want all its IP
14244 addresses to be treated in the same way, and you are using only the
14245 standard SMTP port, you should not need to take any special action. The
14246 rest of this chapter does not apply to you.
14247
14248 In a more complicated situation you may want to listen only on certain
14249 interfaces, or on different ports, and for this reason there are a number of
14250 options that can be used to influence Exim's behaviour. The rest of this
14251 chapter describes how they operate.
14252
14253 When a message is received over TCP/IP, the interface and port that were
14254 actually used are set in &$received_ip_address$& and &$received_port$&.
14255
14256
14257
14258 .section "Starting a listening daemon" "SECID89"
14259 When a listening daemon is started (by means of the &%-bd%& command line
14260 option), the interfaces and ports on which it listens are controlled by the
14261 following options:
14262
14263 .ilist
14264 &%daemon_smtp_ports%& contains a list of default ports
14265 or service names.
14266 (For backward compatibility, this option can also be specified in the singular.)
14267 .next
14268 &%local_interfaces%& contains list of interface IP addresses on which to
14269 listen. Each item may optionally also specify a port.
14270 .endlist
14271
14272 The default list separator in both cases is a colon, but this can be changed as
14273 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14274 it is usually best to change the separator to avoid having to double all the
14275 colons. For example:
14276 .code
14277 local_interfaces = <; 127.0.0.1 ; \
14278                       192.168.23.65 ; \
14279                       ::1 ; \
14280                       3ffe:ffff:836f::fe86:a061
14281 .endd
14282 There are two different formats for specifying a port along with an IP address
14283 in &%local_interfaces%&:
14284
14285 .olist
14286 The port is added onto the address with a dot separator. For example, to listen
14287 on port 1234 on two different IP addresses:
14288 .code
14289 local_interfaces = <; 192.168.23.65.1234 ; \
14290                       3ffe:ffff:836f::fe86:a061.1234
14291 .endd
14292 .next
14293 The IP address is enclosed in square brackets, and the port is added
14294 with a colon separator, for example:
14295 .code
14296 local_interfaces = <; [192.168.23.65]:1234 ; \
14297                       [3ffe:ffff:836f::fe86:a061]:1234
14298 .endd
14299 .endlist
14300
14301 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14302 default setting contains just one port:
14303 .code
14304 daemon_smtp_ports = smtp
14305 .endd
14306 If more than one port is listed, each interface that does not have its own port
14307 specified listens on all of them. Ports that are listed in
14308 &%daemon_smtp_ports%& can be identified either by name (defined in
14309 &_/etc/services_&) or by number. However, when ports are given with individual
14310 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14311
14312
14313
14314 .section "Special IP listening addresses" "SECID90"
14315 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14316 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14317 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14318 instead of setting up separate listening sockets for each interface. The
14319 default value of &%local_interfaces%& is
14320 .code
14321 local_interfaces = 0.0.0.0
14322 .endd
14323 when Exim is built without IPv6 support; otherwise it is:
14324 .code
14325 local_interfaces = <; ::0 ; 0.0.0.0
14326 .endd
14327 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14328
14329
14330
14331 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14332 The &%-oX%& command line option can be used to override the values of
14333 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14334 instance. Another way of doing this would be to use macros and the &%-D%&
14335 option. However, &%-oX%& can be used by any admin user, whereas modification of
14336 the runtime configuration by &%-D%& is allowed only when the caller is root or
14337 exim.
14338
14339 The value of &%-oX%& is a list of items. The default colon separator can be
14340 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14341 If there are any items that do not
14342 contain dots or colons (that is, are not IP addresses), the value of
14343 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14344 items that do contain dots or colons, the value of &%local_interfaces%& is
14345 replaced by those items. Thus, for example,
14346 .code
14347 -oX 1225
14348 .endd
14349 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14350 whereas
14351 .code
14352 -oX 192.168.34.5.1125
14353 .endd
14354 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14355 (However, since &%local_interfaces%& now contains no items without ports, the
14356 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14357
14358
14359
14360 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14361 .cindex "submissions protocol"
14362 .cindex "ssmtp protocol"
14363 .cindex "smtps protocol"
14364 .cindex "SMTP" "ssmtp protocol"
14365 .cindex "SMTP" "smtps protocol"
14366 Exim supports the use of TLS-on-connect, used by mail clients in the
14367 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14368 For some years, IETF Standards Track documents only blessed the
14369 STARTTLS-based Submission service (port 587) while common practice was to support
14370 the same feature set on port 465, but using TLS-on-connect.
14371 If your installation needs to provide service to mail clients
14372 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14373 the 465 TCP ports.
14374
14375 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14376 service names, connections to those ports must first establish TLS, before
14377 proceeding to the application layer use of the SMTP protocol.
14378
14379 The common use of this option is expected to be
14380 .code
14381 tls_on_connect_ports = 465
14382 .endd
14383 per RFC 8314.
14384 There is also a command line option &%-tls-on-connect%&, which forces all ports
14385 to behave in this way when a daemon is started.
14386
14387 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14388 daemon to listen on those ports. You must still specify them in
14389 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14390 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14391 connections via the daemon.)
14392
14393
14394
14395
14396 .section "IPv6 address scopes" "SECID92"
14397 .cindex "IPv6" "address scopes"
14398 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14399 can, in principle, have the same link-local IPv6 address on different
14400 interfaces. Thus, additional information is needed, over and above the IP
14401 address, to distinguish individual interfaces. A convention of using a
14402 percent sign followed by something (often the interface name) has been
14403 adopted in some cases, leading to addresses like this:
14404 .code
14405 fe80::202:b3ff:fe03:45c1%eth0
14406 .endd
14407 To accommodate this usage, a percent sign followed by an arbitrary string is
14408 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14409 to convert a textual IPv6 address for actual use. This function recognizes the
14410 percent convention in operating systems that support it, and it processes the
14411 address appropriately. Unfortunately, some older libraries have problems with
14412 &[getaddrinfo()]&. If
14413 .code
14414 IPV6_USE_INET_PTON=yes
14415 .endd
14416 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14417 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14418 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14419 function.) Of course, this means that the additional functionality of
14420 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14421
14422 .section "Disabling IPv6" "SECID93"
14423 .cindex "IPv6" "disabling"
14424 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14425 run on a host whose kernel does not support IPv6. The binary will fall back to
14426 using IPv4, but it may waste resources looking up AAAA records, and trying to
14427 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14428 .oindex "&%disable_ipv6%&"
14429 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14430 activities take place. AAAA records are never looked up, and any IPv6 addresses
14431 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14432 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14433 to handle IPv6 literal addresses.
14434
14435 On the other hand, when IPv6 is in use, there may be times when you want to
14436 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14437 option to globally suppress the lookup of AAAA records for specified domains,
14438 and you can use the &%ignore_target_hosts%& generic router option to ignore
14439 IPv6 addresses in an individual router.
14440
14441
14442
14443 .section "Examples of starting a listening daemon" "SECID94"
14444 The default case in an IPv6 environment is
14445 .code
14446 daemon_smtp_ports = smtp
14447 local_interfaces = <; ::0 ; 0.0.0.0
14448 .endd
14449 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14450 Either one or two sockets may be used, depending on the characteristics of
14451 the TCP/IP stack. (This is complicated and messy; for more information,
14452 read the comments in the &_daemon.c_& source file.)
14453
14454 To specify listening on ports 25 and 26 on all interfaces:
14455 .code
14456 daemon_smtp_ports = 25 : 26
14457 .endd
14458 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14459 .code
14460 local_interfaces = <; ::0.25     ; ::0.26 \
14461                       0.0.0.0.25 ; 0.0.0.0.26
14462 .endd
14463 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14464 IPv4 loopback address only:
14465 .code
14466 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14467 .endd
14468 To specify listening on the default port on specific interfaces only:
14469 .code
14470 local_interfaces = 10.0.0.67 : 192.168.34.67
14471 .endd
14472 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14473
14474
14475
14476 .section "Recognizing the local host" "SECTreclocipadd"
14477 The &%local_interfaces%& option is also used when Exim needs to determine
14478 whether or not an IP address refers to the local host. That is, the IP
14479 addresses of all the interfaces on which a daemon is listening are always
14480 treated as local.
14481
14482 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14483 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14484 available interfaces from the operating system, and extracts the relevant
14485 (that is, IPv4 or IPv6) addresses to use for checking.
14486
14487 Some systems set up large numbers of virtual interfaces in order to provide
14488 many virtual web servers. In this situation, you may want to listen for
14489 email on only a few of the available interfaces, but nevertheless treat all
14490 interfaces as local when routing. You can do this by setting
14491 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14492 &"all"& wildcard values. These addresses are recognized as local, but are not
14493 used for listening. Consider this example:
14494 .code
14495 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14496                       192.168.53.235 ; \
14497                       3ffe:2101:12:1:a00:20ff:fe86:a061
14498
14499 extra_local_interfaces = <; ::0 ; 0.0.0.0
14500 .endd
14501 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14502 address, but all available interface addresses are treated as local when
14503 Exim is routing.
14504
14505 In some environments the local host name may be in an MX list, but with an IP
14506 address that is not assigned to any local interface. In other cases it may be
14507 desirable to treat other host names as if they referred to the local host. Both
14508 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14509 This contains host names rather than IP addresses. When a host is referenced
14510 during routing, either via an MX record or directly, it is treated as the local
14511 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14512 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14513
14514
14515
14516 .section "Delivering to a remote host" "SECID95"
14517 Delivery to a remote host is handled by the smtp transport. By default, it
14518 allows the system's TCP/IP functions to choose which interface to use (if
14519 there is more than one) when connecting to a remote host. However, the
14520 &%interface%& option can be set to specify which interface is used. See the
14521 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14522 details.
14523
14524
14525
14526
14527 . ////////////////////////////////////////////////////////////////////////////
14528 . ////////////////////////////////////////////////////////////////////////////
14529
14530 .chapter "Main configuration" "CHAPmainconfig"
14531 .scindex IIDconfima "configuration file" "main section"
14532 .scindex IIDmaiconf "main configuration"
14533 The first part of the runtime configuration file contains three types of item:
14534
14535 .ilist
14536 Macro definitions: These lines start with an upper case letter. See section
14537 &<<SECTmacrodefs>>& for details of macro processing.
14538 .next
14539 Named list definitions: These lines start with one of the words &"domainlist"&,
14540 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14541 section &<<SECTnamedlists>>&.
14542 .next
14543 Main configuration settings: Each setting occupies one line of the file
14544 (with possible continuations). If any setting is preceded by the word
14545 &"hide"&, the &%-bP%& command line option displays its value to admin users
14546 only. See section &<<SECTcos>>& for a description of the syntax of these option
14547 settings.
14548 .endlist
14549
14550 This chapter specifies all the main configuration options, along with their
14551 types and default values. For ease of finding a particular option, they appear
14552 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14553 are now so many options, they are first listed briefly in functional groups, as
14554 an aid to finding the name of the option you are looking for. Some options are
14555 listed in more than one group.
14556
14557 .section "Miscellaneous" "SECID96"
14558 .table2
14559 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14560 .row &%debug_store%&                 "do extra internal checks"
14561 .row &%disable_ipv6%&                "do no IPv6 processing"
14562 .row &%keep_malformed%&              "for broken files &-- should not happen"
14563 .row &%localhost_number%&            "for unique message ids in clusters"
14564 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14565 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14566 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14567 .row &%print_topbitchars%&           "top-bit characters are printing"
14568 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14569 .row &%timezone%&                    "force time zone"
14570 .endtable
14571
14572
14573 .section "Exim parameters" "SECID97"
14574 .table2
14575 .row &%exim_group%&                  "override compiled-in value"
14576 .row &%exim_path%&                   "override compiled-in value"
14577 .row &%exim_user%&                   "override compiled-in value"
14578 .row &%primary_hostname%&            "default from &[uname()]&"
14579 .row &%split_spool_directory%&       "use multiple directories"
14580 .row &%spool_directory%&             "override compiled-in value"
14581 .endtable
14582
14583
14584
14585 .section "Privilege controls" "SECID98"
14586 .table2
14587 .row &%admin_groups%&                "groups that are Exim admin users"
14588 .row &%commandline_checks_require_admin%& "require admin for various checks"
14589 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14590 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14591 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14592 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14593 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14594 .row &%never_users%&                 "do not run deliveries as these"
14595 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14596 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14597 .row &%trusted_groups%&              "groups that are trusted"
14598 .row &%trusted_users%&               "users that are trusted"
14599 .endtable
14600
14601
14602
14603 .section "Logging" "SECID99"
14604 .table2
14605 .row &%event_action%&                "custom logging"
14606 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14607 .row &%log_file_path%&               "override compiled-in value"
14608 .row &%log_selector%&                "set/unset optional logging"
14609 .row &%log_timezone%&                "add timezone to log lines"
14610 .row &%message_logs%&                "create per-message logs"
14611 .row &%preserve_message_logs%&       "after message completion"
14612 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14613 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14614 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14615 .row &%syslog_facility%&             "set syslog &""facility""& field"
14616 .row &%syslog_pid%&                  "pid in syslog lines"
14617 .row &%syslog_processname%&          "set syslog &""ident""& field"
14618 .row &%syslog_timestamp%&            "timestamp syslog lines"
14619 .row &%write_rejectlog%&             "control use of message log"
14620 .endtable
14621
14622
14623
14624 .section "Frozen messages" "SECID100"
14625 .table2
14626 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14627 .row &%freeze_tell%&                 "send message when freezing"
14628 .row &%move_frozen_messages%&        "to another directory"
14629 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14630 .endtable
14631
14632
14633
14634 .section "Data lookups" "SECID101"
14635 .table2
14636 .row &%ibase_servers%&               "InterBase servers"
14637 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14638 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14639 .row &%ldap_cert_file%&              "client cert file for LDAP"
14640 .row &%ldap_cert_key%&               "client key file for LDAP"
14641 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14642 .row &%ldap_default_servers%&        "used if no server in query"
14643 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14644 .row &%ldap_start_tls%&              "require TLS within LDAP"
14645 .row &%ldap_version%&                "set protocol version"
14646 .row &%lookup_open_max%&             "lookup files held open"
14647 .row &%mysql_servers%&               "default MySQL servers"
14648 .row &%oracle_servers%&              "Oracle servers"
14649 .row &%pgsql_servers%&               "default PostgreSQL servers"
14650 .row &%sqlite_lock_timeout%&         "as it says"
14651 .endtable
14652
14653
14654
14655 .section "Message ids" "SECID102"
14656 .table2
14657 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14658 .row &%message_id_header_text%&      "ditto"
14659 .endtable
14660
14661
14662
14663 .section "Embedded Perl Startup" "SECID103"
14664 .table2
14665 .row &%perl_at_start%&               "always start the interpreter"
14666 .row &%perl_startup%&                "code to obey when starting Perl"
14667 .row &%perl_taintmode%&              "enable taint mode in Perl"
14668 .endtable
14669
14670
14671
14672 .section "Daemon" "SECID104"
14673 .table2
14674 .row &%daemon_smtp_ports%&           "default ports"
14675 .row &%daemon_startup_retries%&      "number of times to retry"
14676 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14677 .row &%extra_local_interfaces%&      "not necessarily listened on"
14678 .row &%local_interfaces%&            "on which to listen, with optional ports"
14679 .row &%notifier_socket%&             "override compiled-in value"
14680 .row &%pid_file_path%&               "override compiled-in value"
14681 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14682 .endtable
14683
14684
14685
14686 .section "Resource control" "SECID105"
14687 .table2
14688 .row &%check_log_inodes%&            "before accepting a message"
14689 .row &%check_log_space%&             "before accepting a message"
14690 .row &%check_spool_inodes%&          "before accepting a message"
14691 .row &%check_spool_space%&           "before accepting a message"
14692 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14693 .row &%queue_only_load%&             "queue incoming if load high"
14694 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14695 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14696 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14697 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14698 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14699 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14700 .row &%smtp_accept_max_per_connection%& "messages per connection"
14701 .row &%smtp_accept_max_per_host%&    "connections from one host"
14702 .row &%smtp_accept_queue%&           "queue mail if more connections"
14703 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14704                                            connection"
14705 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14706 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14707 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14708 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14709 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14710 .endtable
14711
14712
14713
14714 .section "Policy controls" "SECID106"
14715 .table2
14716 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14717 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14718 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14719 .row &%acl_smtp_auth%&               "ACL for AUTH"
14720 .row &%acl_smtp_connect%&            "ACL for connection"
14721 .row &%acl_smtp_data%&               "ACL for DATA"
14722 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14723 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14724 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14725 .row &%acl_smtp_expn%&               "ACL for EXPN"
14726 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14727 .row &%acl_smtp_mail%&               "ACL for MAIL"
14728 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14729 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14730 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14731 .row &%acl_smtp_predata%&            "ACL for start of data"
14732 .row &%acl_smtp_quit%&               "ACL for QUIT"
14733 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14734 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14735 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14736 .row &%av_scanner%&                  "specify virus scanner"
14737 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14738                                       words""&"
14739 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14740 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14741 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14742 .row &%header_maxsize%&              "total size of message header"
14743 .row &%header_line_maxsize%&         "individual header line limit"
14744 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14745 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14746 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14747 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14748 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14749 .row &%host_lookup%&                 "host name looked up for these hosts"
14750 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14751 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14752 .row &%host_reject_connection%&      "reject connection from these hosts"
14753 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14754 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14755 .row &%message_size_limit%&          "for all messages"
14756 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14757 .row &%proxy_protocol_timeout%&      "timeout for proxy protocol negotiation"
14758 .row &%spamd_address%&               "set interface to SpamAssassin"
14759 .row &%strict_acl_vars%&             "object to unset ACL variables"
14760 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14761 .endtable
14762
14763
14764
14765 .section "Callout cache" "SECID107"
14766 .table2
14767 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14768                                          item"
14769 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14770                                          item"
14771 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14772 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14773 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14774 .endtable
14775
14776
14777
14778 .section "TLS" "SECID108"
14779 .table2
14780 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14781 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14782 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14783 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14784 .row &%tls_certificate%&             "location of server certificate"
14785 .row &%tls_crl%&                     "certificate revocation list"
14786 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14787 .row &%tls_dhparam%&                 "DH parameters for server"
14788 .row &%tls_eccurve%&                 "EC curve selection for server"
14789 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14790 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14791 .row &%tls_privatekey%&              "location of server private key"
14792 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14793 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14794 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14795 .row &%tls_verify_certificates%&     "expected client certificates"
14796 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14797 .endtable
14798
14799
14800
14801 .section "Local user handling" "SECID109"
14802 .table2
14803 .row &%finduser_retries%&            "useful in NIS environments"
14804 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14805 .row &%gecos_pattern%&               "ditto"
14806 .row &%max_username_length%&         "for systems that truncate"
14807 .row &%unknown_login%&               "used when no login name found"
14808 .row &%unknown_username%&            "ditto"
14809 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14810 .row &%uucp_from_sender%&            "ditto"
14811 .endtable
14812
14813
14814
14815 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14816 .table2
14817 .row &%header_maxsize%&              "total size of message header"
14818 .row &%header_line_maxsize%&         "individual header line limit"
14819 .row &%message_size_limit%&          "applies to all messages"
14820 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14821 .row &%received_header_text%&        "expanded to make &'Received:'&"
14822 .row &%received_headers_max%&        "for mail loop detection"
14823 .row &%recipients_max%&              "limit per message"
14824 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14825 .endtable
14826
14827
14828
14829
14830 .section "Non-SMTP incoming messages" "SECID111"
14831 .table2
14832 .row &%receive_timeout%&             "for non-SMTP messages"
14833 .endtable
14834
14835
14836
14837
14838
14839 .section "Incoming SMTP messages" "SECID112"
14840 See also the &'Policy controls'& section above.
14841
14842 .table2
14843 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14844 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14845 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14846 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14847 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14848 .row &%dmarc_history_file%&          "DMARC results log"
14849 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14850 .row &%host_lookup%&                 "host name looked up for these hosts"
14851 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14852 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14853 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14854 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14855 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14856 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14857 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14858 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14859 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14860 .row &%smtp_accept_max_per_connection%& "messages per connection"
14861 .row &%smtp_accept_max_per_host%&    "connections from one host"
14862 .row &%smtp_accept_queue%&           "queue mail if more connections"
14863 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14864                                            connection"
14865 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14866 .row &%smtp_active_hostname%&        "host name to use in messages"
14867 .row &%smtp_banner%&                 "text for welcome banner"
14868 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14869 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14870 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14871 .row &%smtp_etrn_command%&           "what to run for ETRN"
14872 .row &%smtp_etrn_serialize%&         "only one at once"
14873 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14874 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14875 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14876 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14877 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14878 .row &%smtp_receive_timeout%&        "per command or data line"
14879 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14880 .row &%smtp_return_error_details%&   "give detail on rejections"
14881 .endtable
14882
14883
14884
14885 .section "SMTP extensions" "SECID113"
14886 .table2
14887 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14888 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14889 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14890 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14891 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14892 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14893 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14894 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14895 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14896 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14897 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14898 .endtable
14899
14900
14901
14902 .section "Processing messages" "SECID114"
14903 .table2
14904 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14905 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14906 .row &%allow_utf8_domains%&          "in addresses"
14907 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14908                                       words""&"
14909 .row &%delivery_date_remove%&        "from incoming messages"
14910 .row &%envelope_to_remove%&          "from incoming messages"
14911 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14912 .row &%headers_charset%&             "default for translations"
14913 .row &%qualify_domain%&              "default for senders"
14914 .row &%qualify_recipient%&           "default for recipients"
14915 .row &%return_path_remove%&          "from incoming messages"
14916 .row &%strip_excess_angle_brackets%& "in addresses"
14917 .row &%strip_trailing_dot%&          "at end of addresses"
14918 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14919 .endtable
14920
14921
14922
14923 .section "System filter" "SECID115"
14924 .table2
14925 .row &%system_filter%&               "locate system filter"
14926 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14927                                             directory"
14928 .row &%system_filter_file_transport%& "transport for delivery to a file"
14929 .row &%system_filter_group%&         "group for filter running"
14930 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14931 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14932 .row &%system_filter_user%&          "user for filter running"
14933 .endtable
14934
14935
14936
14937 .section "Routing and delivery" "SECID116"
14938 .table2
14939 .row &%disable_ipv6%&                "do no IPv6 processing"
14940 .row &%dns_again_means_nonexist%&    "for broken domains"
14941 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14942 .row &%dns_dnssec_ok%&               "parameter for resolver"
14943 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14944 .row &%dns_retrans%&                 "parameter for resolver"
14945 .row &%dns_retry%&                   "parameter for resolver"
14946 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14947 .row &%dns_use_edns0%&               "parameter for resolver"
14948 .row &%hold_domains%&                "hold delivery for these domains"
14949 .row &%local_interfaces%&            "for routing checks"
14950 .row &%queue_domains%&               "no immediate delivery for these"
14951 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14952 .row &%queue_only%&                  "no immediate delivery at all"
14953 .row &%queue_only_file%&             "no immediate delivery if file exists"
14954 .row &%queue_only_load%&             "no immediate delivery if load is high"
14955 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14956 .row &%queue_only_override%&         "allow command line to override"
14957 .row &%queue_run_in_order%&          "order of arrival"
14958 .row &%queue_run_max%&               "of simultaneous queue runners"
14959 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14960 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14961 .row &%remote_sort_domains%&         "order of remote deliveries"
14962 .row &%retry_data_expire%&           "timeout for retry data"
14963 .row &%retry_interval_max%&          "safety net for retry rules"
14964 .endtable
14965
14966
14967
14968 .section "Bounce and warning messages" "SECID117"
14969 .table2
14970 .row &%bounce_message_file%&         "content of bounce"
14971 .row &%bounce_message_text%&         "content of bounce"
14972 .row &%bounce_return_body%&          "include body if returning message"
14973 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14974 .row &%bounce_return_message%&       "include original message in bounce"
14975 .row &%bounce_return_size_limit%&    "limit on returned message"
14976 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14977 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14978 .row &%errors_copy%&                 "copy bounce messages"
14979 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14980 .row &%delay_warning%&               "time schedule"
14981 .row &%delay_warning_condition%&     "condition for warning messages"
14982 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14983 .row &%smtp_return_error_details%&   "give detail on rejections"
14984 .row &%warn_message_file%&           "content of warning message"
14985 .endtable
14986
14987
14988
14989 .section "Alphabetical list of main options" "SECTalomo"
14990 Those options that undergo string expansion before use are marked with
14991 &dagger;.
14992
14993 .option accept_8bitmime main boolean true
14994 .cindex "8BITMIME"
14995 .cindex "8-bit characters"
14996 .cindex "log" "selectors"
14997 .cindex "log" "8BITMIME"
14998 .cindex "ESMTP extensions" 8BITMIME
14999 This option causes Exim to send 8BITMIME in its response to an SMTP
15000 EHLO command, and to accept the BODY= parameter on MAIL commands.
15001 However, though Exim is 8-bit clean, it is not a protocol converter, and it
15002 takes no steps to do anything special with messages received by this route.
15003
15004 Historically Exim kept this option off by default, but the maintainers
15005 feel that in today's Internet, this causes more problems than it solves.
15006 It now defaults to true.
15007 A more detailed analysis of the issues is provided by Dan Bernstein:
15008 .display
15009 &url(https://cr.yp.to/smtp/8bitmime.html)
15010 .endd
15011
15012 To log received 8BITMIME status use
15013 .code
15014 log_selector = +8bitmime
15015 .endd
15016
15017 .option acl_not_smtp main string&!! unset
15018 .cindex "&ACL;" "for non-SMTP messages"
15019 .cindex "non-SMTP messages" "ACLs for"
15020 This option defines the ACL that is run when a non-SMTP message has been
15021 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
15022 further details.
15023
15024 .option acl_not_smtp_mime main string&!! unset
15025 This option defines the ACL that is run for individual MIME parts of non-SMTP
15026 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
15027 SMTP messages.
15028
15029 .option acl_not_smtp_start main string&!! unset
15030 .cindex "&ACL;" "at start of non-SMTP message"
15031 .cindex "non-SMTP messages" "ACLs for"
15032 This option defines the ACL that is run before Exim starts reading a
15033 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
15034
15035 .option acl_smtp_auth main string&!! unset
15036 .cindex "&ACL;" "setting up for SMTP commands"
15037 .cindex "AUTH" "ACL for"
15038 This option defines the ACL that is run when an SMTP AUTH command is
15039 received. See chapter &<<CHAPACL>>& for further details.
15040
15041 .option acl_smtp_connect main string&!! unset
15042 .cindex "&ACL;" "on SMTP connection"
15043 This option defines the ACL that is run when an SMTP connection is received.
15044 See chapter &<<CHAPACL>>& for further details.
15045
15046 .option acl_smtp_data main string&!! unset
15047 .cindex "DATA" "ACL for"
15048 This option defines the ACL that is run after an SMTP DATA command has been
15049 processed and the message itself has been received, but before the final
15050 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15051
15052 .option acl_smtp_data_prdr main string&!! accept
15053 .cindex "PRDR" "ACL for"
15054 .cindex "DATA" "PRDR ACL for"
15055 .cindex "&ACL;" "PRDR-related"
15056 .cindex "&ACL;" "per-user data processing"
15057 This option defines the ACL that,
15058 if the PRDR feature has been negotiated,
15059 is run for each recipient after an SMTP DATA command has been
15060 processed and the message itself has been received, but before the
15061 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
15062
15063 .option acl_smtp_dkim main string&!! unset
15064 .cindex DKIM "ACL for"
15065 This option defines the ACL that is run for each DKIM signature
15066 (by default, or as specified in the dkim_verify_signers option)
15067 of a received message.
15068 See section &<<SECDKIMVFY>>& for further details.
15069
15070 .option acl_smtp_etrn main string&!! unset
15071 .cindex "ETRN" "ACL for"
15072 This option defines the ACL that is run when an SMTP ETRN command is
15073 received. See chapter &<<CHAPACL>>& for further details.
15074
15075 .option acl_smtp_expn main string&!! unset
15076 .cindex "EXPN" "ACL for"
15077 This option defines the ACL that is run when an SMTP EXPN command is
15078 received. See chapter &<<CHAPACL>>& for further details.
15079
15080 .option acl_smtp_helo main string&!! unset
15081 .cindex "EHLO" "ACL for"
15082 .cindex "HELO" "ACL for"
15083 This option defines the ACL that is run when an SMTP EHLO or HELO
15084 command is received. See chapter &<<CHAPACL>>& for further details.
15085
15086
15087 .option acl_smtp_mail main string&!! unset
15088 .cindex "MAIL" "ACL for"
15089 This option defines the ACL that is run when an SMTP MAIL command is
15090 received. See chapter &<<CHAPACL>>& for further details.
15091
15092 .option acl_smtp_mailauth main string&!! unset
15093 .cindex "AUTH" "on MAIL command"
15094 This option defines the ACL that is run when there is an AUTH parameter on
15095 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
15096 &<<CHAPSMTPAUTH>>& for details of authentication.
15097
15098 .option acl_smtp_mime main string&!! unset
15099 .cindex "MIME content scanning" "ACL for"
15100 This option is available when Exim is built with the content-scanning
15101 extension. It defines the ACL that is run for each MIME part in a message. See
15102 section &<<SECTscanmimepart>>& for details.
15103
15104 .option acl_smtp_notquit main string&!! unset
15105 .cindex "not-QUIT, ACL for"
15106 This option defines the ACL that is run when an SMTP session
15107 ends without a QUIT command being received.
15108 See chapter &<<CHAPACL>>& for further details.
15109
15110 .option acl_smtp_predata main string&!! unset
15111 This option defines the ACL that is run when an SMTP DATA command is
15112 received, before the message itself is received. See chapter &<<CHAPACL>>& for
15113 further details.
15114
15115 .option acl_smtp_quit main string&!! unset
15116 .cindex "QUIT, ACL for"
15117 This option defines the ACL that is run when an SMTP QUIT command is
15118 received. See chapter &<<CHAPACL>>& for further details.
15119
15120 .option acl_smtp_rcpt main string&!! unset
15121 .cindex "RCPT" "ACL for"
15122 This option defines the ACL that is run when an SMTP RCPT command is
15123 received. See chapter &<<CHAPACL>>& for further details.
15124
15125 .option acl_smtp_starttls main string&!! unset
15126 .cindex "STARTTLS, ACL for"
15127 This option defines the ACL that is run when an SMTP STARTTLS command is
15128 received. See chapter &<<CHAPACL>>& for further details.
15129
15130 .option acl_smtp_vrfy main string&!! unset
15131 .cindex "VRFY" "ACL for"
15132 This option defines the ACL that is run when an SMTP VRFY command is
15133 received. See chapter &<<CHAPACL>>& for further details.
15134
15135 .option add_environment main "string list" empty
15136 .cindex "environment" "set values"
15137 This option adds individual environment variables that the
15138 currently linked libraries and programs in child processes may use.
15139 Each list element should be of the form &"name=value"&.
15140
15141 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
15142
15143 .option admin_groups main "string list&!!" unset
15144 .cindex "admin user"
15145 This option is expanded just once, at the start of Exim's processing. If the
15146 current group or any of the supplementary groups of an Exim caller is in this
15147 colon-separated list, the caller has admin privileges. If all your system
15148 programmers are in a specific group, for example, you can give them all Exim
15149 admin privileges by putting that group in &%admin_groups%&. However, this does
15150 not permit them to read Exim's spool files (whose group owner is the Exim gid).
15151 To permit this, you have to add individuals to the Exim group.
15152
15153 .option allow_domain_literals main boolean false
15154 .cindex "domain literal"
15155 If this option is set, the RFC 2822 domain literal format is permitted in
15156 email addresses. The option is not set by default, because the domain literal
15157 format is not normally required these days, and few people know about it. It
15158 has, however, been exploited by mail abusers.
15159
15160 Unfortunately, it seems that some DNS black list maintainers are using this
15161 format to report black listing to postmasters. If you want to accept messages
15162 addressed to your hosts by IP address, you need to set
15163 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15164 domains (defined in the named domain list &%local_domains%& in the default
15165 configuration). This &"magic string"& matches the domain literal form of all
15166 the local host's IP addresses.
15167
15168
15169 .option allow_mx_to_ip main boolean false
15170 .cindex "MX record" "pointing to IP address"
15171 It appears that more and more DNS zone administrators are breaking the rules
15172 and putting domain names that look like IP addresses on the right hand side of
15173 MX records. Exim follows the rules and rejects this, giving an error message
15174 that explains the misconfiguration. However, some other MTAs support this
15175 practice, so to avoid &"Why can't Exim do this?"& complaints,
15176 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15177 recommended, except when you have no other choice.
15178
15179 .option allow_utf8_domains main boolean false
15180 .cindex "domain" "UTF-8 characters in"
15181 .cindex "UTF-8" "in domain name"
15182 Lots of discussion is going on about internationalized domain names. One
15183 camp is strongly in favour of just using UTF-8 characters, and it seems
15184 that at least two other MTAs permit this.
15185 This option allows Exim users to experiment if they wish.
15186
15187 If it is set true, Exim's domain parsing function allows valid
15188 UTF-8 multicharacters to appear in domain name components, in addition to
15189 letters, digits, and hyphens.
15190
15191 If Exim is built with internationalization support
15192 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15193 this option can be left as default.
15194 Without that,
15195 if you want to look up such domain names in the DNS, you must also
15196 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15197 suitable setting is:
15198 .code
15199 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15200   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15201 .endd
15202 Alternatively, you can just disable this feature by setting
15203 .code
15204 dns_check_names_pattern =
15205 .endd
15206 That is, set the option to an empty string so that no check is done.
15207
15208
15209 .option auth_advertise_hosts main "host list&!!" *
15210 .cindex "authentication" "advertising"
15211 .cindex "AUTH" "advertising"
15212 .cindex "ESMTP extensions" AUTH
15213 If any server authentication mechanisms are configured, Exim advertises them in
15214 response to an EHLO command only if the calling host matches this list.
15215 Otherwise, Exim does not advertise AUTH.
15216 Exim does not accept AUTH commands from clients to which it has not
15217 advertised the availability of AUTH. The advertising of individual
15218 authentication mechanisms can be controlled by the use of the
15219 &%server_advertise_condition%& generic authenticator option on the individual
15220 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15221
15222 Certain mail clients (for example, Netscape) require the user to provide a name
15223 and password for authentication if AUTH is advertised, even though it may
15224 not be needed (the host may accept messages from hosts on its local LAN without
15225 authentication, for example). The &%auth_advertise_hosts%& option can be used
15226 to make these clients more friendly by excluding them from the set of hosts to
15227 which Exim advertises AUTH.
15228
15229 .cindex "AUTH" "advertising when encrypted"
15230 If you want to advertise the availability of AUTH only when the connection
15231 is encrypted using TLS, you can make use of the fact that the value of this
15232 option is expanded, with a setting like this:
15233 .code
15234 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15235 .endd
15236 .vindex "&$tls_in_cipher$&"
15237 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15238 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15239 expansion is *, which matches all hosts.
15240
15241
15242 .option auto_thaw main time 0s
15243 .cindex "thawing messages"
15244 .cindex "unfreezing messages"
15245 If this option is set to a time greater than zero, a queue runner will try a
15246 new delivery attempt on any frozen message, other than a bounce message, if
15247 this much time has passed since it was frozen. This may result in the message
15248 being re-frozen if nothing has changed since the last attempt. It is a way of
15249 saying &"keep on trying, even though there are big problems"&.
15250
15251 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15252 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15253 thought to be very useful any more, and its use should probably be avoided.
15254
15255
15256 .option av_scanner main string "see below"
15257 This option is available if Exim is built with the content-scanning extension.
15258 It specifies which anti-virus scanner to use. The default value is:
15259 .code
15260 sophie:/var/run/sophie
15261 .endd
15262 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15263 before use. See section &<<SECTscanvirus>>& for further details.
15264
15265
15266 .option bi_command main string unset
15267 .oindex "&%-bi%&"
15268 This option supplies the name of a command that is run when Exim is called with
15269 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15270 just the command name, it is not a complete command line. If an argument is
15271 required, it must come from the &%-oA%& command line option.
15272
15273
15274 .option bounce_message_file main string&!! unset
15275 .cindex "bounce message" "customizing"
15276 .cindex "customizing" "bounce message"
15277 This option defines a template file containing paragraphs of text to be used
15278 for constructing bounce messages.  Details of the file's contents are given in
15279 chapter &<<CHAPemsgcust>>&.
15280 .cindex bounce_message_file "tainted data"
15281 The option is expanded to give the file path, which must be
15282 absolute and untainted.
15283 See also &%warn_message_file%&.
15284
15285
15286 .option bounce_message_text main string unset
15287 When this option is set, its contents are included in the default bounce
15288 message immediately after &"This message was created automatically by mail
15289 delivery software."& It is not used if &%bounce_message_file%& is set.
15290
15291 .option bounce_return_body main boolean true
15292 .cindex "bounce message" "including body"
15293 This option controls whether the body of an incoming message is included in a
15294 bounce message when &%bounce_return_message%& is true. The default setting
15295 causes the entire message, both header and body, to be returned (subject to the
15296 value of &%bounce_return_size_limit%&). If this option is false, only the
15297 message header is included. In the case of a non-SMTP message containing an
15298 error that is detected during reception, only those header lines preceding the
15299 point at which the error was detected are returned.
15300 .cindex "bounce message" "including original"
15301
15302 .option bounce_return_linesize_limit main integer 998
15303 .cindex "size" "of bounce lines, limit"
15304 .cindex "bounce message" "line length limit"
15305 .cindex "limit" "bounce message line length"
15306 This option sets a limit in bytes on the line length of messages
15307 that are returned to senders due to delivery problems,
15308 when &%bounce_return_message%& is true.
15309 The default value corresponds to RFC limits.
15310 If the message being returned has lines longer than this value it is
15311 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15312
15313 The option also applies to bounces returned when an error is detected
15314 during reception of a message.
15315 In this case lines from the original are truncated.
15316
15317 The option does not apply to messages generated by an &(autoreply)& transport.
15318
15319
15320 .option bounce_return_message main boolean true
15321 If this option is set false, none of the original message is included in
15322 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15323 &%bounce_return_body%&.
15324
15325
15326 .option bounce_return_size_limit main integer 100K
15327 .cindex "size" "of bounce, limit"
15328 .cindex "bounce message" "size limit"
15329 .cindex "limit" "bounce message size"
15330 This option sets a limit in bytes on the size of messages that are returned to
15331 senders as part of bounce messages when &%bounce_return_message%& is true. The
15332 limit should be less than the value of the global &%message_size_limit%& and of
15333 any &%message_size_limit%& settings on transports, to allow for the bounce text
15334 that Exim generates. If this option is set to zero there is no limit.
15335
15336 When the body of any message that is to be included in a bounce message is
15337 greater than the limit, it is truncated, and a comment pointing this out is
15338 added at the top. The actual cutoff may be greater than the value given, owing
15339 to the use of buffering for transferring the message in chunks (typically 8K in
15340 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15341 messages.
15342
15343 .option bounce_sender_authentication main string unset
15344 .cindex "bounce message" "sender authentication"
15345 .cindex "authentication" "bounce message"
15346 .cindex "AUTH" "on bounce message"
15347 This option provides an authenticated sender address that is sent with any
15348 bounce messages generated by Exim that are sent over an authenticated SMTP
15349 connection. A typical setting might be:
15350 .code
15351 bounce_sender_authentication = mailer-daemon@my.domain.example
15352 .endd
15353 which would cause bounce messages to be sent using the SMTP command:
15354 .code
15355 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15356 .endd
15357 The value of &%bounce_sender_authentication%& must always be a complete email
15358 address.
15359
15360 .option callout_domain_negative_expire main time 3h
15361 .cindex "caching" "callout timeouts"
15362 .cindex "callout" "caching timeouts"
15363 This option specifies the expiry time for negative callout cache data for a
15364 domain. See section &<<SECTcallver>>& for details of callout verification, and
15365 section &<<SECTcallvercache>>& for details of the caching.
15366
15367
15368 .option callout_domain_positive_expire main time 7d
15369 This option specifies the expiry time for positive callout cache data for a
15370 domain. See section &<<SECTcallver>>& for details of callout verification, and
15371 section &<<SECTcallvercache>>& for details of the caching.
15372
15373
15374 .option callout_negative_expire main time 2h
15375 This option specifies the expiry time for negative callout cache data for an
15376 address. See section &<<SECTcallver>>& for details of callout verification, and
15377 section &<<SECTcallvercache>>& for details of the caching.
15378
15379
15380 .option callout_positive_expire main time 24h
15381 This option specifies the expiry time for positive callout cache data for an
15382 address. See section &<<SECTcallver>>& for details of callout verification, and
15383 section &<<SECTcallvercache>>& for details of the caching.
15384
15385
15386 .option callout_random_local_part main string&!! "see below"
15387 This option defines the &"random"& local part that can be used as part of
15388 callout verification. The default value is
15389 .code
15390 $primary_hostname-$tod_epoch-testing
15391 .endd
15392 See section &<<CALLaddparcall>>& for details of how this value is used.
15393
15394
15395 .option check_log_inodes main integer 100
15396 See &%check_spool_space%& below.
15397
15398
15399 .option check_log_space main integer 10M
15400 See &%check_spool_space%& below.
15401
15402 .oindex "&%check_rfc2047_length%&"
15403 .cindex "RFC 2047" "disabling length check"
15404 .option check_rfc2047_length main boolean true
15405 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15406 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15407 word; strings to be encoded that exceed this length are supposed to use
15408 multiple encoded words. By default, Exim does not recognize encoded words that
15409 exceed the maximum length. However, it seems that some software, in violation
15410 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15411 set false, Exim recognizes encoded words of any length.
15412
15413
15414 .option check_spool_inodes main integer 100
15415 See &%check_spool_space%& below.
15416
15417
15418 .option check_spool_space main integer 10M
15419 .cindex "checking disk space"
15420 .cindex "disk space, checking"
15421 .cindex "spool directory" "checking space"
15422 The four &%check_...%& options allow for checking of disk resources before a
15423 message is accepted.
15424
15425 .vindex "&$log_inodes$&"
15426 .vindex "&$log_space$&"
15427 .vindex "&$spool_inodes$&"
15428 .vindex "&$spool_space$&"
15429 When any of these options are nonzero, they apply to all incoming messages. If you
15430 want to apply different checks to different kinds of message, you can do so by
15431 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15432 &$spool_space$& in an ACL with appropriate additional conditions.
15433
15434
15435 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15436 either value is greater than zero, for example:
15437 .code
15438 check_spool_space = 100M
15439 check_spool_inodes = 100
15440 .endd
15441 The spool partition is the one that contains the directory defined by
15442 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15443 transit.
15444
15445 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15446 files are written if either is greater than zero. These should be set only if
15447 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15448
15449 If there is less space or fewer inodes than requested, Exim refuses to accept
15450 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15451 error response to the MAIL command. If ESMTP is in use and there was a
15452 SIZE parameter on the MAIL command, its value is added to the
15453 &%check_spool_space%& value, and the check is performed even if
15454 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15455
15456 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15457 number of kilobytes (though specified in bytes).
15458 If a non-multiple of 1024 is specified, it is rounded up.
15459
15460 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15461 failure a message is written to stderr and Exim exits with a non-zero code, as
15462 it obviously cannot send an error message of any kind.
15463
15464 There is a slight performance penalty for these checks.
15465 Versions of Exim preceding 4.88 had these disabled by default;
15466 high-rate installations confident they will never run out of resources
15467 may wish to deliberately disable them.
15468
15469 .option chunking_advertise_hosts main "host list&!!" *
15470 .cindex CHUNKING advertisement
15471 .cindex "RFC 3030" "CHUNKING"
15472 .cindex "ESMTP extensions" CHUNKING
15473 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15474 these hosts.
15475 Hosts may use the BDAT command as an alternate to DATA.
15476
15477 .option commandline_checks_require_admin main boolean &`false`&
15478 .cindex "restricting access to features"
15479 This option restricts various basic checking features to require an
15480 administrative user.
15481 This affects most of the &%-b*%& options, such as &%-be%&.
15482
15483 .option debug_store main boolean &`false`&
15484 .cindex debugging "memory corruption"
15485 .cindex memory debugging
15486 This option, when true, enables extra checking in Exim's internal memory
15487 management.  For use when a memory corruption issue is being investigated,
15488 it should normally be left as default.
15489
15490 .option daemon_smtp_ports main string &`smtp`&
15491 .cindex "port" "for daemon"
15492 .cindex "TCP/IP" "setting listening ports"
15493 This option specifies one or more default SMTP ports on which the Exim daemon
15494 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15495 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15496
15497 .option daemon_startup_retries main integer 9
15498 .cindex "daemon startup, retrying"
15499 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15500 the daemon at startup when it cannot immediately bind a listening socket
15501 (typically because the socket is already in use): &%daemon_startup_retries%&
15502 defines the number of retries after the first failure, and
15503 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15504
15505 .option daemon_startup_sleep main time 30s
15506 See &%daemon_startup_retries%&.
15507
15508 .option delay_warning main "time list" 24h
15509 .cindex "warning of delay"
15510 .cindex "delay warning, specifying"
15511 .cindex "queue" "delay warning"
15512 When a message is delayed, Exim sends a warning message to the sender at
15513 intervals specified by this option. The data is a colon-separated list of times
15514 after which to send warning messages. If the value of the option is an empty
15515 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15516 message has been in the queue for longer than the last time, the last interval
15517 between the times is used to compute subsequent warning times. For example,
15518 with
15519 .code
15520 delay_warning = 4h:8h:24h
15521 .endd
15522 the first message is sent after 4 hours, the second after 8 hours, and
15523 the third one after 24 hours. After that, messages are sent every 16 hours,
15524 because that is the interval between the last two times on the list. If you set
15525 just one time, it specifies the repeat interval. For example, with:
15526 .code
15527 delay_warning = 6h
15528 .endd
15529 messages are repeated every six hours. To stop warnings after a given time, set
15530 a very large time at the end of the list. For example:
15531 .code
15532 delay_warning = 2h:12h:99d
15533 .endd
15534 Note that the option is only evaluated at the time a delivery attempt fails,
15535 which depends on retry and queue-runner configuration.
15536 Typically retries will be configured more frequently than warning messages.
15537
15538 .option delay_warning_condition main string&!! "see below"
15539 .vindex "&$domain$&"
15540 The string is expanded at the time a warning message might be sent. If all the
15541 deferred addresses have the same domain, it is set in &$domain$& during the
15542 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15543 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15544 &"false"& (the comparison being done caselessly) then the warning message is
15545 not sent. The default is:
15546 .code
15547 delay_warning_condition = ${if or {\
15548   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15549   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15550   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15551   } {no}{yes}}
15552 .endd
15553 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15554 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15555 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15556 &"auto-replied"& in an &'Auto-Submitted:'& header.
15557
15558 .option deliver_drop_privilege main boolean false
15559 .cindex "unprivileged delivery"
15560 .cindex "delivery" "unprivileged"
15561 If this option is set true, Exim drops its root privilege at the start of a
15562 delivery process, and runs as the Exim user throughout. This severely restricts
15563 the kinds of local delivery that are possible, but is viable in certain types
15564 of configuration. There is a discussion about the use of root privilege in
15565 chapter &<<CHAPsecurity>>&.
15566
15567 .option deliver_queue_load_max main fixed-point unset
15568 .cindex "load average"
15569 .cindex "queue runner" "abandoning"
15570 When this option is set, a queue run is abandoned if the system load average
15571 becomes greater than the value of the option. The option has no effect on
15572 ancient operating systems on which Exim cannot determine the load average.
15573 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15574
15575
15576 .option delivery_date_remove main boolean true
15577 .cindex "&'Delivery-date:'& header line"
15578 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15579 message when it is delivered, in exactly the same way as &'Return-path:'& is
15580 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15581 should not be present in incoming messages, and this option causes them to be
15582 removed at the time the message is received, to avoid any problems that might
15583 occur when a delivered message is subsequently sent on to some other recipient.
15584
15585 .option disable_fsync main boolean false
15586 .cindex "&[fsync()]&, disabling"
15587 This option is available only if Exim was built with the compile-time option
15588 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15589 a runtime configuration generates an &"unknown option"& error. You should not
15590 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15591 really, really, really understand what you are doing. &'No pre-compiled
15592 distributions of Exim should ever make this option available.'&
15593
15594 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15595 updated files' data to be written to disc before continuing. Unexpected events
15596 such as crashes and power outages may cause data to be lost or scrambled.
15597 Here be Dragons. &*Beware.*&
15598
15599
15600 .option disable_ipv6 main boolean false
15601 .cindex "IPv6" "disabling"
15602 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15603 activities take place. AAAA records are never looked up, and any IPv6 addresses
15604 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15605 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15606 to handle IPv6 literal addresses.
15607
15608
15609 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15610 .cindex DKIM "selecting signature algorithms"
15611 This option gives a list of hash types which are acceptable in signatures,
15612 and an order of processing.
15613 Signatures with algorithms not in the list will be ignored.
15614
15615 Acceptable values include:
15616 .code
15617 sha1
15618 sha256
15619 sha512
15620 .endd
15621
15622 Note that the acceptance of sha1 violates RFC 8301.
15623
15624 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15625 This option gives a list of key types which are acceptable in signatures,
15626 and an order of processing.
15627 Signatures with algorithms not in the list will be ignored.
15628
15629
15630 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15631 This option gives a list of key sizes which are acceptable in signatures.
15632 The list is keyed by the algorithm type for the key; the values are in bits.
15633 Signatures with keys smaller than given by this option will fail verification.
15634
15635 The default enforces the RFC 8301 minimum key size for RSA signatures.
15636
15637 .option dkim_verify_minimal main boolean false
15638 If set to true, verification of signatures will terminate after the
15639 first success.
15640
15641 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15642 .cindex DKIM "controlling calls to the ACL"
15643 This option gives a list of DKIM domains for which the DKIM ACL is run.
15644 It is expanded after the message is received; by default it runs
15645 the ACL once for each signature in the message.
15646 See section &<<SECDKIMVFY>>&.
15647
15648
15649 .option dmarc_forensic_sender main string&!! unset
15650 .option dmarc_history_file main string unset
15651 .option dmarc_tld_file main string unset
15652 .cindex DMARC "main section options"
15653 These options control DMARC processing.
15654 See section &<<SECDMARC>>& for details.
15655
15656
15657 .option dns_again_means_nonexist main "domain list&!!" unset
15658 .cindex "DNS" "&""try again""& response; overriding"
15659 DNS lookups give a &"try again"& response for the DNS errors
15660 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15661 keep trying to deliver a message, or to give repeated temporary errors to
15662 incoming mail. Sometimes the effect is caused by a badly set up name server and
15663 may persist for a long time. If a domain which exhibits this problem matches
15664 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15665 This option should be used with care. You can make it apply to reverse lookups
15666 by a setting such as this:
15667 .code
15668 dns_again_means_nonexist = *.in-addr.arpa
15669 .endd
15670 This option applies to all DNS lookups that Exim does. It also applies when the
15671 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15672 since these are most likely to be caused by DNS lookup problems. The
15673 &(dnslookup)& router has some options of its own for controlling what happens
15674 when lookups for MX or SRV records give temporary errors. These more specific
15675 options are applied after this global option.
15676
15677 .option dns_check_names_pattern main string "see below"
15678 .cindex "DNS" "pre-check of name syntax"
15679 When this option is set to a non-empty string, it causes Exim to check domain
15680 names for characters that are not allowed in host names before handing them to
15681 the DNS resolver, because some resolvers give temporary errors for names that
15682 contain unusual characters. If a domain name contains any unwanted characters,
15683 a &"not found"& result is forced, and the resolver is not called. The check is
15684 done by matching the domain name against a regular expression, which is the
15685 value of this option. The default pattern is
15686 .code
15687 dns_check_names_pattern = \
15688   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15689 .endd
15690 which permits only letters, digits, slashes, and hyphens in components, but
15691 they must start and end with a letter or digit. Slashes are not, in fact,
15692 permitted in host names, but they are found in certain NS records (which can be
15693 accessed in Exim by using a &%dnsdb%& lookup). If you set
15694 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15695 empty string.
15696
15697 .option dns_csa_search_limit main integer 5
15698 This option controls the depth of parental searching for CSA SRV records in the
15699 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15700
15701 .option dns_csa_use_reverse main boolean true
15702 This option controls whether or not an IP address, given as a CSA domain, is
15703 reversed and looked up in the reverse DNS, as described in more detail in
15704 section &<<SECTverifyCSA>>&.
15705
15706 .option dns_cname_loops main integer 1
15707 .cindex DNS "CNAME following"
15708 This option controls the following of CNAME chains, needed if the resolver does
15709 not do it internally.
15710 As of 2018 most should, and the default can be left.
15711 If you have an ancient one, a value of 10 is likely needed.
15712
15713 The default value of one CNAME-follow is needed
15714 thanks to the observed return for an MX request,
15715 given no MX presence but a CNAME to an A, of the CNAME.
15716
15717
15718 .option dns_dnssec_ok main integer -1
15719 .cindex "DNS" "resolver options"
15720 .cindex "DNS" "DNSSEC"
15721 If this option is set to a non-negative number then Exim will initialise the
15722 DNS resolver library to either use or not use DNSSEC, overriding the system
15723 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15724
15725 If the resolver library does not support DNSSEC then this option has no effect.
15726
15727 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15728 will default to stripping out a successful validation status.
15729 This will break a previously working Exim installation.
15730 Provided that you do trust the resolver (ie, is on localhost) you can tell
15731 glibc to pass through any successful validation with a new option in
15732 &_/etc/resolv.conf_&:
15733 .code
15734 options trust-ad
15735 .endd
15736
15737
15738 .option dns_ipv4_lookup main "domain list&!!" unset
15739 .cindex "IPv6" "DNS lookup for AAAA records"
15740 .cindex "DNS" "IPv6 lookup for AAAA records"
15741 .cindex DNS "IPv6 disabling"
15742 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15743 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15744 (A records) when trying to find IP addresses for hosts, unless the host's
15745 domain matches this list.
15746
15747 This is a fudge to help with name servers that give big delays or otherwise do
15748 not work for the AAAA record type. In due course, when the world's name
15749 servers have all been upgraded, there should be no need for this option.
15750 Note that all lookups, including those done for verification, are affected;
15751 this will result in verify failure for IPv6 connections or ones using names
15752 only valid for IPv6 addresses.
15753
15754
15755 .option dns_retrans main time 0s
15756 .cindex "DNS" "resolver options"
15757 .cindex timeout "dns lookup"
15758 .cindex "DNS" timeout
15759 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15760 retransmission and retry parameters for DNS lookups. Values of zero (the
15761 defaults) leave the system default settings unchanged. The first value is the
15762 time between retries, and the second is the number of retries. It isn't
15763 totally clear exactly how these settings affect the total time a DNS lookup may
15764 take. I haven't found any documentation about timeouts on DNS lookups; these
15765 parameter values are available in the external resolver interface structure,
15766 but nowhere does it seem to describe how they are used or what you might want
15767 to set in them.
15768 See also the &%slow_lookup_log%& option.
15769
15770
15771 .option dns_retry main integer 0
15772 See &%dns_retrans%& above.
15773
15774
15775 .option dns_trust_aa main "domain list&!!" unset
15776 .cindex "DNS" "resolver options"
15777 .cindex "DNS" "DNSSEC"
15778 If this option is set then lookup results marked with the AA bit
15779 (Authoritative Answer) are trusted the same way as if they were
15780 DNSSEC-verified. The authority section's name of the answer must
15781 match with this expanded domain list.
15782
15783 Use this option only if you talk directly to a resolver that is
15784 authoritative for some zones and does not set the AD (Authentic Data)
15785 bit in the answer. Some DNS servers may have an configuration option to
15786 mark the answers from their own zones as verified (they set the AD bit).
15787 Others do not have this option. It is considered as poor practice using
15788 a resolver that is an authoritative server for some zones.
15789
15790 Use this option only if you really have to (e.g. if you want
15791 to use DANE for remote delivery to a server that is listed in the DNS
15792 zones that your resolver is authoritative for).
15793
15794 If the DNS answer packet has the AA bit set and contains resource record
15795 in the answer section, the name of the first NS record appearing in the
15796 authority section is compared against the list. If the answer packet is
15797 authoritative but the answer section is empty, the name of the first SOA
15798 record in the authoritative section is used instead.
15799
15800 .cindex "DNS" "resolver options"
15801 .option dns_use_edns0 main integer -1
15802 .cindex "DNS" "resolver options"
15803 .cindex "DNS" "EDNS0"
15804 .cindex "DNS" "OpenBSD
15805 If this option is set to a non-negative number then Exim will initialise the
15806 DNS resolver library to either use or not use EDNS0 extensions, overriding
15807 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15808 on.
15809
15810 If the resolver library does not support EDNS0 then this option has no effect.
15811
15812 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15813 means that DNSSEC will not work with Exim on that platform either, unless Exim
15814 is linked against an alternative DNS client library.
15815
15816
15817 .option drop_cr main boolean false
15818 This is an obsolete option that is now a no-op. It used to affect the way Exim
15819 handled CR and LF characters in incoming messages. What happens now is
15820 described in section &<<SECTlineendings>>&.
15821
15822 .option dsn_advertise_hosts main "host list&!!" unset
15823 .cindex "bounce messages" "success"
15824 .cindex "DSN" "success"
15825 .cindex "Delivery Status Notification" "success"
15826 .cindex "ESMTP extensions" DSN
15827 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15828 and accepted from, these hosts.
15829 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15830 and RET and ORCPT options on MAIL FROM commands.
15831 A NOTIFY=SUCCESS option requests success-DSN messages.
15832 A NOTIFY= option with no argument requests that no delay or failure DSNs
15833 are sent.
15834 &*Note*&: Supplying success-DSN messages has been criticised
15835 on privacy grounds; it can leak details of internal forwarding.
15836
15837 .option dsn_from main "string&!!" "see below"
15838 .cindex "&'From:'& header line" "in bounces"
15839 .cindex "bounce messages" "&'From:'& line, specifying"
15840 This option can be used to vary the contents of &'From:'& header lines in
15841 bounces and other automatically generated messages (&"Delivery Status
15842 Notifications"& &-- hence the name of the option). The default setting is:
15843 .code
15844 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15845 .endd
15846 The value is expanded every time it is needed. If the expansion fails, a
15847 panic is logged, and the default value is used.
15848
15849 .option envelope_to_remove main boolean true
15850 .cindex "&'Envelope-to:'& header line"
15851 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15852 message when it is delivered, in exactly the same way as &'Return-path:'& is
15853 handled. &'Envelope-to:'& records the original recipient address from the
15854 message's envelope that caused the delivery to happen. Such headers should not
15855 be present in incoming messages, and this option causes them to be removed at
15856 the time the message is received, to avoid any problems that might occur when a
15857 delivered message is subsequently sent on to some other recipient.
15858
15859
15860 .option errors_copy main "string list&!!" unset
15861 .cindex "bounce message" "copy to other address"
15862 .cindex "copy of bounce message"
15863 Setting this option causes Exim to send bcc copies of bounce messages that it
15864 generates to other addresses. &*Note*&: This does not apply to bounce messages
15865 coming from elsewhere. The value of the option is a colon-separated list of
15866 items. Each item consists of a pattern, terminated by white space, followed by
15867 a comma-separated list of email addresses. If a pattern contains spaces, it
15868 must be enclosed in double quotes.
15869
15870 Each pattern is processed in the same way as a single item in an address list
15871 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15872 the bounce message, the message is copied to the addresses on the list. The
15873 items are scanned in order, and once a matching one is found, no further items
15874 are examined. For example:
15875 .code
15876 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15877               rqps@mydomain   hostmaster@mydomain.example,\
15878                               postmaster@mydomain.example
15879 .endd
15880 .vindex "&$domain$&"
15881 .vindex "&$local_part$&"
15882 The address list is expanded before use. The expansion variables &$local_part$&
15883 and &$domain$& are set from the original recipient of the error message, and if
15884 there was any wildcard matching in the pattern, the expansion
15885 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15886 variables &$0$&, &$1$&, etc. are set in the normal way.
15887
15888
15889 .option errors_reply_to main string unset
15890 .cindex "bounce message" "&'Reply-to:'& in"
15891 By default, Exim's bounce and delivery warning messages contain the header line
15892 .display
15893 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15894 .endd
15895 .oindex &%quota_warn_message%&
15896 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15897 A warning message that is generated by the &%quota_warn_message%& option in an
15898 &(appendfile)& transport may contain its own &'From:'& header line that
15899 overrides the default.
15900
15901 Experience shows that people reply to bounce messages. If the
15902 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15903 and warning messages. For example:
15904 .code
15905 errors_reply_to = postmaster@my.domain.example
15906 .endd
15907 The value of the option is not expanded. It must specify a valid RFC 2822
15908 address. However, if a warning message that is generated by the
15909 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15910 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15911 not used.
15912
15913
15914 .option event_action main string&!! unset
15915 .cindex events
15916 This option declares a string to be expanded for Exim's events mechanism.
15917 For details see chapter &<<CHAPevents>>&.
15918
15919
15920 .option exim_group main string "compile-time configured"
15921 .cindex "gid (group id)" "Exim's own"
15922 .cindex "Exim group"
15923 This option changes the gid under which Exim runs when it gives up root
15924 privilege. The default value is compiled into the binary. The value of this
15925 option is used only when &%exim_user%& is also set. Unless it consists entirely
15926 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15927 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15928 security issues.
15929
15930
15931 .option exim_path main string "see below"
15932 .cindex "Exim binary, path name"
15933 This option specifies the path name of the Exim binary, which is used when Exim
15934 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15935 the directory configured at compile time by the BIN_DIRECTORY setting. It
15936 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15937 other place.
15938 &*Warning*&: Do not use a macro to define the value of this option, because
15939 you will break those Exim utilities that scan the configuration file to find
15940 where the binary is. (They then use the &%-bP%& option to extract option
15941 settings such as the value of &%spool_directory%&.)
15942
15943
15944 .option exim_user main string "compile-time configured"
15945 .cindex "uid (user id)" "Exim's own"
15946 .cindex "Exim user"
15947 This option changes the uid under which Exim runs when it gives up root
15948 privilege. The default value is compiled into the binary. Ownership of the run
15949 time configuration file and the use of the &%-C%& and &%-D%& command line
15950 options is checked against the values in the binary, not what is set here.
15951
15952 Unless it consists entirely of digits, the string is looked up using
15953 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15954 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15955 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15956
15957
15958 .option exim_version main string "current version"
15959 .cindex "Exim version"
15960 .cindex customizing "version number"
15961 .cindex "version number of Exim" override
15962 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15963 various places.  Use with care; this may fool stupid security scanners.
15964
15965
15966 .option extra_local_interfaces main "string list" unset
15967 This option defines network interfaces that are to be considered local when
15968 routing, but which are not used for listening by the daemon. See section
15969 &<<SECTreclocipadd>>& for details.
15970
15971
15972 . Allow this long option name to split; give it unsplit as a fifth argument
15973 . for the automatic .oindex that is generated by .option.
15974
15975 .option "extract_addresses_remove_arguments" main boolean true &&&
15976          extract_addresses_remove_arguments
15977 .oindex "&%-t%&"
15978 .cindex "command line" "addresses with &%-t%&"
15979 .cindex "Sendmail compatibility" "&%-t%& option"
15980 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15981 are present on the command line when the &%-t%& option is used to build an
15982 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15983 line addresses are removed from the recipients list. This is also how Smail
15984 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15985 command line addresses are added to those obtained from the header lines. When
15986 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15987 argument headers. If it is set false, Exim adds rather than removes argument
15988 addresses.
15989
15990
15991 .option finduser_retries main integer 0
15992 .cindex "NIS, retrying user lookups"
15993 On systems running NIS or other schemes in which user and group information is
15994 distributed from a remote system, there can be times when &[getpwnam()]& and
15995 related functions fail, even when given valid data, because things time out.
15996 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15997 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15998 many extra times to find a user or a group, waiting for one second between
15999 retries.
16000
16001 .cindex "&_/etc/passwd_&" "multiple reading of"
16002 You should not set this option greater than zero if your user information is in
16003 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
16004 search the file multiple times for non-existent users, and also cause delay.
16005
16006
16007
16008 .option freeze_tell main "string list, comma separated" unset
16009 .cindex "freezing messages" "sending a message when freezing"
16010 On encountering certain errors, or when configured to do so in a system filter,
16011 ACL, or special router, Exim freezes a message. This means that no further
16012 delivery attempts take place until an administrator thaws the message, or the
16013 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
16014 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
16015 warning message whenever it freezes something, unless the message it is
16016 freezing is a locally-generated bounce message. (Without this exception there
16017 is the possibility of looping.) The warning message is sent to the addresses
16018 supplied as the comma-separated value of this option. If several of the
16019 message's addresses cause freezing, only a single message is sent. If the
16020 freezing was automatic, the reason(s) for freezing can be found in the message
16021 log. If you configure freezing in a filter or ACL, you must arrange for any
16022 logging that you require.
16023
16024
16025 .option gecos_name main string&!! unset
16026 .cindex "HP-UX"
16027 .cindex "&""gecos""& field, parsing"
16028 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
16029 password file to hold other information in addition to users' real names. Exim
16030 looks up this field for use when it is creating &'Sender:'& or &'From:'&
16031 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
16032 of the field are used unchanged, except that, if an ampersand is encountered,
16033 it is replaced by the user's login name with the first character forced to
16034 upper case, since this is a convention that is observed on many systems.
16035
16036 When these options are set, &%gecos_pattern%& is treated as a regular
16037 expression that is to be applied to the field (again with && replaced by the
16038 login name), and if it matches, &%gecos_name%& is expanded and used as the
16039 user's name.
16040
16041 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
16042 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
16043 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
16044 name terminates at the first comma, the following can be used:
16045 .code
16046 gecos_pattern = ([^,]*)
16047 gecos_name = $1
16048 .endd
16049
16050 .option gecos_pattern main string unset
16051 See &%gecos_name%& above.
16052
16053
16054 .option gnutls_compat_mode main boolean unset
16055 This option controls whether GnuTLS is used in compatibility mode in an Exim
16056 server. This reduces security slightly, but improves interworking with older
16057 implementations of TLS.
16058
16059
16060 .option gnutls_allow_auto_pkcs11 main boolean unset
16061 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
16062 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
16063
16064 See
16065 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
16066 for documentation.
16067
16068
16069
16070 .option headers_charset main string "see below"
16071 This option sets a default character set for translating from encoded MIME
16072 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
16073 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
16074 ultimate default is ISO-8859-1. For more details see the description of header
16075 insertions in section &<<SECTexpansionitems>>&.
16076
16077
16078
16079 .option header_maxsize main integer "see below"
16080 .cindex "header section" "maximum size of"
16081 .cindex "limit" "size of message header section"
16082 This option controls the overall maximum size of a message's header
16083 section. The default is the value of HEADER_MAXSIZE in
16084 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
16085 sections are rejected.
16086
16087
16088 .option header_line_maxsize main integer 0
16089 .cindex "header lines" "maximum size of"
16090 .cindex "limit" "size of one header line"
16091 This option limits the length of any individual header line in a message, after
16092 all the continuations have been joined together. Messages with individual
16093 header lines that are longer than the limit are rejected. The default value of
16094 zero means &"no limit"&.
16095
16096
16097
16098
16099 .option helo_accept_junk_hosts main "host list&!!" unset
16100 .cindex "HELO" "accepting junk data"
16101 .cindex "EHLO" "accepting junk data"
16102 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
16103 mail, and gives an error response for invalid data. Unfortunately, there are
16104 some SMTP clients that send syntactic junk. They can be accommodated by setting
16105 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
16106 if you want to do semantic checking.
16107 See also &%helo_allow_chars%& for a way of extending the permitted character
16108 set.
16109
16110
16111 .option helo_allow_chars main string unset
16112 .cindex "HELO" "underscores in"
16113 .cindex "EHLO" "underscores in"
16114 .cindex "underscore in EHLO/HELO"
16115 This option can be set to a string of rogue characters that are permitted in
16116 all EHLO and HELO names in addition to the standard letters, digits,
16117 hyphens, and dots. If you really must allow underscores, you can set
16118 .code
16119 helo_allow_chars = _
16120 .endd
16121 Note that the value is one string, not a list.
16122
16123
16124 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
16125 .cindex "HELO" "forcing reverse lookup"
16126 .cindex "EHLO" "forcing reverse lookup"
16127 If the domain given by a client in a HELO or EHLO command matches this
16128 list, a reverse lookup is done in order to establish the host's true name. The
16129 default forces a lookup if the client host gives the server's name or any of
16130 its IP addresses (in brackets), something that broken clients have been seen to
16131 do.
16132
16133
16134 .option helo_try_verify_hosts main "host list&!!" unset
16135 .cindex "HELO verifying" "optional"
16136 .cindex "EHLO" "verifying, optional"
16137 By default, Exim just checks the syntax of HELO and EHLO commands (see
16138 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
16139 to do more extensive checking of the data supplied by these commands. The ACL
16140 condition &`verify = helo`& is provided to make this possible.
16141 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
16142 to force the check to occur. From release 4.53 onwards, this is no longer
16143 necessary. If the check has not been done before &`verify = helo`& is
16144 encountered, it is done at that time. Consequently, this option is obsolete.
16145 Its specification is retained here for backwards compatibility.
16146
16147 When an EHLO or HELO command is received, if the calling host matches
16148 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
16149 EHLO command either:
16150
16151 .ilist
16152 is an IP literal matching the calling address of the host, or
16153 .next
16154 .cindex "DNS" "reverse lookup"
16155 .cindex "reverse DNS lookup"
16156 matches the host name that Exim obtains by doing a reverse lookup of the
16157 calling host address, or
16158 .next
16159 when looked up in DNS yields the calling host address.
16160 .endlist
16161
16162 However, the EHLO or HELO command is not rejected if any of the checks
16163 fail. Processing continues, but the result of the check is remembered, and can
16164 be detected later in an ACL by the &`verify = helo`& condition.
16165
16166 If DNS was used for successful verification, the variable
16167 .cindex "DNS" "DNSSEC"
16168 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16169
16170 .option helo_verify_hosts main "host list&!!" unset
16171 .cindex "HELO verifying" "mandatory"
16172 .cindex "EHLO" "verifying, mandatory"
16173 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16174 backwards compatibility. For hosts that match this option, Exim checks the host
16175 name given in the HELO or EHLO in the same way as for
16176 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16177 rejected with a 550 error, and entries are written to the main and reject logs.
16178 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16179 error.
16180
16181 .option hold_domains main "domain list&!!" unset
16182 .cindex "domain" "delaying delivery"
16183 .cindex "delivery" "delaying certain domains"
16184 This option allows mail for particular domains to be held in the queue
16185 manually. The option is overridden if a message delivery is forced with the
16186 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16187 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16188 item in &%hold_domains%&, no routing or delivery for that address is done, and
16189 it is deferred every time the message is looked at.
16190
16191 This option is intended as a temporary operational measure for delaying the
16192 delivery of mail while some problem is being sorted out, or some new
16193 configuration tested. If you just want to delay the processing of some
16194 domains until a queue run occurs, you should use &%queue_domains%& or
16195 &%queue_smtp_domains%&, not &%hold_domains%&.
16196
16197 A setting of &%hold_domains%& does not override Exim's code for removing
16198 messages from the queue if they have been there longer than the longest retry
16199 time in any retry rule. If you want to hold messages for longer than the normal
16200 retry times, insert a dummy retry rule with a long retry time.
16201
16202
16203 .option host_lookup main "host list&!!" unset
16204 .cindex "host name" "lookup, forcing"
16205 Exim does not look up the name of a calling host from its IP address unless it
16206 is required to compare against some host list, or the host matches
16207 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16208 option (which normally contains IP addresses rather than host names). The
16209 default configuration file contains
16210 .code
16211 host_lookup = *
16212 .endd
16213 which causes a lookup to happen for all hosts. If the expense of these lookups
16214 is felt to be too great, the setting can be changed or removed.
16215
16216 After a successful reverse lookup, Exim does a forward lookup on the name it
16217 has obtained, to verify that it yields the IP address that it started with. If
16218 this check fails, Exim behaves as if the name lookup failed.
16219
16220 .vindex "&$host_lookup_failed$&"
16221 .vindex "&$sender_host_name$&"
16222 After any kind of failure, the host name (in &$sender_host_name$&) remains
16223 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16224 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16225 &`verify = reverse_host_lookup`& in ACLs.
16226
16227
16228 .option host_lookup_order main "string list" &`bydns:byaddr`&
16229 This option specifies the order of different lookup methods when Exim is trying
16230 to find a host name from an IP address. The default is to do a DNS lookup
16231 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16232 if that fails. You can change the order of these lookups, or omit one entirely,
16233 if you want.
16234
16235 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16236 multiple PTR records in the DNS and the IP address is not listed in
16237 &_/etc/hosts_&. Different operating systems give different results in this
16238 case. That is why the default tries a DNS lookup first.
16239
16240
16241
16242 .option host_reject_connection main "host list&!!" unset
16243 .cindex "host" "rejecting connections from"
16244 If this option is set, incoming SMTP calls from the hosts listed are rejected
16245 as soon as the connection is made.
16246 This option is obsolete, and retained only for backward compatibility, because
16247 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16248 connections immediately.
16249
16250 The ability to give an immediate rejection (either by this option or using an
16251 ACL) is provided for use in unusual cases. Many hosts will just try again,
16252 sometimes without much delay. Normally, it is better to use an ACL to reject
16253 incoming messages at a later stage, such as after RCPT commands. See
16254 chapter &<<CHAPACL>>&.
16255
16256
16257 .option hosts_connection_nolog main "host list&!!" unset
16258 .cindex "host" "not logging connections from"
16259 This option defines a list of hosts for which connection logging does not
16260 happen, even though the &%smtp_connection%& log selector is set. For example,
16261 you might want not to log SMTP connections from local processes, or from
16262 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16263 the daemon; you should therefore strive to restrict its value to a short inline
16264 list of IP addresses and networks. To disable logging SMTP connections from
16265 local processes, you must create a host list with an empty item. For example:
16266 .code
16267 hosts_connection_nolog = :
16268 .endd
16269 If the &%smtp_connection%& log selector is not set, this option has no effect.
16270
16271
16272
16273 .option hosts_proxy main "host list&!!" unset
16274 .cindex proxy "proxy protocol"
16275 This option enables use of Proxy Protocol proxies for incoming
16276 connections.  For details see section &<<SECTproxyInbound>>&.
16277
16278
16279 .option hosts_treat_as_local main "domain list&!!" unset
16280 .cindex "local host" "domains treated as"
16281 .cindex "host" "treated as local"
16282 If this option is set, any host names that match the domain list are treated as
16283 if they were the local host when Exim is scanning host lists obtained from MX
16284 records
16285 or other sources. Note that the value of this option is a domain list, not a
16286 host list, because it is always used to check host names, not IP addresses.
16287
16288 This option also applies when Exim is matching the special items
16289 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16290 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16291 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16292 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16293 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16294 interfaces and recognizing the local host.
16295
16296
16297 .option ibase_servers main "string list" unset
16298 .cindex "InterBase" "server list"
16299 This option provides a list of InterBase servers and associated connection data,
16300 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16301 The option is available only if Exim has been built with InterBase support.
16302
16303
16304
16305 .option ignore_bounce_errors_after main time 10w
16306 .cindex "bounce message" "discarding"
16307 .cindex "discarding bounce message"
16308 This option affects the processing of bounce messages that cannot be delivered,
16309 that is, those that suffer a permanent delivery failure. (Bounce messages that
16310 suffer temporary delivery failures are of course retried in the usual way.)
16311
16312 After a permanent delivery failure, bounce messages are frozen,
16313 because there is no sender to whom they can be returned. When a frozen bounce
16314 message has been in the queue for more than the given time, it is unfrozen at
16315 the next queue run, and a further delivery is attempted. If delivery fails
16316 again, the bounce message is discarded. This makes it possible to keep failed
16317 bounce messages around for a shorter time than the normal maximum retry time
16318 for frozen messages. For example,
16319 .code
16320 ignore_bounce_errors_after = 12h
16321 .endd
16322 retries failed bounce message deliveries after 12 hours, discarding any further
16323 failures. If the value of this option is set to a zero time period, bounce
16324 failures are discarded immediately. Setting a very long time (as in the default
16325 value) has the effect of disabling this option. For ways of automatically
16326 dealing with other kinds of frozen message, see &%auto_thaw%& and
16327 &%timeout_frozen_after%&.
16328
16329
16330 .option ignore_fromline_hosts main "host list&!!" unset
16331 .cindex "&""From""& line"
16332 .cindex "UUCP" "&""From""& line"
16333 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16334 the headers of a message. By default this is treated as the start of the
16335 message's body, which means that any following headers are not recognized as
16336 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16337 match those hosts that insist on sending it. If the sender is actually a local
16338 process rather than a remote host, and is using &%-bs%& to inject the messages,
16339 &%ignore_fromline_local%& must be set to achieve this effect.
16340
16341
16342 .option ignore_fromline_local main boolean false
16343 See &%ignore_fromline_hosts%& above.
16344
16345 .option keep_environment main "string list" unset
16346 .cindex "environment" "values from"
16347 This option contains a string list of environment variables to keep.
16348 You have to trust these variables or you have to be sure that
16349 these variables do not impose any security risk. Keep in mind that
16350 during the startup phase Exim is running with an effective UID 0 in most
16351 installations. As the default value is an empty list, the default
16352 environment for using libraries, running embedded Perl code, or running
16353 external binaries is empty, and does not not even contain PATH or HOME.
16354
16355 Actually the list is interpreted as a list of patterns
16356 (&<<SECTlistexpand>>&), except that it is not expanded first.
16357
16358 WARNING: Macro substitution is still done first, so having a macro
16359 FOO and having FOO_HOME in your &%keep_environment%& option may have
16360 unexpected results. You may work around this using a regular expression
16361 that does not match the macro name: ^[F]OO_HOME$.
16362
16363 Current versions of Exim issue a warning during startup if you do not mention
16364 &%keep_environment%& in your runtime configuration file and if your
16365 current environment is not empty. Future versions may not issue that warning
16366 anymore.
16367
16368 See the &%add_environment%& main config option for a way to set
16369 environment variables to a fixed value.  The environment for &(pipe)&
16370 transports is handled separately, see section &<<SECTpipeenv>>& for
16371 details.
16372
16373
16374 .option keep_malformed main time 4d
16375 This option specifies the length of time to keep messages whose spool files
16376 have been corrupted in some way. This should, of course, never happen. At the
16377 next attempt to deliver such a message, it gets removed. The incident is
16378 logged.
16379
16380
16381 .option ldap_ca_cert_dir main string unset
16382 .cindex "LDAP", "TLS CA certificate directory"
16383 .cindex certificate "directory for LDAP"
16384 This option indicates which directory contains CA certificates for verifying
16385 a TLS certificate presented by an LDAP server.
16386 While Exim does not provide a default value, your SSL library may.
16387 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16388 and constrained to be a directory.
16389
16390
16391 .option ldap_ca_cert_file main string unset
16392 .cindex "LDAP", "TLS CA certificate file"
16393 .cindex certificate "file for LDAP"
16394 This option indicates which file contains CA certificates for verifying
16395 a TLS certificate presented by an LDAP server.
16396 While Exim does not provide a default value, your SSL library may.
16397 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16398 and constrained to be a file.
16399
16400
16401 .option ldap_cert_file main string unset
16402 .cindex "LDAP" "TLS client certificate file"
16403 .cindex certificate "file for LDAP"
16404 This option indicates which file contains an TLS client certificate which
16405 Exim should present to the LDAP server during TLS negotiation.
16406 Should be used together with &%ldap_cert_key%&.
16407
16408
16409 .option ldap_cert_key main string unset
16410 .cindex "LDAP" "TLS client key file"
16411 .cindex certificate "key for LDAP"
16412 This option indicates which file contains the secret/private key to use
16413 to prove identity to the LDAP server during TLS negotiation.
16414 Should be used together with &%ldap_cert_file%&, which contains the
16415 identity to be proven.
16416
16417
16418 .option ldap_cipher_suite main string unset
16419 .cindex "LDAP" "TLS cipher suite"
16420 This controls the TLS cipher-suite negotiation during TLS negotiation with
16421 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16422 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16423
16424
16425 .option ldap_default_servers main "string list" unset
16426 .cindex "LDAP" "default servers"
16427 This option provides a list of LDAP servers which are tried in turn when an
16428 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16429 details of LDAP queries. This option is available only when Exim has been built
16430 with LDAP support.
16431
16432
16433 .option ldap_require_cert main string unset.
16434 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16435 This should be one of the values "hard", "demand", "allow", "try" or "never".
16436 A value other than one of these is interpreted as "never".
16437 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16438 Although Exim does not set a default, the LDAP library probably defaults
16439 to hard/demand.
16440
16441
16442 .option ldap_start_tls main boolean false
16443 .cindex "LDAP" "whether or not to negotiate TLS"
16444 If set, Exim will attempt to negotiate TLS with the LDAP server when
16445 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16446 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16447 of SSL-on-connect.
16448 In the event of failure to negotiate TLS, the action taken is controlled
16449 by &%ldap_require_cert%&.
16450 This option is ignored for &`ldapi`& connections.
16451
16452
16453 .option ldap_version main integer unset
16454 .cindex "LDAP" "protocol version, forcing"
16455 This option can be used to force Exim to set a specific protocol version for
16456 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16457 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16458 the LDAP headers; otherwise it is 2. This option is available only when Exim
16459 has been built with LDAP support.
16460
16461
16462
16463 .option local_from_check main boolean true
16464 .cindex "&'Sender:'& header line" "disabling addition of"
16465 .cindex "&'From:'& header line" "disabling checking of"
16466 When a message is submitted locally (that is, not over a TCP/IP connection) by
16467 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16468 checks that the &'From:'& header line matches the login of the calling user and
16469 the domain specified by &%qualify_domain%&.
16470
16471 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16472 locally submitted message is automatically qualified by Exim, unless the
16473 &%-bnq%& command line option is used.
16474
16475 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16476 on the local part. If the &'From:'& header line does not match, Exim adds a
16477 &'Sender:'& header with an address constructed from the calling user's login
16478 and the default qualify domain.
16479
16480 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16481 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16482 &'Sender:'& header lines supplied by untrusted users, you must also set
16483 &%local_sender_retain%& to be true.
16484
16485 .cindex "envelope from"
16486 .cindex "envelope sender"
16487 These options affect only the header lines in the message. The envelope sender
16488 is still forced to be the login id at the qualify domain unless
16489 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16490
16491 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16492 request similar header line checking. See section &<<SECTthesenhea>>&, which
16493 has more details about &'Sender:'& processing.
16494
16495
16496
16497
16498 .option local_from_prefix main string unset
16499 When Exim checks the &'From:'& header line of locally submitted messages for
16500 matching the login id (see &%local_from_check%& above), it can be configured to
16501 ignore certain prefixes and suffixes in the local part of the address. This is
16502 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16503 appropriate lists, in the same form as the &%local_part_prefix%& and
16504 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16505 example, if
16506 .code
16507 local_from_prefix = *-
16508 .endd
16509 is set, a &'From:'& line containing
16510 .code
16511 From: anything-user@your.domain.example
16512 .endd
16513 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16514 matches the actual sender address that is constructed from the login name and
16515 qualify domain.
16516
16517
16518 .option local_from_suffix main string unset
16519 See &%local_from_prefix%& above.
16520
16521
16522 .option local_interfaces main "string list" "see below"
16523 This option controls which network interfaces are used by the daemon for
16524 listening; they are also used to identify the local host when routing. Chapter
16525 &<<CHAPinterfaces>>& contains a full description of this option and the related
16526 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16527 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16528 &%local_interfaces%& is
16529 .code
16530 local_interfaces = 0.0.0.0
16531 .endd
16532 when Exim is built without IPv6 support; otherwise it is
16533 .code
16534 local_interfaces = <; ::0 ; 0.0.0.0
16535 .endd
16536
16537 .option local_scan_timeout main time 5m
16538 .cindex "timeout" "for &[local_scan()]& function"
16539 .cindex "&[local_scan()]& function" "timeout"
16540 This timeout applies to the &[local_scan()]& function (see chapter
16541 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16542 the incoming message is rejected with a temporary error if it is an SMTP
16543 message. For a non-SMTP message, the message is dropped and Exim ends with a
16544 non-zero code. The incident is logged on the main and reject logs.
16545
16546
16547
16548 .option local_sender_retain main boolean false
16549 .cindex "&'Sender:'& header line" "retaining from local submission"
16550 When a message is submitted locally (that is, not over a TCP/IP connection) by
16551 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16552 do not want this to happen, you must set &%local_sender_retain%&, and you must
16553 also set &%local_from_check%& to be false (Exim will complain if you do not).
16554 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16555 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16556
16557
16558
16559
16560 .option localhost_number main string&!! unset
16561 .cindex "host" "locally unique number for"
16562 .cindex "message ids" "with multiple hosts"
16563 .vindex "&$localhost_number$&"
16564 Exim's message ids are normally unique only within the local host. If
16565 uniqueness among a set of hosts is required, each host must set a different
16566 value for the &%localhost_number%& option. The string is expanded immediately
16567 after reading the configuration file (so that a number can be computed from the
16568 host name, for example) and the result of the expansion must be a number in the
16569 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16570 systems). This is available in subsequent string expansions via the variable
16571 &$localhost_number$&. When &%localhost_number is set%&, the final two
16572 characters of the message id, instead of just being a fractional part of the
16573 time, are computed from the time and the local host number as described in
16574 section &<<SECTmessiden>>&.
16575
16576
16577
16578 .option log_file_path main "string list&!!" "set at compile time"
16579 .cindex "log" "file path for"
16580 This option sets the path which is used to determine the names of Exim's log
16581 files, or indicates that logging is to be to syslog, or both. It is expanded
16582 when Exim is entered, so it can, for example, contain a reference to the host
16583 name. If no specific path is set for the log files at compile or runtime,
16584 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16585 they are written in a sub-directory called &_log_& in Exim's spool directory.
16586 A path must start with a slash.
16587 To send to syslog, use the word &"syslog"&.
16588 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16589 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16590 used. If this string is fixed at your installation (contains no expansion
16591 variables) it is recommended that you do not set this option in the
16592 configuration file, but instead supply the path using LOG_FILE_PATH in
16593 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16594 early on &-- in particular, failure to read the configuration file.
16595
16596
16597 .option log_selector main string unset
16598 .cindex "log" "selectors"
16599 This option can be used to reduce or increase the number of things that Exim
16600 writes to its log files. Its argument is made up of names preceded by plus or
16601 minus characters. For example:
16602 .code
16603 log_selector = +arguments -retry_defer
16604 .endd
16605 A list of possible names and what they control is given in the chapter on
16606 logging, in section &<<SECTlogselector>>&.
16607
16608
16609 .option log_timezone main boolean false
16610 .cindex "log" "timezone for entries"
16611 .vindex "&$tod_log$&"
16612 .vindex "&$tod_zone$&"
16613 By default, the timestamps on log lines are in local time without the
16614 timezone. This means that if your timezone changes twice a year, the timestamps
16615 in log lines are ambiguous for an hour when the clocks go back. One way of
16616 avoiding this problem is to set the timezone to UTC. An alternative is to set
16617 &%log_timezone%& true. This turns on the addition of the timezone offset to
16618 timestamps in log lines. Turning on this option can add quite a lot to the size
16619 of log files because each line is extended by 6 characters. Note that the
16620 &$tod_log$& variable contains the log timestamp without the zone, but there is
16621 another variable called &$tod_zone$& that contains just the timezone offset.
16622
16623
16624 .option lookup_open_max main integer 25
16625 .cindex "too many open files"
16626 .cindex "open files, too many"
16627 .cindex "file" "too many open"
16628 .cindex "lookup" "maximum open files"
16629 .cindex "limit" "open files for lookups"
16630 This option limits the number of simultaneously open files for single-key
16631 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16632 Exim normally keeps these files open during routing, because often the same
16633 file is required several times. If the limit is reached, Exim closes the least
16634 recently used file. Note that if you are using the &'ndbm'& library, it
16635 actually opens two files for each logical DBM database, though it still counts
16636 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16637 open files"& errors with NDBM, you need to reduce the value of
16638 &%lookup_open_max%&.
16639
16640
16641 .option max_username_length main integer 0
16642 .cindex "length of login name"
16643 .cindex "user name" "maximum length"
16644 .cindex "limit" "user name length"
16645 Some operating systems are broken in that they truncate long arguments to
16646 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16647 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16648 an argument that is longer behaves as if &[getpwnam()]& failed.
16649
16650
16651 .option message_body_newlines main bool false
16652 .cindex "message body" "newlines in variables"
16653 .cindex "newline" "in message body variables"
16654 .vindex "&$message_body$&"
16655 .vindex "&$message_body_end$&"
16656 By default, newlines in the message body are replaced by spaces when setting
16657 the &$message_body$& and &$message_body_end$& expansion variables. If this
16658 option is set true, this no longer happens.
16659
16660
16661 .option message_body_visible main integer 500
16662 .cindex "body of message" "visible size"
16663 .cindex "message body" "visible size"
16664 .vindex "&$message_body$&"
16665 .vindex "&$message_body_end$&"
16666 This option specifies how much of a message's body is to be included in the
16667 &$message_body$& and &$message_body_end$& expansion variables.
16668
16669
16670 .option message_id_header_domain main string&!! unset
16671 .cindex "&'Message-ID:'& header line"
16672 If this option is set, the string is expanded and used as the right hand side
16673 (domain) of the &'Message-ID:'& header that Exim creates if a
16674 locally-originated incoming message does not have one. &"Locally-originated"&
16675 means &"not received over TCP/IP."&
16676 Otherwise, the primary host name is used.
16677 Only letters, digits, dot and hyphen are accepted; any other characters are
16678 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16679 empty string, the option is ignored.
16680
16681
16682 .option message_id_header_text main string&!! unset
16683 If this variable is set, the string is expanded and used to augment the text of
16684 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16685 message does not have one. The text of this header is required by RFC 2822 to
16686 take the form of an address. By default, Exim uses its internal message id as
16687 the local part, and the primary host name as the domain. If this option is set,
16688 it is expanded, and provided the expansion is not forced to fail, and does not
16689 yield an empty string, the result is inserted into the header immediately
16690 before the @, separated from the internal message id by a dot. Any characters
16691 that are illegal in an address are automatically converted into hyphens. This
16692 means that variables such as &$tod_log$& can be used, because the spaces and
16693 colons will become hyphens.
16694
16695
16696 .option message_logs main boolean true
16697 .cindex "message logs" "disabling"
16698 .cindex "log" "message log; disabling"
16699 If this option is turned off, per-message log files are not created in the
16700 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16701 Exim, by reducing the number of files involved in handling a message from a
16702 minimum of four (header spool file, body spool file, delivery journal, and
16703 per-message log) to three. The other major I/O activity is Exim's main log,
16704 which is not affected by this option.
16705
16706
16707 .option message_size_limit main string&!! 50M
16708 .cindex "message" "size limit"
16709 .cindex "limit" "message size"
16710 .cindex "size" "of message, limit"
16711 This option limits the maximum size of message that Exim will process. The
16712 value is expanded for each incoming connection so, for example, it can be made
16713 to depend on the IP address of the remote host for messages arriving via
16714 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16715 optionally followed by K or M.
16716
16717 .cindex "SIZE" "ESMTP extension, advertising"
16718 .cindex "ESMTP extensions" SIZE
16719 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16720 service extension keyword.
16721
16722 &*Note*&: This limit cannot be made to depend on a message's sender or any
16723 other properties of an individual message, because it has to be advertised in
16724 the server's response to EHLO. String expansion failure causes a temporary
16725 error. A value of zero means no limit, but its use is not recommended. See also
16726 &%bounce_return_size_limit%&.
16727
16728 Incoming SMTP messages are failed with a 552 error if the limit is
16729 exceeded; locally-generated messages either get a stderr message or a delivery
16730 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16731 an oversized message is logged in both the main and the reject logs. See also
16732 the generic transport option &%message_size_limit%&, which limits the size of
16733 message that an individual transport can process.
16734
16735 If you use a virus-scanner and set this option to to a value larger than the
16736 maximum size that your virus-scanner is configured to support, you may get
16737 failures triggered by large mails.  The right size to configure for the
16738 virus-scanner depends upon what data is passed and the options in use but it's
16739 probably safest to just set it to a little larger than this value.  E.g., with a
16740 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16741 some problems may result.
16742
16743 A value of 0 will disable size limit checking; Exim will still advertise the
16744 SIZE extension in an EHLO response, but without a limit, so as to permit
16745 SMTP clients to still indicate the message size along with the MAIL verb.
16746
16747
16748 .option move_frozen_messages main boolean false
16749 .cindex "frozen messages" "moving"
16750 This option, which is available only if Exim has been built with the setting
16751 .code
16752 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16753 .endd
16754 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16755 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16756 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16757 standard utilities for handling such moved messages, and they do not show up in
16758 lists generated by &%-bp%& or by the Exim monitor.
16759
16760
16761 .option mua_wrapper main boolean false
16762 Setting this option true causes Exim to run in a very restrictive mode in which
16763 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16764 contains a full description of this facility.
16765
16766
16767
16768 .option mysql_servers main "string list" unset
16769 .cindex "MySQL" "server list"
16770 This option provides a list of MySQL servers and associated connection data, to
16771 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16772 option is available only if Exim has been built with MySQL support.
16773
16774
16775 .option never_users main "string list&!!" unset
16776 This option is expanded just once, at the start of Exim's processing. Local
16777 message deliveries are normally run in processes that are setuid to the
16778 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16779 It is usually desirable to prevent any deliveries from running as root, as a
16780 safety precaution.
16781
16782 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16783 list of users that must not be used for local deliveries. This list is fixed in
16784 the binary and cannot be overridden by the configuration file. By default, it
16785 contains just the single user name &"root"&. The &%never_users%& runtime option
16786 can be used to add more users to the fixed list.
16787
16788 If a message is to be delivered as one of the users on the fixed list or the
16789 &%never_users%& list, an error occurs, and delivery is deferred. A common
16790 example is
16791 .code
16792 never_users = root:daemon:bin
16793 .endd
16794 Including root is redundant if it is also on the fixed list, but it does no
16795 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16796 transport driver.
16797
16798
16799 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16800 This option gives the name for a unix-domain socket on which the daemon
16801 listens for work and information-requests.
16802 Only installations running multiple daemons sharing a spool directory
16803 should need to modify the default.
16804
16805 The option is expanded before use.
16806 If the platform supports Linux-style abstract socket names, the result
16807 is used with a nul byte prefixed.
16808 Otherwise,
16809 .new "if nonempty,"
16810 it should be a full path name and use a directory accessible
16811 to Exim.
16812
16813 .new
16814 If this option is set as empty,
16815 or the command line &%-oY%& option is used, or
16816 .wen
16817 the command line uses a &%-oX%& option and does not use &%-oP%&,
16818 then a notifier socket is not created.
16819
16820
16821 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16822 .cindex "OpenSSL "compatibility options"
16823 This option allows an administrator to adjust the SSL options applied
16824 by OpenSSL to connections.  It is given as a space-separated list of items,
16825 each one to be +added or -subtracted from the current value.
16826
16827 This option is only available if Exim is built against OpenSSL.  The values
16828 available for this option vary according to the age of your OpenSSL install.
16829 The &"all"& value controls a subset of flags which are available, typically
16830 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16831 list the values known on your system and Exim should support all the
16832 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16833 names lose the leading &"SSL_OP_"& and are lower-cased.
16834
16835 Note that adjusting the options can have severe impact upon the security of
16836 SSL as used by Exim.  It is possible to disable safety checks and shoot
16837 yourself in the foot in various unpleasant ways.  This option should not be
16838 adjusted lightly.  An unrecognised item will be detected at startup, by
16839 invoking Exim with the &%-bV%& flag.
16840
16841 The option affects Exim operating both as a server and as a client.
16842
16843 Historical note: prior to release 4.80, Exim defaulted this value to
16844 "+dont_insert_empty_fragments", which may still be needed for compatibility
16845 with some clients, but which lowers security by increasing exposure to
16846 some now infamous attacks.
16847
16848 Examples:
16849 .code
16850 # Make both old MS and old Eudora happy:
16851 openssl_options = -all +microsoft_big_sslv3_buffer \
16852                        +dont_insert_empty_fragments
16853
16854 # Disable older protocol versions:
16855 openssl_options = +no_sslv2 +no_sslv3
16856 .endd
16857
16858 Possible options may include:
16859 .ilist
16860 &`all`&
16861 .next
16862 &`allow_unsafe_legacy_renegotiation`&
16863 .next
16864 &`cipher_server_preference`&
16865 .next
16866 &`dont_insert_empty_fragments`&
16867 .next
16868 &`ephemeral_rsa`&
16869 .next
16870 &`legacy_server_connect`&
16871 .next
16872 &`microsoft_big_sslv3_buffer`&
16873 .next
16874 &`microsoft_sess_id_bug`&
16875 .next
16876 &`msie_sslv2_rsa_padding`&
16877 .next
16878 &`netscape_challenge_bug`&
16879 .next
16880 &`netscape_reuse_cipher_change_bug`&
16881 .next
16882 &`no_compression`&
16883 .next
16884 &`no_session_resumption_on_renegotiation`&
16885 .next
16886 &`no_sslv2`&
16887 .next
16888 &`no_sslv3`&
16889 .next
16890 &`no_ticket`&
16891 .next
16892 &`no_tlsv1`&
16893 .next
16894 &`no_tlsv1_1`&
16895 .next
16896 &`no_tlsv1_2`&
16897 .next
16898 &`safari_ecdhe_ecdsa_bug`&
16899 .next
16900 &`single_dh_use`&
16901 .next
16902 &`single_ecdh_use`&
16903 .next
16904 &`ssleay_080_client_dh_bug`&
16905 .next
16906 &`sslref2_reuse_cert_type_bug`&
16907 .next
16908 &`tls_block_padding_bug`&
16909 .next
16910 &`tls_d5_bug`&
16911 .next
16912 &`tls_rollback_bug`&
16913 .endlist
16914
16915 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16916 all clients connecting using the MacOS SecureTransport TLS facility prior
16917 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16918 to negotiate TLS then this option value might help, provided that your OpenSSL
16919 release is new enough to contain this work-around.  This may be a situation
16920 where you have to upgrade OpenSSL to get buggy clients working.
16921
16922
16923 .option oracle_servers main "string list" unset
16924 .cindex "Oracle" "server list"
16925 This option provides a list of Oracle servers and associated connection data,
16926 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16927 The option is available only if Exim has been built with Oracle support.
16928
16929
16930 .option percent_hack_domains main "domain list&!!" unset
16931 .cindex "&""percent hack""&"
16932 .cindex "source routing" "in email address"
16933 .cindex "address" "source-routed"
16934 The &"percent hack"& is the convention whereby a local part containing a
16935 percent sign is re-interpreted as a new email address, with the percent
16936 replaced by @. This is sometimes called &"source routing"&, though that term is
16937 also applied to RFC 2822 addresses that begin with an @ character. If this
16938 option is set, Exim implements the percent facility for those domains listed,
16939 but no others. This happens before an incoming SMTP address is tested against
16940 an ACL.
16941
16942 &*Warning*&: The &"percent hack"& has often been abused by people who are
16943 trying to get round relaying restrictions. For this reason, it is best avoided
16944 if at all possible. Unfortunately, a number of less security-conscious MTAs
16945 implement it unconditionally. If you are running Exim on a gateway host, and
16946 routing mail through to internal MTAs without processing the local parts, it is
16947 a good idea to reject recipient addresses with percent characters in their
16948 local parts. Exim's default configuration does this.
16949
16950
16951 .option perl_at_start main boolean false
16952 .cindex "Perl"
16953 This option is available only when Exim is built with an embedded Perl
16954 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16955
16956
16957 .option perl_startup main string unset
16958 .cindex "Perl"
16959 This option is available only when Exim is built with an embedded Perl
16960 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16961
16962 .option perl_taintmode main boolean false
16963 .cindex "Perl"
16964 This option enables the taint mode of the embedded Perl interpreter.
16965
16966
16967 .option pgsql_servers main "string list" unset
16968 .cindex "PostgreSQL lookup type" "server list"
16969 This option provides a list of PostgreSQL servers and associated connection
16970 data, to be used in conjunction with &(pgsql)& lookups (see section
16971 &<<SECID72>>&). The option is available only if Exim has been built with
16972 PostgreSQL support.
16973
16974
16975 .option pid_file_path main string&!! "set at compile time"
16976 .cindex "daemon" "pid file path"
16977 .cindex "pid file, path for"
16978 This option sets the name of the file to which the Exim daemon writes its
16979 process id. The string is expanded, so it can contain, for example, references
16980 to the host name:
16981 .code
16982 pid_file_path = /var/log/$primary_hostname/exim.pid
16983 .endd
16984 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16985 spool directory.
16986 The value set by the option can be overridden by the &%-oP%& command line
16987 option. A pid file is not written if a &"non-standard"& daemon is run by means
16988 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16989
16990
16991 .option pipelining_advertise_hosts main "host list&!!" *
16992 .cindex "PIPELINING" "suppressing advertising"
16993 .cindex "ESMTP extensions" PIPELINING
16994 This option can be used to suppress the advertisement of the SMTP
16995 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16996 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16997 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16998 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16999 that clients will use it; &"out of order"& commands that are &"expected"& do
17000 not count as protocol errors (see &%smtp_max_synprot_errors%&).
17001
17002 .option pipelining_connect_advertise_hosts main "host list&!!" *
17003 .cindex "pipelining" "early connection"
17004 .cindex "pipelining" PIPE_CONNECT
17005 .cindex "ESMTP extensions" PIPE_CONNECT
17006 If Exim is built with the SUPPORT_PIPE_CONNECT build option
17007 this option controls which hosts the facility is advertised to
17008 and from which pipeline early-connection (before MAIL) SMTP
17009 commands are acceptable.
17010 When used, the pipelining saves on roundtrip times.
17011
17012 See also the &%hosts_pipe_connect%& smtp transport option.
17013
17014 .new
17015 The SMTP service extension keyword advertised is &"PIPE_CONNECT"&.
17016 .wen
17017
17018
17019 .option prdr_enable main boolean false
17020 .cindex "PRDR" "enabling on server"
17021 .cindex "ESMTP extensions" PRDR
17022 This option can be used to enable the Per-Recipient Data Response extension
17023 to SMTP, defined by Eric Hall.
17024 If the option is set, PRDR is advertised by Exim when operating as a server.
17025 If the client requests PRDR, and more than one recipient, for a message
17026 an additional ACL is called for each recipient after the message content
17027 is received.  See section &<<SECTPRDRACL>>&.
17028
17029 .option preserve_message_logs main boolean false
17030 .cindex "message logs" "preserving"
17031 If this option is set, message log files are not deleted when messages are
17032 completed. Instead, they are moved to a sub-directory of the spool directory
17033 called &_msglog.OLD_&, where they remain available for statistical or debugging
17034 purposes. This is a dangerous option to set on systems with any appreciable
17035 volume of mail. Use with care!
17036
17037
17038 .option primary_hostname main string "see below"
17039 .cindex "name" "of local host"
17040 .cindex "host" "name of local"
17041 .cindex "local host" "name of"
17042 .vindex "&$primary_hostname$&"
17043 This specifies the name of the current host. It is used in the default EHLO or
17044 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
17045 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
17046 The value is also used by default in some SMTP response messages from an Exim
17047 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
17048
17049 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
17050 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
17051 contains only one component, Exim passes it to &[gethostbyname()]& (or
17052 &[getipnodebyname()]& when available) in order to obtain the fully qualified
17053 version. The variable &$primary_hostname$& contains the host name, whether set
17054 explicitly by this option, or defaulted.
17055
17056
17057 .option print_topbitchars main boolean false
17058 .cindex "printing characters"
17059 .cindex "8-bit characters"
17060 By default, Exim considers only those characters whose codes lie in the range
17061 32&--126 to be printing characters. In a number of circumstances (for example,
17062 when writing log entries) non-printing characters are converted into escape
17063 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
17064 is set, code values of 128 and above are also considered to be printing
17065 characters.
17066
17067 This option also affects the header syntax checks performed by the
17068 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
17069 the user's full name when constructing From: and Sender: addresses (as
17070 described in section &<<SECTconstr>>&). Setting this option can cause
17071 Exim to generate eight bit message headers that do not conform to the
17072 standards.
17073
17074
17075 .option process_log_path main string unset
17076 .cindex "process log path"
17077 .cindex "log" "process log"
17078 .cindex "&'exiwhat'&"
17079 This option sets the name of the file to which an Exim process writes its
17080 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
17081 utility script. If this option is unset, the file called &_exim-process.info_&
17082 in Exim's spool directory is used. The ability to specify the name explicitly
17083 can be useful in environments where two different Exims are running, using
17084 different spool directories.
17085
17086
17087 .option prod_requires_admin main boolean true
17088 .cindex "restricting access to features"
17089 .oindex "&%-M%&"
17090 .oindex "&%-R%&"
17091 .oindex "&%-q%&"
17092 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
17093 admin user unless &%prod_requires_admin%& is set false. See also
17094 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
17095
17096
17097 .new
17098 .option proxy_protocol_timeout main time 3s
17099 .cindex proxy "proxy protocol"
17100 This option sets the timeout for proxy protocol negotiation.
17101 For details see section &<<SECTproxyInbound>>&.
17102 .wen
17103
17104
17105 .option qualify_domain main string "see below"
17106 .cindex "domain" "for qualifying addresses"
17107 .cindex "address" "qualification"
17108 This option specifies the domain name that is added to any envelope sender
17109 addresses that do not have a domain qualification. It also applies to
17110 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
17111 are accepted by default only for locally-generated messages. Qualification is
17112 also applied to addresses in header lines such as &'From:'& and &'To:'& for
17113 locally-generated messages, unless the &%-bnq%& command line option is used.
17114
17115 Messages from external sources must always contain fully qualified addresses,
17116 unless the sending host matches &%sender_unqualified_hosts%& or
17117 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
17118 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
17119 necessary. Internally, Exim always works with fully qualified envelope
17120 addresses. If &%qualify_domain%& is not set, it defaults to the
17121 &%primary_hostname%& value.
17122
17123
17124 .option qualify_recipient main string "see below"
17125 This option allows you to specify a different domain for qualifying recipient
17126 addresses to the one that is used for senders. See &%qualify_domain%& above.
17127
17128
17129
17130 .option queue_domains main "domain list&!!" unset
17131 .cindex "domain" "specifying non-immediate delivery"
17132 .cindex "queueing incoming messages"
17133 .cindex "message" "queueing certain domains"
17134 This option lists domains for which immediate delivery is not required.
17135 A delivery process is started whenever a message is received, but only those
17136 domains that do not match are processed. All other deliveries wait until the
17137 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
17138
17139
17140 .new
17141 .option queue_fast_ramp main boolean false
17142 .cindex "queue runner" "two phase"
17143 .cindex "queue" "double scanning"
17144 If set to true, two-phase queue runs, initiated using &%-qq%& on the
17145 command line, may start parallel delivery processes during their first
17146 phase.  This will be done when a threshold number of messages have been
17147 routed for a single host.
17148 .wen
17149
17150
17151 .option queue_list_requires_admin main boolean true
17152 .cindex "restricting access to features"
17153 .oindex "&%-bp%&"
17154 The &%-bp%& command-line option, which lists the messages that are on the
17155 queue, requires the caller to be an admin user unless
17156 &%queue_list_requires_admin%& is set false.
17157 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
17158
17159
17160 .option queue_only main boolean false
17161 .cindex "queueing incoming messages"
17162 .cindex "message" "queueing unconditionally"
17163 If &%queue_only%& is set, a delivery process is not automatically started
17164 whenever a message is received. Instead, the message waits in the queue for the
17165 next queue run. Even if &%queue_only%& is false, incoming messages may not get
17166 delivered immediately when certain conditions (such as heavy load) occur.
17167
17168 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
17169 and &%-odi%& command line options override &%queue_only%& unless
17170 &%queue_only_override%& is set false. See also &%queue_only_file%&,
17171 &%queue_only_load%&, and &%smtp_accept_queue%&.
17172
17173
17174 .option queue_only_file main string unset
17175 .cindex "queueing incoming messages"
17176 .cindex "message" "queueing by file existence"
17177 This option can be set to a colon-separated list of absolute path names, each
17178 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17179 it tests for the existence of each listed path using a call to &[stat()]&. For
17180 each path that exists, the corresponding queueing option is set.
17181 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17182 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17183 .code
17184 queue_only_file = smtp/some/file
17185 .endd
17186 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17187 &_/some/file_& exists.
17188
17189
17190 .option queue_only_load main fixed-point unset
17191 .cindex "load average"
17192 .cindex "queueing incoming messages"
17193 .cindex "message" "queueing by load"
17194 If the system load average is higher than this value, incoming messages from
17195 all sources are queued, and no automatic deliveries are started. If this
17196 happens during local or remote SMTP input, all subsequent messages received on
17197 the same SMTP connection are queued by default, whatever happens to the load in
17198 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17199 false.
17200
17201 Deliveries will subsequently be performed by queue runner processes. This
17202 option has no effect on ancient operating systems on which Exim cannot
17203 determine the load average. See also &%deliver_queue_load_max%& and
17204 &%smtp_load_reserve%&.
17205
17206
17207 .option queue_only_load_latch main boolean true
17208 .cindex "load average" "re-evaluating per message"
17209 When this option is true (the default), once one message has been queued
17210 because the load average is higher than the value set by &%queue_only_load%&,
17211 all subsequent messages received on the same SMTP connection are also queued.
17212 This is a deliberate choice; even though the load average may fall below the
17213 threshold, it doesn't seem right to deliver later messages on the same
17214 connection when not delivering earlier ones. However, there are special
17215 circumstances such as very long-lived connections from scanning appliances
17216 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17217 should be set false. This causes the value of the load average to be
17218 re-evaluated for each message.
17219
17220
17221 .option queue_only_override main boolean true
17222 .cindex "queueing incoming messages"
17223 When this option is true, the &%-od%&&'x'& command line options override the
17224 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17225 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17226 to override; they are accepted, but ignored.
17227
17228
17229 .option queue_run_in_order main boolean false
17230 .cindex "queue runner" "processing messages in order"
17231 If this option is set, queue runs happen in order of message arrival instead of
17232 in an arbitrary order. For this to happen, a complete list of the entire queue
17233 must be set up before the deliveries start. When the queue is all held in a
17234 single directory (the default), a single list is created for both the ordered
17235 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17236 single list is not created when &%queue_run_in_order%& is false. In this case,
17237 the sub-directories are processed one at a time (in a random order), and this
17238 avoids setting up one huge list for the whole queue. Thus, setting
17239 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17240 when the queue is large, because of the extra work in setting up the single,
17241 large list. In most situations, &%queue_run_in_order%& should not be set.
17242
17243
17244
17245 .option queue_run_max main integer&!! 5
17246 .cindex "queue runner" "maximum number of"
17247 This controls the maximum number of queue runner processes that an Exim daemon
17248 can run simultaneously. This does not mean that it starts them all at once,
17249 but rather that if the maximum number are still running when the time comes to
17250 start another one, it refrains from starting another one. This can happen with
17251 very large queues and/or very sluggish deliveries. This option does not,
17252 however, interlock with other processes, so additional queue runners can be
17253 started by other means, or by killing and restarting the daemon.
17254
17255 Setting this option to zero does not suppress queue runs; rather, it disables
17256 the limit, allowing any number of simultaneous queue runner processes to be
17257 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17258 the daemon's command line.
17259
17260 .cindex queues named
17261 .cindex "named queues" "resource limit"
17262 To set limits for different named queues use
17263 an expansion depending on the &$queue_name$& variable.
17264
17265 .option queue_smtp_domains main "domain list&!!" unset
17266 .cindex "queueing incoming messages"
17267 .cindex "message" "queueing remote deliveries"
17268 .cindex "first pass routing"
17269 When this option is set, a delivery process is started whenever a message is
17270 received, routing is performed, and local deliveries take place.
17271 However, if any SMTP deliveries are required for domains that match
17272 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17273 message waits in the queue for the next queue run. Since routing of the message
17274 has taken place, Exim knows to which remote hosts it must be delivered, and so
17275 when the queue run happens, multiple messages for the same host are delivered
17276 over a single SMTP connection. The &%-odqs%& command line option causes all
17277 SMTP deliveries to be queued in this way, and is equivalent to setting
17278 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17279 &%queue_domains%&.
17280
17281
17282 .option receive_timeout main time 0s
17283 .cindex "timeout" "for non-SMTP input"
17284 This option sets the timeout for accepting a non-SMTP message, that is, the
17285 maximum time that Exim waits when reading a message on the standard input. If
17286 the value is zero, it will wait forever. This setting is overridden by the
17287 &%-or%& command line option. The timeout for incoming SMTP messages is
17288 controlled by &%smtp_receive_timeout%&.
17289
17290 .option received_header_text main string&!! "see below"
17291 .cindex "customizing" "&'Received:'& header"
17292 .cindex "&'Received:'& header line" "customizing"
17293 This string defines the contents of the &'Received:'& message header that is
17294 added to each message, except for the timestamp, which is automatically added
17295 on at the end (preceded by a semicolon). The string is expanded each time it is
17296 used. If the expansion yields an empty string, no &'Received:'& header line is
17297 added to the message. Otherwise, the string should start with the text
17298 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17299 header lines.
17300 The default setting is:
17301
17302 .code
17303 received_header_text = Received: \
17304   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17305     {${if def:sender_ident \
17306       {from ${quote_local_part:$sender_ident} }}\
17307         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17308   by $primary_hostname \
17309   ${if def:received_protocol {with $received_protocol }}\
17310   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17311   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17312   (Exim $version_number)\n\t\
17313   ${if def:sender_address \
17314   {(envelope-from <$sender_address>)\n\t}}\
17315   id $message_exim_id\
17316   ${if def:received_for {\n\tfor $received_for}}
17317 .endd
17318
17319 The references to the TLS version and cipher are
17320 omitted when Exim is built without TLS
17321 support. The use of conditional expansions ensures that this works for both
17322 locally generated messages and messages received from remote hosts, giving
17323 header lines such as the following:
17324 .code
17325 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17326 by marley.carol.example with esmtp (Exim 4.00)
17327 (envelope-from <bob@carol.example>)
17328 id 16IOWa-00019l-00
17329 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17330 Received: by scrooge.carol.example with local (Exim 4.00)
17331 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17332 .endd
17333 Until the body of the message has been received, the timestamp is the time when
17334 the message started to be received. Once the body has arrived, and all policy
17335 checks have taken place, the timestamp is updated to the time at which the
17336 message was accepted.
17337
17338
17339 .option received_headers_max main integer 30
17340 .cindex "loop" "prevention"
17341 .cindex "mail loop prevention"
17342 .cindex "&'Received:'& header line" "counting"
17343 When a message is to be delivered, the number of &'Received:'& headers is
17344 counted, and if it is greater than this parameter, a mail loop is assumed to
17345 have occurred, the delivery is abandoned, and an error message is generated.
17346 This applies to both local and remote deliveries.
17347
17348
17349 .option recipient_unqualified_hosts main "host list&!!" unset
17350 .cindex "unqualified addresses"
17351 .cindex "host" "unqualified addresses from"
17352 This option lists those hosts from which Exim is prepared to accept unqualified
17353 recipient addresses in message envelopes. The addresses are made fully
17354 qualified by the addition of the &%qualify_recipient%& value. This option also
17355 affects message header lines. Exim does not reject unqualified recipient
17356 addresses in headers, but it qualifies them only if the message came from a
17357 host that matches &%recipient_unqualified_hosts%&,
17358 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17359 option was not set.
17360
17361
17362 .option recipients_max main integer 0
17363 .cindex "limit" "number of recipients"
17364 .cindex "recipient" "maximum number"
17365 If this option is set greater than zero, it specifies the maximum number of
17366 original recipients for any message. Additional recipients that are generated
17367 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17368 all recipients over the limit; earlier recipients are delivered as normal.
17369 Non-SMTP messages with too many recipients are failed, and no deliveries are
17370 done.
17371
17372 .cindex "RCPT" "maximum number of incoming"
17373 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17374 RCPT commands in a single message.
17375
17376
17377 .option recipients_max_reject main boolean false
17378 If this option is set true, Exim rejects SMTP messages containing too many
17379 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17380 error to the eventual DATA command. Otherwise (the default) it gives a 452
17381 error to the surplus RCPT commands and accepts the message on behalf of the
17382 initial set of recipients. The remote server should then re-send the message
17383 for the remaining recipients at a later time.
17384
17385
17386 .option remote_max_parallel main integer 2
17387 .cindex "delivery" "parallelism for remote"
17388 This option controls parallel delivery of one message to a number of remote
17389 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17390 does all the remote deliveries for a message one by one. Otherwise, if a single
17391 message has to be delivered to more than one remote host, or if several copies
17392 have to be sent to the same remote host, up to &%remote_max_parallel%&
17393 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17394 deliveries are required, the maximum number of processes are started, and as
17395 each one finishes, another is begun. The order of starting processes is the
17396 same as if sequential delivery were being done, and can be controlled by the
17397 &%remote_sort_domains%& option. If parallel delivery takes place while running
17398 with debugging turned on, the debugging output from each delivery process is
17399 tagged with its process id.
17400
17401 This option controls only the maximum number of parallel deliveries for one
17402 message in one Exim delivery process. Because Exim has no central queue
17403 manager, there is no way of controlling the total number of simultaneous
17404 deliveries if the configuration allows a delivery attempt as soon as a message
17405 is received.
17406
17407 See also the &%max_parallel%& generic transport option,
17408 and the &%serialize_hosts%& smtp transport option.
17409
17410 .cindex "number of deliveries"
17411 .cindex "delivery" "maximum number of"
17412 If you want to control the total number of deliveries on the system, you
17413 need to set the &%queue_only%& option. This ensures that all incoming messages
17414 are added to the queue without starting a delivery process. Then set up an Exim
17415 daemon to start queue runner processes at appropriate intervals (probably
17416 fairly often, for example, every minute), and limit the total number of queue
17417 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17418 delivers only one message at a time, the maximum number of deliveries that can
17419 then take place at once is &%queue_run_max%& multiplied by
17420 &%remote_max_parallel%&.
17421
17422 If it is purely remote deliveries you want to control, use
17423 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17424 doing the SMTP routing before queueing, so that several messages for the same
17425 host will eventually get delivered down the same connection.
17426
17427
17428 .option remote_sort_domains main "domain list&!!" unset
17429 .cindex "sorting remote deliveries"
17430 .cindex "delivery" "sorting remote"
17431 When there are a number of remote deliveries for a message, they are sorted by
17432 domain into the order given by this list. For example,
17433 .code
17434 remote_sort_domains = *.cam.ac.uk:*.uk
17435 .endd
17436 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17437 then to those in the &%uk%& domain, then to any others.
17438
17439
17440 .option retry_data_expire main time 7d
17441 .cindex "hints database" "data expiry"
17442 This option sets a &"use before"& time on retry information in Exim's hints
17443 database. Any older retry data is ignored. This means that, for example, once a
17444 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17445 past failures.
17446
17447
17448 .option retry_interval_max main time 24h
17449 .cindex "retry" "limit on interval"
17450 .cindex "limit" "on retry interval"
17451 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17452 intervals between delivery attempts for messages that cannot be delivered
17453 straight away. This option sets an overall limit to the length of time between
17454 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17455 the default value.
17456
17457
17458 .option return_path_remove main boolean true
17459 .cindex "&'Return-path:'& header line" "removing"
17460 RFC 2821, section 4.4, states that an SMTP server must insert a
17461 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17462 The &'Return-path:'& header preserves the sender address as received in the
17463 MAIL command. This description implies that this header should not be present
17464 in an incoming message. If &%return_path_remove%& is true, any existing
17465 &'Return-path:'& headers are removed from messages at the time they are
17466 received. Exim's transports have options for adding &'Return-path:'& headers at
17467 the time of delivery. They are normally used only for final local deliveries.
17468
17469
17470 .option return_size_limit main integer 100K
17471 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17472
17473
17474 .option rfc1413_hosts main "host list&!!" @[]
17475 .cindex "RFC 1413"
17476 .cindex "host" "for RFC 1413 calls"
17477 RFC 1413 identification calls are made to any client host which matches
17478 an item in the list.
17479 The default value specifies just this host, being any local interface
17480 for the system.
17481
17482 .option rfc1413_query_timeout main time 0s
17483 .cindex "RFC 1413" "query timeout"
17484 .cindex "timeout" "for RFC 1413 call"
17485 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17486 no RFC 1413 calls are ever made.
17487
17488
17489 .option sender_unqualified_hosts main "host list&!!" unset
17490 .cindex "unqualified addresses"
17491 .cindex "host" "unqualified addresses from"
17492 This option lists those hosts from which Exim is prepared to accept unqualified
17493 sender addresses. The addresses are made fully qualified by the addition of
17494 &%qualify_domain%&. This option also affects message header lines. Exim does
17495 not reject unqualified addresses in headers that contain sender addresses, but
17496 it qualifies them only if the message came from a host that matches
17497 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17498 using TCP/IP), and the &%-bnq%& option was not set.
17499
17500
17501 .option slow_lookup_log main integer 0
17502 .cindex "logging" "slow lookups"
17503 .cindex "dns" "logging slow lookups"
17504 This option controls logging of slow lookups.
17505 If the value is nonzero it is taken as a number of milliseconds
17506 and lookups taking longer than this are logged.
17507 Currently this applies only to DNS lookups.
17508
17509
17510
17511 .option smtp_accept_keepalive main boolean true
17512 .cindex "keepalive" "on incoming connection"
17513 This option controls the setting of the SO_KEEPALIVE option on incoming
17514 TCP/IP socket connections. When set, it causes the kernel to probe idle
17515 connections periodically, by sending packets with &"old"& sequence numbers. The
17516 other end of the connection should send an acknowledgment if the connection is
17517 still okay or a reset if the connection has been aborted. The reason for doing
17518 this is that it has the beneficial effect of freeing up certain types of
17519 connection that can get stuck when the remote host is disconnected without
17520 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17521 hours to detect unreachable hosts.
17522
17523
17524
17525 .option smtp_accept_max main integer 20
17526 .cindex "limit" "incoming SMTP connections"
17527 .cindex "SMTP" "incoming connection count"
17528 .cindex "inetd"
17529 This option specifies the maximum number of simultaneous incoming SMTP calls
17530 that Exim will accept. It applies only to the listening daemon; there is no
17531 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17532 value is set to zero, no limit is applied. However, it is required to be
17533 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17534 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17535
17536 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17537 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17538 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17539 and &%smtp_load_reserve%& are then checked before accepting the connection.
17540
17541
17542 .option smtp_accept_max_nonmail main integer 10
17543 .cindex "limit" "non-mail SMTP commands"
17544 .cindex "SMTP" "limiting non-mail commands"
17545 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17546 the connection if there are too many. This option defines &"too many"&. The
17547 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17548 client looping sending EHLO, for example. The check is applied only if the
17549 client host matches &%smtp_accept_max_nonmail_hosts%&.
17550
17551 When a new message is expected, one occurrence of RSET is not counted. This
17552 allows a client to send one RSET between messages (this is not necessary,
17553 but some clients do it). Exim also allows one uncounted occurrence of HELO
17554 or EHLO, and one occurrence of STARTTLS between messages. After
17555 starting up a TLS session, another EHLO is expected, and so it too is not
17556 counted. The first occurrence of AUTH in a connection, or immediately
17557 following STARTTLS is not counted. Otherwise, all commands other than
17558 MAIL, RCPT, DATA, and QUIT are counted.
17559
17560
17561 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17562 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17563 check by setting this option. The default value makes it apply to all hosts. By
17564 changing the value, you can exclude any badly-behaved hosts that you have to
17565 live with.
17566
17567
17568 . Allow this long option name to split; give it unsplit as a fifth argument
17569 . for the automatic .oindex that is generated by .option.
17570 . We insert " &~&~" which is both pretty nasty visually and results in
17571 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17572 . zero-width-space, which would be nicer visually and results in (at least)
17573 . html that Firefox will split on when it's forced to reflow (rather than
17574 . inserting a horizontal scrollbar).  However, the text is still not
17575 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17576 . the option name to split.
17577
17578 .option "smtp_accept_max_per_connection" main integer&!! 1000 &&&
17579          smtp_accept_max_per_connection
17580 .cindex "SMTP" "limiting incoming message count"
17581 .cindex "limit" "messages per SMTP connection"
17582 The value of this option limits the number of MAIL commands that Exim is
17583 prepared to accept over a single SMTP connection, whether or not each command
17584 results in the transfer of a message. After the limit is reached, a 421
17585 response is given to subsequent MAIL commands. This limit is a safety
17586 precaution against a client that goes mad (incidents of this type have been
17587 seen).
17588 .new
17589 The option is expanded after the HELO or EHLO is received
17590 and may depend on values available at that time.
17591 An empty or zero value after expansion removes the limit.
17592 .wen
17593
17594
17595 .option smtp_accept_max_per_host main string&!! unset
17596 .cindex "limit" "SMTP connections from one host"
17597 .cindex "host" "limiting SMTP connections from"
17598 This option restricts the number of simultaneous IP connections from a single
17599 host (strictly, from a single IP address) to the Exim daemon. The option is
17600 expanded, to enable different limits to be applied to different hosts by
17601 reference to &$sender_host_address$&. Once the limit is reached, additional
17602 connection attempts from the same host are rejected with error code 421. This
17603 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17604 of zero imposes no limit. If this option is set greater than zero, it is
17605 required that &%smtp_accept_max%& be non-zero.
17606
17607 &*Warning*&: When setting this option you should not use any expansion
17608 constructions that take an appreciable amount of time. The expansion and test
17609 happen in the main daemon loop, in order to reject additional connections
17610 without forking additional processes (otherwise a denial-of-service attack
17611 could cause a vast number or processes to be created). While the daemon is
17612 doing this processing, it cannot accept any other incoming connections.
17613
17614
17615
17616 .option smtp_accept_queue main integer 0
17617 .cindex "SMTP" "incoming connection count"
17618 .cindex "queueing incoming messages"
17619 .cindex "message" "queueing by SMTP connection count"
17620 If the number of simultaneous incoming SMTP connections being handled via the
17621 listening daemon exceeds this value, messages received by SMTP are just placed
17622 in the queue; no delivery processes are started automatically. The count is
17623 fixed at the start of an SMTP connection. It cannot be updated in the
17624 subprocess that receives messages, and so the queueing or not queueing applies
17625 to all messages received in the same connection.
17626
17627 A value of zero implies no limit, and clearly any non-zero value is useful only
17628 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17629 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17630 various &%-od%&&'x'& command line options.
17631
17632
17633 . See the comment on smtp_accept_max_per_connection
17634
17635 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17636          smtp_accept_queue_per_connection
17637 .cindex "queueing incoming messages"
17638 .cindex "message" "queueing by message count"
17639 This option limits the number of delivery processes that Exim starts
17640 automatically when receiving messages via SMTP, whether via the daemon or by
17641 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17642 and the number of messages received in a single SMTP session exceeds this
17643 number, subsequent messages are placed in the queue, but no delivery processes
17644 are started. This helps to limit the number of Exim processes when a server
17645 restarts after downtime and there is a lot of mail waiting for it on other
17646 systems. On large systems, the default should probably be increased, and on
17647 dial-in client systems it should probably be set to zero (that is, disabled).
17648
17649
17650 .option smtp_accept_reserve main integer 0
17651 .cindex "SMTP" "incoming call count"
17652 .cindex "host" "reserved"
17653 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17654 number of SMTP connections that are reserved for connections from the hosts
17655 that are specified in &%smtp_reserve_hosts%&. The value set in
17656 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17657 restricted to this number of connections; the option specifies a minimum number
17658 of connection slots for them, not a maximum. It is a guarantee that this group
17659 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17660 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17661 individual host.
17662
17663 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17664 set to 5, once there are 45 active connections (from any hosts), new
17665 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17666 provided the other criteria for acceptance are met.
17667
17668
17669 .option smtp_active_hostname main string&!! unset
17670 .cindex "host" "name in SMTP responses"
17671 .cindex "SMTP" "host name in responses"
17672 .vindex "&$primary_hostname$&"
17673 This option is provided for multi-homed servers that want to masquerade as
17674 several different hosts. At the start of an incoming SMTP connection, its value
17675 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17676 responses. For example, it is used as domain name in the response to an
17677 incoming HELO or EHLO command.
17678
17679 .vindex "&$smtp_active_hostname$&"
17680 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17681 is saved with any messages that are received. It is therefore available for use
17682 in routers and transports when the message is later delivered.
17683
17684 If this option is unset, or if its expansion is forced to fail, or if the
17685 expansion results in an empty string, the value of &$primary_hostname$& is
17686 used. Other expansion failures cause a message to be written to the main and
17687 panic logs, and the SMTP command receives a temporary error. Typically, the
17688 value of &%smtp_active_hostname%& depends on the incoming interface address.
17689 For example:
17690 .code
17691 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17692   {cox.mydomain}{box.mydomain}}
17693 .endd
17694
17695 Although &$smtp_active_hostname$& is primarily concerned with incoming
17696 messages, it is also used as the default for HELO commands in callout
17697 verification if there is no remote transport from which to obtain a
17698 &%helo_data%& value.
17699
17700 .option smtp_banner main string&!! "see below"
17701 .cindex "SMTP" "welcome banner"
17702 .cindex "banner for SMTP"
17703 .cindex "welcome banner for SMTP"
17704 .cindex "customizing" "SMTP banner"
17705 This string, which is expanded every time it is used, is output as the initial
17706 positive response to an SMTP connection. The default setting is:
17707 .code
17708 smtp_banner = $smtp_active_hostname ESMTP Exim \
17709   $version_number $tod_full
17710 .endd
17711 Failure to expand the string causes a panic error. If you want to create a
17712 multiline response to the initial SMTP connection, use &"\n"& in the string at
17713 appropriate points, but not at the end. Note that the 220 code is not included
17714 in this string. Exim adds it automatically (several times in the case of a
17715 multiline response).
17716
17717
17718 .option smtp_check_spool_space main boolean true
17719 .cindex "checking disk space"
17720 .cindex "disk space, checking"
17721 .cindex "spool directory" "checking space"
17722 When this option is set, if an incoming SMTP session encounters the SIZE
17723 option on a MAIL command, it checks that there is enough space in the
17724 spool directory's partition to accept a message of that size, while still
17725 leaving free the amount specified by &%check_spool_space%& (even if that value
17726 is zero). If there isn't enough space, a temporary error code is returned.
17727
17728
17729 .option smtp_connect_backlog main integer 20
17730 .cindex "connection backlog"
17731 .cindex "SMTP" "connection backlog"
17732 .cindex "backlog of connections"
17733 This option specifies a maximum number of waiting SMTP connections. Exim passes
17734 this value to the TCP/IP system when it sets up its listener. Once this number
17735 of connections are waiting for the daemon's attention, subsequent connection
17736 attempts are refused at the TCP/IP level. At least, that is what the manuals
17737 say; in some circumstances such connection attempts have been observed to time
17738 out instead. For large systems it is probably a good idea to increase the
17739 value (to 50, say). It also gives some protection against denial-of-service
17740 attacks by SYN flooding.
17741
17742
17743 .option smtp_enforce_sync main boolean true
17744 .cindex "SMTP" "synchronization checking"
17745 .cindex "synchronization checking in SMTP"
17746 The SMTP protocol specification requires the client to wait for a response from
17747 the server at certain points in the dialogue. Without PIPELINING these
17748 synchronization points are after every command; with PIPELINING they are
17749 fewer, but they still exist.
17750
17751 Some spamming sites send out a complete set of SMTP commands without waiting
17752 for any response. Exim protects against this by rejecting a message if the
17753 client has sent further input when it should not have. The error response &"554
17754 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17755 for this error cannot be perfect because of transmission delays (unexpected
17756 input may be on its way but not yet received when Exim checks). However, it
17757 does detect many instances.
17758
17759 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17760 If you want to disable the check selectively (for example, only for certain
17761 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17762 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17763
17764
17765
17766 .option smtp_etrn_command main string&!! unset
17767 .cindex "ETRN" "command to be run"
17768 .cindex "ESMTP extensions" ETRN
17769 .vindex "&$domain$&"
17770 If this option is set, the given command is run whenever an SMTP ETRN
17771 command is received from a host that is permitted to issue such commands (see
17772 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17773 are independently expanded. The expansion variable &$domain$& is set to the
17774 argument of the ETRN command, and no syntax checking is done on it. For
17775 example:
17776 .code
17777 smtp_etrn_command = /etc/etrn_command $domain \
17778                     $sender_host_address
17779 .endd
17780 If the option is not set, the argument for the ETRN command must
17781 be a &'#'& followed by an address string.
17782 In this case an &'exim -R <string>'& command is used;
17783 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17784
17785 A new process is created to run the command, but Exim does not wait for it to
17786 complete. Consequently, its status cannot be checked. If the command cannot be
17787 run, a line is written to the panic log, but the ETRN caller still receives
17788 a 250 success response. Exim is normally running under its own uid when
17789 receiving SMTP, so it is not possible for it to change the uid before running
17790 the command.
17791
17792
17793 .option smtp_etrn_serialize main boolean true
17794 .cindex "ETRN" "serializing"
17795 When this option is set, it prevents the simultaneous execution of more than
17796 one identical command as a result of ETRN in an SMTP connection. See
17797 section &<<SECTETRN>>& for details.
17798
17799
17800 .option smtp_load_reserve main fixed-point unset
17801 .cindex "load average"
17802 If the system load average ever gets higher than this, incoming SMTP calls are
17803 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17804 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17805 the load is over the limit. The option has no effect on ancient operating
17806 systems on which Exim cannot determine the load average. See also
17807 &%deliver_queue_load_max%& and &%queue_only_load%&.
17808
17809
17810
17811 .option smtp_max_synprot_errors main integer 3
17812 .cindex "SMTP" "limiting syntax and protocol errors"
17813 .cindex "limit" "SMTP syntax and protocol errors"
17814 Exim rejects SMTP commands that contain syntax or protocol errors. In
17815 particular, a syntactically invalid email address, as in this command:
17816 .code
17817 RCPT TO:<abc xyz@a.b.c>
17818 .endd
17819 causes immediate rejection of the command, before any other tests are done.
17820 (The ACL cannot be run if there is no valid address to set up for it.) An
17821 example of a protocol error is receiving RCPT before MAIL. If there are
17822 too many syntax or protocol errors in one SMTP session, the connection is
17823 dropped. The limit is set by this option.
17824
17825 .cindex "PIPELINING" "expected errors"
17826 When the PIPELINING extension to SMTP is in use, some protocol errors are
17827 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17828 Exim assumes that PIPELINING will be used if it advertises it (see
17829 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17830 not count towards the limit.
17831
17832
17833
17834 .option smtp_max_unknown_commands main integer 3
17835 .cindex "SMTP" "limiting unknown commands"
17836 .cindex "limit" "unknown SMTP commands"
17837 If there are too many unrecognized commands in an incoming SMTP session, an
17838 Exim server drops the connection. This is a defence against some kinds of abuse
17839 that subvert web
17840 clients
17841 into making connections to SMTP ports; in these circumstances, a number of
17842 non-SMTP command lines are sent first.
17843
17844
17845
17846 .option smtp_ratelimit_hosts main "host list&!!" unset
17847 .cindex "SMTP" "rate limiting"
17848 .cindex "limit" "rate of message arrival"
17849 .cindex "RCPT" "rate limiting"
17850 Some sites find it helpful to be able to limit the rate at which certain hosts
17851 can send them messages, and the rate at which an individual message can specify
17852 recipients.
17853
17854 Exim has two rate-limiting facilities. This section describes the older
17855 facility, which can limit rates within a single connection. The newer
17856 &%ratelimit%& ACL condition can limit rates across all connections. See section
17857 &<<SECTratelimiting>>& for details of the newer facility.
17858
17859 When a host matches &%smtp_ratelimit_hosts%&, the values of
17860 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17861 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17862 respectively. Each option, if set, must contain a set of four comma-separated
17863 values:
17864
17865 .ilist
17866 A threshold, before which there is no rate limiting.
17867 .next
17868 An initial time delay. Unlike other times in Exim, numbers with decimal
17869 fractional parts are allowed here.
17870 .next
17871 A factor by which to increase the delay each time.
17872 .next
17873 A maximum value for the delay. This should normally be less than 5 minutes,
17874 because after that time, the client is liable to timeout the SMTP command.
17875 .endlist
17876
17877 For example, these settings have been used successfully at the site which
17878 first suggested this feature, for controlling mail from their customers:
17879 .code
17880 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17881 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17882 .endd
17883 The first setting specifies delays that are applied to MAIL commands after
17884 two have been received over a single connection. The initial delay is 0.5
17885 seconds, increasing by a factor of 1.05 each time. The second setting applies
17886 delays to RCPT commands when more than four occur in a single message.
17887
17888
17889 .option smtp_ratelimit_mail main string unset
17890 See &%smtp_ratelimit_hosts%& above.
17891
17892
17893 .option smtp_ratelimit_rcpt main string unset
17894 See &%smtp_ratelimit_hosts%& above.
17895
17896
17897 .option smtp_receive_timeout main time&!! 5m
17898 .cindex "timeout" "for SMTP input"
17899 .cindex "SMTP" "input timeout"
17900 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17901 input, including batch SMTP. If a line of input (either an SMTP command or a
17902 data line) is not received within this time, the SMTP connection is dropped and
17903 the message is abandoned.
17904 A line is written to the log containing one of the following messages:
17905 .code
17906 SMTP command timeout on connection from...
17907 SMTP data timeout on connection from...
17908 .endd
17909 The former means that Exim was expecting to read an SMTP command; the latter
17910 means that it was in the DATA phase, reading the contents of a message.
17911
17912 If the first character of the option is a &"$"& the option is
17913 expanded before use and may depend on
17914 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17915
17916
17917 .oindex "&%-os%&"
17918 The value set by this option can be overridden by the
17919 &%-os%& command-line option. A setting of zero time disables the timeout, but
17920 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17921 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17922 timeout is controlled by &%receive_timeout%& and &%-or%&.
17923
17924
17925 .option smtp_reserve_hosts main "host list&!!" unset
17926 This option defines hosts for which SMTP connections are reserved; see
17927 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17928
17929
17930 .option smtp_return_error_details main boolean false
17931 .cindex "SMTP" "details policy failures"
17932 .cindex "policy control" "rejection, returning details"
17933 In the default state, Exim uses bland messages such as
17934 &"Administrative prohibition"& when it rejects SMTP commands for policy
17935 reasons. Many sysadmins like this because it gives away little information
17936 to spammers. However, some other sysadmins who are applying strict checking
17937 policies want to give out much fuller information about failures. Setting
17938 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17939 example, instead of &"Administrative prohibition"&, it might give:
17940 .code
17941 550-Rejected after DATA: '>' missing at end of address:
17942 550 failing address in "From" header is: <user@dom.ain
17943 .endd
17944
17945
17946 .option smtputf8_advertise_hosts main "host list&!!" *
17947 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17948 .cindex "ESMTP extensions" SMTPUTF8
17949 When Exim is built with support for internationalised mail names,
17950 the availability thereof is advertised in
17951 response to EHLO only to those client hosts that match this option. See
17952 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17953
17954
17955 .option spamd_address main string "127.0.0.1 783"
17956 This option is available when Exim is compiled with the content-scanning
17957 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17958 See section &<<SECTscanspamass>>& for more details.
17959
17960
17961
17962 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17963 This option is available when Exim is compiled with SPF support.
17964 See section &<<SECSPF>>& for more details.
17965
17966 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17967 This option is available when Exim is compiled with SPF support.  It
17968 allows the customisation of the SMTP comment that the SPF library
17969 generates.  You are strongly encouraged to link to your own explanative
17970 site. The template must not contain spaces. If you need spaces in the
17971 output, use the proper placeholder. If libspf2 can not parse the
17972 template, it uses a built-in default broken link. The following placeholders
17973 (along with Exim variables (but see below)) are allowed in the template:
17974 .ilist
17975 &*%_*&: A space.
17976 .next
17977 &*%{L}*&: Envelope sender's local part.
17978 .next
17979 &*%{S}*&: Envelope sender.
17980 .next
17981 &*%{O}*&: Envelope sender's domain.
17982 .next
17983 &*%{D}*&: Current(?) domain.
17984 .next
17985 &*%{I}*&: SMTP client Ip.
17986 .next
17987 &*%{C}*&: SMTP client pretty IP.
17988 .next
17989 &*%{T}*&: Epoch time (UTC).
17990 .next
17991 &*%{P}*&: SMTP client domain name.
17992 .next
17993 &*%{V}*&: IP version.
17994 .next
17995 &*%{H}*&: EHLO/HELO domain.
17996 .next
17997 &*%{R}*&: Receiving domain.
17998 .endlist
17999 The capitalized placeholders do proper URL encoding, if you use them
18000 lowercased, no encoding takes place.  This list was compiled from the
18001 libspf2 sources.
18002
18003 A note on using Exim variables: As
18004 currently the SPF library is initialized before the SMTP EHLO phase,
18005 the variables useful for expansion are quite limited.
18006
18007
18008 .option split_spool_directory main boolean false
18009 .cindex "multiple spool directories"
18010 .cindex "spool directory" "split"
18011 .cindex "directories, multiple"
18012 If this option is set, it causes Exim to split its input directory into 62
18013 subdirectories, each with a single alphanumeric character as its name. The
18014 sixth character of the message id is used to allocate messages to
18015 subdirectories; this is the least significant base-62 digit of the time of
18016 arrival of the message.
18017
18018 Splitting up the spool in this way may provide better performance on systems
18019 where there are long mail queues, by reducing the number of files in any one
18020 directory. The msglog directory is also split up in a similar way to the input
18021 directory; however, if &%preserve_message_logs%& is set, all old msglog files
18022 are still placed in the single directory &_msglog.OLD_&.
18023
18024 It is not necessary to take any special action for existing messages when
18025 changing &%split_spool_directory%&. Exim notices messages that are in the
18026 &"wrong"& place, and continues to process them. If the option is turned off
18027 after a period of being on, the subdirectories will eventually empty and be
18028 automatically deleted.
18029
18030 When &%split_spool_directory%& is set, the behaviour of queue runner processes
18031 changes. Instead of creating a list of all messages in the queue, and then
18032 trying to deliver each one, in turn, it constructs a list of those in one
18033 sub-directory and tries to deliver them, before moving on to the next
18034 sub-directory. The sub-directories are processed in a random order. This
18035 spreads out the scanning of the input directories, and uses less memory. It is
18036 particularly beneficial when there are lots of messages in the queue. However,
18037 if &%queue_run_in_order%& is set, none of this new processing happens. The
18038 entire queue has to be scanned and sorted before any deliveries can start.
18039
18040
18041 .option spool_directory main string&!! "set at compile time"
18042 .cindex "spool directory" "path to"
18043 This defines the directory in which Exim keeps its spool, that is, the messages
18044 it is waiting to deliver. The default value is taken from the compile-time
18045 configuration setting, if there is one. If not, this option must be set. The
18046 string is expanded, so it can contain, for example, a reference to
18047 &$primary_hostname$&.
18048
18049 If the spool directory name is fixed on your installation, it is recommended
18050 that you set it at build time rather than from this option, particularly if the
18051 log files are being written to the spool directory (see &%log_file_path%&).
18052 Otherwise log files cannot be used for errors that are detected early on, such
18053 as failures in the configuration file.
18054
18055 By using this option to override the compiled-in path, it is possible to run
18056 tests of Exim without using the standard spool.
18057
18058 .option spool_wireformat main boolean false
18059 .cindex "spool directory" "file formats"
18060 If this option is set, Exim may for some messages use an alternative format
18061 for data-files in the spool which matches the wire format.
18062 Doing this permits more efficient message reception and transmission.
18063 Currently it is only done for messages received using the ESMTP CHUNKING
18064 option.
18065
18066 The following variables will not have useful values:
18067 .code
18068 $max_received_linelength
18069 $body_linecount
18070 $body_zerocount
18071 .endd
18072
18073 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
18074 and any external programs which are passed a reference to a message data file
18075 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
18076 will need to be aware of the different formats potentially available.
18077
18078 Using any of the ACL conditions noted will negate the reception benefit
18079 (as a Unix-mbox-format file is constructed for them).
18080 The transmission benefit is maintained.
18081
18082 .option sqlite_lock_timeout main time 5s
18083 .cindex "sqlite lookup type" "lock timeout"
18084 This option controls the timeout that the &(sqlite)& lookup uses when trying to
18085 access an SQLite database. See section &<<SECTsqlite>>& for more details.
18086
18087 .option strict_acl_vars main boolean false
18088 .cindex "&ACL;" "variables, handling unset"
18089 This option controls what happens if a syntactically valid but undefined ACL
18090 variable is referenced. If it is false (the default), an empty string
18091 is substituted; if it is true, an error is generated. See section
18092 &<<SECTaclvariables>>& for details of ACL variables.
18093
18094 .option strip_excess_angle_brackets main boolean false
18095 .cindex "angle brackets, excess"
18096 If this option is set, redundant pairs of angle brackets round &"route-addr"&
18097 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
18098 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
18099 passed on to another MTA, the excess angle brackets are not passed on. If this
18100 option is not set, multiple pairs of angle brackets cause a syntax error.
18101
18102
18103 .option strip_trailing_dot main boolean false
18104 .cindex "trailing dot on domain"
18105 .cindex "dot" "trailing on domain"
18106 If this option is set, a trailing dot at the end of a domain in an address is
18107 ignored. If this is in the envelope and the message is passed on to another
18108 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
18109 domain causes a syntax error.
18110 However, addresses in header lines are checked only when an ACL requests header
18111 syntax checking.
18112
18113
18114 .option syslog_duplication main boolean true
18115 .cindex "syslog" "duplicate log lines; suppressing"
18116 When Exim is logging to syslog, it writes the log lines for its three
18117 separate logs at different syslog priorities so that they can in principle
18118 be separated on the logging hosts. Some installations do not require this
18119 separation, and in those cases, the duplication of certain log lines is a
18120 nuisance. If &%syslog_duplication%& is set false, only one copy of any
18121 particular log line is written to syslog. For lines that normally go to
18122 both the main log and the reject log, the reject log version (possibly
18123 containing message header lines) is written, at LOG_NOTICE priority.
18124 Lines that normally go to both the main and the panic log are written at
18125 the LOG_ALERT priority.
18126
18127
18128 .option syslog_facility main string unset
18129 .cindex "syslog" "facility; setting"
18130 This option sets the syslog &"facility"& name, used when Exim is logging to
18131 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
18132 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
18133 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
18134 details of Exim's logging.
18135
18136
18137 .option syslog_pid main boolean true
18138 .cindex "syslog" "pid"
18139 If &%syslog_pid%& is set false, the PID on Exim's log lines are
18140 omitted when these lines are sent to syslog. (Syslog normally prefixes
18141 the log lines with the PID of the logging process automatically.) You need
18142 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
18143 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
18144
18145
18146
18147 .option syslog_processname main string &`exim`&
18148 .cindex "syslog" "process name; setting"
18149 This option sets the syslog &"ident"& name, used when Exim is logging to
18150 syslog. The value must be no longer than 32 characters. See chapter
18151 &<<CHAPlog>>& for details of Exim's logging.
18152
18153
18154
18155 .option syslog_timestamp main boolean true
18156 .cindex "syslog" "timestamps"
18157 .cindex timestamps syslog
18158 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
18159 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
18160 details of Exim's logging.
18161
18162
18163 .option system_filter main string&!! unset
18164 .cindex "filter" "system filter"
18165 .cindex "system filter" "specifying"
18166 .cindex "Sieve filter" "not available for system filter"
18167 This option specifies an Exim filter file that is applied to all messages at
18168 the start of each delivery attempt, before any routing is done. System filters
18169 must be Exim filters; they cannot be Sieve filters. If the system filter
18170 generates any deliveries to files or pipes, or any new mail messages, the
18171 appropriate &%system_filter_..._transport%& option(s) must be set, to define
18172 which transports are to be used. Details of this facility are given in chapter
18173 &<<CHAPsystemfilter>>&.
18174 A forced expansion failure results in no filter operation.
18175
18176
18177 .option system_filter_directory_transport main string&!! unset
18178 .vindex "&$address_file$&"
18179 This sets the name of the transport driver that is to be used when the
18180 &%save%& command in a system message filter specifies a path ending in &"/"&,
18181 implying delivery of each message into a separate file in some directory.
18182 During the delivery, the variable &$address_file$& contains the path name.
18183
18184
18185 .option system_filter_file_transport main string&!! unset
18186 .cindex "file" "transport for system filter"
18187 This sets the name of the transport driver that is to be used when the &%save%&
18188 command in a system message filter specifies a path not ending in &"/"&. During
18189 the delivery, the variable &$address_file$& contains the path name.
18190
18191 .option system_filter_group main string unset
18192 .cindex "gid (group id)" "system filter"
18193 This option is used only when &%system_filter_user%& is also set. It sets the
18194 gid under which the system filter is run, overriding any gid that is associated
18195 with the user. The value may be numerical or symbolic.
18196
18197 .option system_filter_pipe_transport main string&!! unset
18198 .cindex "&(pipe)& transport" "for system filter"
18199 .vindex "&$address_pipe$&"
18200 This specifies the transport driver that is to be used when a &%pipe%& command
18201 is used in a system filter. During the delivery, the variable &$address_pipe$&
18202 contains the pipe command.
18203
18204
18205 .option system_filter_reply_transport main string&!! unset
18206 .cindex "&(autoreply)& transport" "for system filter"
18207 This specifies the transport driver that is to be used when a &%mail%& command
18208 is used in a system filter.
18209
18210
18211 .option system_filter_user main string unset
18212 .cindex "uid (user id)" "system filter"
18213 If this option is set to root, the system filter is run in the main Exim
18214 delivery process, as root.  Otherwise, the system filter runs in a separate
18215 process, as the given user, defaulting to the Exim run-time user.
18216 Unless the string consists entirely of digits, it
18217 is looked up in the password data. Failure to find the named user causes a
18218 configuration error. The gid is either taken from the password data, or
18219 specified by &%system_filter_group%&. When the uid is specified numerically,
18220 &%system_filter_group%& is required to be set.
18221
18222 If the system filter generates any pipe, file, or reply deliveries, the uid
18223 under which the filter is run is used when transporting them, unless a
18224 transport option overrides.
18225
18226
18227 .option tcp_nodelay main boolean true
18228 .cindex "daemon" "TCP_NODELAY on sockets"
18229 .cindex "Nagle algorithm"
18230 .cindex "TCP_NODELAY on listening sockets"
18231 If this option is set false, it stops the Exim daemon setting the
18232 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18233 turns off the &"Nagle algorithm"&, which is a way of improving network
18234 performance in interactive (character-by-character) situations. Turning it off
18235 should improve Exim's performance a bit, so that is what happens by default.
18236 However, it appears that some broken clients cannot cope, and time out. Hence
18237 this option. It affects only those sockets that are set up for listening by the
18238 daemon. Sockets created by the smtp transport for delivering mail always set
18239 TCP_NODELAY.
18240
18241
18242 .option timeout_frozen_after main time 0s
18243 .cindex "frozen messages" "timing out"
18244 .cindex "timeout" "frozen messages"
18245 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18246 message of any kind that has been in the queue for longer than the given time
18247 is automatically cancelled at the next queue run. If the frozen message is a
18248 bounce message, it is just discarded; otherwise, a bounce is sent to the
18249 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18250 If you want to timeout frozen bounce messages earlier than other kinds of
18251 frozen message, see &%ignore_bounce_errors_after%&.
18252
18253 &*Note:*& the default value of zero means no timeouts; with this setting,
18254 frozen messages remain in the queue forever (except for any frozen bounce
18255 messages that are released by &%ignore_bounce_errors_after%&).
18256
18257
18258 .option timezone main string unset
18259 .cindex "timezone, setting"
18260 .cindex "environment" "values from"
18261 The value of &%timezone%& is used to set the environment variable TZ while
18262 running Exim (if it is different on entry). This ensures that all timestamps
18263 created by Exim are in the required timezone. If you want all your timestamps
18264 to be in UTC (aka GMT) you should set
18265 .code
18266 timezone = UTC
18267 .endd
18268 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18269 or, if that is not set, from the value of the TZ environment variable when Exim
18270 is built. If &%timezone%& is set to the empty string, either at build or run
18271 time, any existing TZ variable is removed from the environment when Exim
18272 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18273 unfortunately not all, operating systems.
18274
18275
18276 .option tls_advertise_hosts main "host list&!!" *
18277 .cindex "TLS" "advertising"
18278 .cindex "encryption" "on SMTP connection"
18279 .cindex "SMTP" "encrypted connection"
18280 .cindex "ESMTP extensions" STARTTLS
18281 When Exim is built with support for TLS encrypted connections, the availability
18282 of the STARTTLS command to set up an encrypted session is advertised in
18283 response to EHLO only to those client hosts that match this option. See
18284 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18285 Note that the default value requires that a certificate be supplied
18286 using the &%tls_certificate%& option.  If TLS support for incoming connections
18287 is not required the &%tls_advertise_hosts%& option should be set empty.
18288
18289
18290 .option tls_certificate main string list&!! unset
18291 .cindex "TLS" "server certificate; location of"
18292 .cindex "certificate" "server, location of"
18293 The value of this option is expanded, and must then be a list of absolute paths to
18294 files which contain the server's certificates (in PEM format).
18295 Commonly only one file is needed.
18296 The server's private key is also
18297 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18298 &<<CHAPTLS>>& for further details.
18299
18300 &*Note*&: The certificates defined by this option are used only when Exim is
18301 receiving incoming messages as a server. If you want to supply certificates for
18302 use when sending messages as a client, you must set the &%tls_certificate%&
18303 option in the relevant &(smtp)& transport.
18304
18305 &*Note*&: If you use filenames based on IP addresses, change the list
18306 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18307
18308 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18309 when a list of more than one
18310 file is used, the &$tls_in_ourcert$& variable is unreliable.
18311 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18312
18313 .cindex SNI "selecting server certificate based on"
18314 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18315 if the OpenSSL build supports TLS extensions and the TLS client sends the
18316 Server Name Indication extension, then this option and others documented in
18317 &<<SECTtlssni>>& will be re-expanded.
18318
18319 If this option is unset or empty a fresh self-signed certificate will be
18320 generated for every connection.
18321
18322 .option tls_crl main string&!! unset
18323 .cindex "TLS" "server certificate revocation list"
18324 .cindex "certificate" "revocation list for server"
18325 This option specifies a certificate revocation list. The expanded value must
18326 be the name of a file that contains CRLs in PEM format.
18327
18328 Under OpenSSL the option can specify a directory with CRL files.
18329
18330 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18331 for each signing element of the certificate chain (i.e. all but the leaf).
18332 For the file variant this can be multiple PEM blocks in the one file.
18333
18334 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18335
18336
18337 .option tls_dh_max_bits main integer 2236
18338 .cindex "TLS" "D-H bit count"
18339 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18340 the chosen TLS library.  That value might prove to be too high for
18341 interoperability.  This option provides a maximum clamp on the value
18342 suggested, trading off security for interoperability.
18343
18344 The value must be at least 1024.
18345
18346 The value 2236 was chosen because, at time of adding the option, it was the
18347 hard-coded maximum value supported by the NSS cryptographic library, as used
18348 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18349
18350 If you prefer more security and are willing to break some clients, raise this
18351 number.
18352
18353 Note that the value passed to GnuTLS for *generating* a new prime may be a
18354 little less than this figure, because GnuTLS is inexact and may produce a
18355 larger prime than requested.
18356
18357
18358 .option tls_dhparam main string&!! unset
18359 .cindex "TLS" "D-H parameters for server"
18360 The value of this option is expanded and indicates the source of DH parameters
18361 to be used by Exim.
18362
18363 This option is ignored for GnuTLS version 3.6.0 and later.
18364 The library manages parameter negotiation internally.
18365
18366 &*Note: The Exim Maintainers strongly recommend,
18367 for other TLS library versions,
18368 using a filename with site-generated
18369 local DH parameters*&, which has been supported across all versions of Exim.  The
18370 other specific constants available are a fallback so that even when
18371 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18372
18373 If &%tls_dhparam%& is a filename starting with a &`/`&,
18374 then it names a file from which DH
18375 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18376 PKCS#3 representation of the DH prime.  If the file does not exist, for
18377 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18378 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18379 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18380 and treated as though the &%tls_dhparam%& were set to "none".
18381
18382 If this option expands to the string "none", then no DH parameters will be
18383 loaded by Exim.
18384
18385 If this option expands to the string "historic" and Exim is using GnuTLS, then
18386 Exim will attempt to load a file from inside the spool directory.  If the file
18387 does not exist, Exim will attempt to create it.
18388 See section &<<SECTgnutlsparam>>& for further details.
18389
18390 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18391 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18392
18393 In older versions of Exim the default was the 2048 bit prime described in section
18394 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18395 in IKE is assigned number 23.
18396
18397 Otherwise, the option must expand to the name used by Exim for any of a number
18398 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18399 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18400 the number used by IKE, or "default" which corresponds to
18401 &`exim.dev.20160529.3`&.
18402
18403 The available standard primes are:
18404 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18405 &`ike1`&, &`ike2`&, &`ike5`&,
18406 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18407 &`ike22`&, &`ike23`& and &`ike24`&.
18408
18409 The available additional primes are:
18410 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18411
18412 Some of these will be too small to be accepted by clients.
18413 Some may be too large to be accepted by clients.
18414 The open cryptographic community has suspicions about the integrity of some
18415 of the later IKE values, which led into RFC7919 providing new fixed constants
18416 (the "ffdhe" identifiers).
18417
18418 At this point, all of the "ike" values should be considered obsolete;
18419 they're still in Exim to avoid breaking unusual configurations, but are
18420 candidates for removal the next time we have backwards-incompatible changes.
18421
18422 The TLS protocol does not negotiate an acceptable size for this; clients tend
18423 to hard-drop connections if what is offered by the server is unacceptable,
18424 whether too large or too small, and there's no provision for the client to
18425 tell the server what these constraints are.  Thus, as a server operator, you
18426 need to make an educated guess as to what is most likely to work for your
18427 userbase.
18428
18429 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18430 is most likely to maximise interoperability.  The upper bound comes from
18431 applications using the Mozilla Network Security Services (NSS) library, which
18432 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18433 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18434 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18435 acceptable bound from 1024 to 2048.
18436
18437
18438 .option tls_eccurve main string&!! &`auto`&
18439 .cindex TLS "EC cryptography"
18440 This option selects a EC curve for use by Exim when used with OpenSSL.
18441 It has no effect when Exim is used with GnuTLS.
18442
18443 After expansion it must contain a valid EC curve parameter, such as
18444 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18445 for valid selections.
18446
18447 For OpenSSL versions before (and not including) 1.0.2, the string
18448 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18449 &`auto`& tells the library to choose.
18450
18451 If the option expands to an empty string, no EC curves will be enabled.
18452
18453
18454 .option tls_ocsp_file main string&!! unset
18455 .cindex TLS "certificate status"
18456 .cindex TLS "OCSP proof file"
18457 This option
18458 must if set expand to the absolute path to a file which contains a current
18459 status proof for the server's certificate, as obtained from the
18460 Certificate Authority.
18461
18462 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18463 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18464
18465 For OpenSSL 1.1.0 or later, and
18466 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18467 of files, to match a list given for the &%tls_certificate%& option.
18468 The ordering of the two lists must match.
18469 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18470
18471 The file(s) should be in DER format,
18472 except for GnuTLS 3.6.3 or later
18473 or for OpenSSL,
18474 when an optional filetype prefix can be used.
18475 The prefix must be one of "DER" or "PEM", followed by
18476 a single space.  If one is used it sets the format for subsequent
18477 files in the list; the initial format is DER.
18478 If multiple proofs are wanted, for multiple chain elements
18479 (this only works under TLS1.3)
18480 they must be coded as a combined OCSP response.
18481
18482 Although GnuTLS will accept PEM files with multiple separate
18483 PEM blobs (ie. separate OCSP responses), it sends them in the
18484 TLS Certificate record interleaved with the certificates of the chain;
18485 although a GnuTLS client is happy with that, an OpenSSL client is not.
18486
18487 .option tls_on_connect_ports main "string list" unset
18488 .cindex SSMTP
18489 .cindex SMTPS
18490 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18491 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18492 set up without waiting for the client to issue a STARTTLS command. For
18493 further details, see section &<<SECTsupobssmt>>&.
18494
18495
18496
18497 .option tls_privatekey main string list&!! unset
18498 .cindex "TLS" "server private key; location of"
18499 The value of this option is expanded, and must then be a list of absolute paths to
18500 files which contains the server's private keys.
18501 If this option is unset, or if
18502 the expansion is forced to fail, or the result is an empty string, the private
18503 key is assumed to be in the same file as the server's certificates. See chapter
18504 &<<CHAPTLS>>& for further details.
18505
18506 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18507
18508
18509 .option tls_remember_esmtp main boolean false
18510 .cindex "TLS" "esmtp state; remembering"
18511 .cindex "TLS" "broken clients"
18512 If this option is set true, Exim violates the RFCs by remembering that it is in
18513 &"esmtp"& state after successfully negotiating a TLS session. This provides
18514 support for broken clients that fail to send a new EHLO after starting a
18515 TLS session.
18516
18517
18518 .option tls_require_ciphers main string&!! unset
18519 .cindex "TLS" "requiring specific ciphers"
18520 .cindex "cipher" "requiring specific"
18521 This option controls which ciphers can be used for incoming TLS connections.
18522 The &(smtp)& transport has an option of the same name for controlling outgoing
18523 connections. This option is expanded for each connection, so can be varied for
18524 different clients if required. The value of this option must be a list of
18525 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18526 in somewhat different ways. If GnuTLS is being used, the client controls the
18527 preference order of the available ciphers. Details are given in sections
18528 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18529
18530
18531 .new
18532 .option tls_resumption_hosts main "host list&!!" unset
18533 .cindex TLS resumption
18534 This option controls which connections to offer the TLS resumption feature.
18535 See &<<SECTresumption>>& for details.
18536 .wen
18537
18538
18539 .option tls_try_verify_hosts main "host list&!!" unset
18540 .cindex "TLS" "client certificate verification"
18541 .cindex "certificate" "verification of client"
18542 See &%tls_verify_hosts%& below.
18543
18544
18545 .option tls_verify_certificates main string&!! system
18546 .cindex "TLS" "client certificate verification"
18547 .cindex "certificate" "verification of client"
18548 The value of this option is expanded, and must then be either the
18549 word "system"
18550 or the absolute path to
18551 a file or directory containing permitted certificates for clients that
18552 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18553
18554 The "system" value for the option will use a
18555 system default location compiled into the SSL library.
18556 This is not available for GnuTLS versions preceding 3.0.20,
18557 and will be taken as empty; an explicit location
18558 must be specified.
18559
18560 The use of a directory for the option value is not available for GnuTLS versions
18561 preceding 3.3.6 and a single file must be used.
18562
18563 With OpenSSL the certificates specified
18564 explicitly
18565 either by file or directory
18566 are added to those given by the system default location.
18567
18568 These certificates should be for the certificate authorities trusted, rather
18569 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18570 the value is a file then the certificates are sent by Exim as a server to
18571 connecting clients, defining the list of accepted certificate authorities.
18572 Thus the values defined should be considered public data.  To avoid this,
18573 use the explicit directory version. (If your peer is Exim up to 4.85,
18574 using GnuTLS, you may need to send the CAs (thus using the file
18575 variant). Otherwise the peer doesn't send its certificate.)
18576
18577 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18578
18579 A forced expansion failure or setting to an empty string is equivalent to
18580 being unset.
18581
18582
18583 .option tls_verify_hosts main "host list&!!" unset
18584 .cindex "TLS" "client certificate verification"
18585 .cindex "certificate" "verification of client"
18586 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18587 certificates from clients. The expected certificates are defined by
18588 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18589 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18590 &%tls_verify_certificates%& is not set.
18591
18592 Any client that matches &%tls_verify_hosts%& is constrained by
18593 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18594 present one of the listed certificates. If it does not, the connection is
18595 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18596 the host to use TLS. It can still send SMTP commands through unencrypted
18597 connections. Forcing a client to use TLS has to be done separately using an
18598 ACL to reject inappropriate commands when the connection is not encrypted.
18599
18600 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18601 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18602 certificate and checks it against &%tls_verify_certificates%&, but does not
18603 abort the connection if there is no certificate or if it does not match. This
18604 state can be detected in an ACL, which makes it possible to implement policies
18605 such as &"accept for relay only if a verified certificate has been received,
18606 but accept for local delivery if encrypted, even without a verified
18607 certificate"&.
18608
18609 Client hosts that match neither of these lists are not asked to present
18610 certificates.
18611
18612
18613 .option trusted_groups main "string list&!!" unset
18614 .cindex "trusted groups"
18615 .cindex "groups" "trusted"
18616 This option is expanded just once, at the start of Exim's processing. If this
18617 option is set, any process that is running in one of the listed groups, or
18618 which has one of them as a supplementary group, is trusted. The groups can be
18619 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18620 details of what trusted callers are permitted to do. If neither
18621 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18622 are trusted.
18623
18624 .option trusted_users main "string list&!!" unset
18625 .cindex "trusted users"
18626 .cindex "user" "trusted"
18627 This option is expanded just once, at the start of Exim's processing. If this
18628 option is set, any process that is running as one of the listed users is
18629 trusted. The users can be specified numerically or by name. See section
18630 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18631 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18632 Exim user are trusted.
18633
18634 .option unknown_login main string&!! unset
18635 .cindex "uid (user id)" "unknown caller"
18636 .vindex "&$caller_uid$&"
18637 This is a specialized feature for use in unusual configurations. By default, if
18638 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18639 gives up. The &%unknown_login%& option can be used to set a login name to be
18640 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18641 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18642 is used for the user's real name (gecos field), unless this has been set by the
18643 &%-F%& option.
18644
18645 .option unknown_username main string unset
18646 See &%unknown_login%&.
18647
18648 .option untrusted_set_sender main "address list&!!" unset
18649 .cindex "trusted users"
18650 .cindex "sender" "setting by untrusted user"
18651 .cindex "untrusted user setting sender"
18652 .cindex "user" "untrusted setting sender"
18653 .cindex "envelope from"
18654 .cindex "envelope sender"
18655 When an untrusted user submits a message to Exim using the standard input, Exim
18656 normally creates an envelope sender address from the user's login and the
18657 default qualification domain. Data from the &%-f%& option (for setting envelope
18658 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18659 is used) is ignored.
18660
18661 However, untrusted users are permitted to set an empty envelope sender address,
18662 to declare that a message should never generate any bounces. For example:
18663 .code
18664 exim -f '<>' user@domain.example
18665 .endd
18666 .vindex "&$sender_ident$&"
18667 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18668 other envelope sender addresses in a controlled way. When it is set, untrusted
18669 users are allowed to set envelope sender addresses that match any of the
18670 patterns in the list. Like all address lists, the string is expanded. The
18671 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18672 users to setting senders that start with their login ids
18673 followed by a hyphen
18674 by a setting like this:
18675 .code
18676 untrusted_set_sender = ^$sender_ident-
18677 .endd
18678 If you want to allow untrusted users to set envelope sender addresses without
18679 restriction, you can use
18680 .code
18681 untrusted_set_sender = *
18682 .endd
18683 The &%untrusted_set_sender%& option applies to all forms of local input, but
18684 only to the setting of the envelope sender. It does not permit untrusted users
18685 to use the other options which trusted user can use to override message
18686 parameters. Furthermore, it does not stop Exim from removing an existing
18687 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18688 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18689 overriding these actions. The handling of the &'Sender:'& header is also
18690 described in section &<<SECTthesenhea>>&.
18691
18692 The log line for a message's arrival shows the envelope sender following
18693 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18694 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18695 envelope sender address, the user's login is shown in parentheses after the
18696 sender address.
18697
18698
18699 .option uucp_from_pattern main string "see below"
18700 .cindex "&""From""& line"
18701 .cindex "UUCP" "&""From""& line"
18702 Some applications that pass messages to an MTA via a command line interface use
18703 an initial line starting with &"From&~"& to pass the envelope sender. In
18704 particular, this is used by UUCP software. Exim recognizes such a line by means
18705 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18706 matches, the sender address is constructed by expanding the contents of
18707 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18708 default pattern recognizes lines in the following two forms:
18709 .code
18710 From ph10 Fri Jan  5 12:35 GMT 1996
18711 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18712 .endd
18713 The pattern can be seen by running
18714 .code
18715 exim -bP uucp_from_pattern
18716 .endd
18717 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18718 year in the second case. The first word after &"From&~"& is matched in the
18719 regular expression by a parenthesized subpattern. The default value for
18720 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18721 (&"ph10"& in the example above) as the message's sender. See also
18722 &%ignore_fromline_hosts%&.
18723
18724
18725 .option uucp_from_sender main string&!! &`$1`&
18726 See &%uucp_from_pattern%& above.
18727
18728
18729 .option warn_message_file main string&!! unset
18730 .cindex "warning of delay" "customizing the message"
18731 .cindex "customizing" "warning message"
18732 This option defines a template file containing paragraphs of text to be used
18733 for constructing the warning message which is sent by Exim when a message has
18734 been in the queue for a specified amount of time, as specified by
18735 &%delay_warning%&. Details of the file's contents are given in chapter
18736 &<<CHAPemsgcust>>&.
18737 .cindex warn_message_file "tainted data"
18738 The option is expanded to give the file path, which must be
18739 absolute and untainted.
18740 See also &%bounce_message_file%&.
18741
18742
18743 .option write_rejectlog main boolean true
18744 .cindex "reject log" "disabling"
18745 If this option is set false, Exim no longer writes anything to the reject log.
18746 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18747 .ecindex IIDconfima
18748 .ecindex IIDmaiconf
18749
18750
18751
18752
18753 . ////////////////////////////////////////////////////////////////////////////
18754 . ////////////////////////////////////////////////////////////////////////////
18755
18756 .chapter "Generic options for routers" "CHAProutergeneric"
18757 .scindex IIDgenoprou1 "options" "generic; for routers"
18758 .scindex IIDgenoprou2 "generic options" "router"
18759 This chapter describes the generic options that apply to all routers.
18760 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18761
18762 For a general description of how a router operates, see sections
18763 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18764 which the preconditions are tested. The order of expansion of the options that
18765 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18766 &%headers_remove%&, &%transport%&.
18767
18768
18769
18770 .option address_data routers string&!! unset
18771 .cindex "router" "data attached to address"
18772 The string is expanded just before the router is run, that is, after all the
18773 precondition tests have succeeded. If the expansion is forced to fail, the
18774 router declines, the value of &%address_data%& remains unchanged, and the
18775 &%more%& option controls what happens next. Other expansion failures cause
18776 delivery of the address to be deferred.
18777
18778 .vindex "&$address_data$&"
18779 When the expansion succeeds, the value is retained with the address, and can be
18780 accessed using the variable &$address_data$& in the current router, subsequent
18781 routers, and the eventual transport.
18782
18783 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18784 that runs a user's filter file, the contents of &$address_data$& are accessible
18785 in the filter. This is not normally a problem, because such data is usually
18786 either not confidential or it &"belongs"& to the current user, but if you do
18787 put confidential data into &$address_data$& you need to remember this point.
18788
18789 Even if the router declines or passes, the value of &$address_data$& remains
18790 with the address, though it can be changed by another &%address_data%& setting
18791 on a subsequent router. If a router generates child addresses, the value of
18792 &$address_data$& propagates to them. This also applies to the special kind of
18793 &"child"& that is generated by a router with the &%unseen%& option.
18794
18795 The idea of &%address_data%& is that you can use it to look up a lot of data
18796 for the address once, and then pick out parts of the data later. For example,
18797 you could use a single LDAP lookup to return a string of the form
18798 .code
18799 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18800 .endd
18801 In the transport you could pick out the mailbox by a setting such as
18802 .code
18803 file = ${extract{mailbox}{$address_data}}
18804 .endd
18805 This makes the configuration file less messy, and also reduces the number of
18806 lookups (though Exim does cache lookups).
18807
18808 See also the &%set%& option below.
18809
18810 .vindex "&$sender_address_data$&"
18811 .vindex "&$address_data$&"
18812 The &%address_data%& facility is also useful as a means of passing information
18813 from one router to another, and from a router to a transport. In addition, if
18814 &$address_data$& is set by a router when verifying a recipient address from an
18815 ACL, it remains available for use in the rest of the ACL statement. After
18816 verifying a sender, the value is transferred to &$sender_address_data$&.
18817
18818
18819
18820 .option address_test routers&!? boolean true
18821 .oindex "&%-bt%&"
18822 .cindex "router" "skipping when address testing"
18823 If this option is set false, the router is skipped when routing is being tested
18824 by means of the &%-bt%& command line option. This can be a convenience when
18825 your first router sends messages to an external scanner, because it saves you
18826 having to set the &"already scanned"& indicator when testing real address
18827 routing.
18828
18829
18830
18831 .option cannot_route_message routers string&!! unset
18832 .cindex "router" "customizing &""cannot route""& message"
18833 .cindex "customizing" "&""cannot route""& message"
18834 This option specifies a text message that is used when an address cannot be
18835 routed because Exim has run out of routers. The default message is
18836 &"Unrouteable address"&. This option is useful only on routers that have
18837 &%more%& set false, or on the very last router in a configuration, because the
18838 value that is used is taken from the last router that is considered. This
18839 includes a router that is skipped because its preconditions are not met, as
18840 well as a router that declines. For example, using the default configuration,
18841 you could put:
18842 .code
18843 cannot_route_message = Remote domain not found in DNS
18844 .endd
18845 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18846 and
18847 .code
18848 cannot_route_message = Unknown local user
18849 .endd
18850 on the final router that checks for local users. If string expansion fails for
18851 this option, the default message is used. Unless the expansion failure was
18852 explicitly forced, a message about the failure is written to the main and panic
18853 logs, in addition to the normal message about the routing failure.
18854
18855
18856 .option caseful_local_part routers boolean false
18857 .cindex "case of local parts"
18858 .cindex "router" "case of local parts"
18859 By default, routers handle the local parts of addresses in a case-insensitive
18860 manner, though the actual case is preserved for transmission with the message.
18861 If you want the case of letters to be significant in a router, you must set
18862 this option true. For individual router options that contain address or local
18863 part lists (for example, &%local_parts%&), case-sensitive matching can be
18864 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18865 more details.
18866
18867 .vindex "&$local_part$&"
18868 .vindex "&$original_local_part$&"
18869 .vindex "&$parent_local_part$&"
18870 The value of the &$local_part$& variable is forced to lower case while a
18871 router is running unless &%caseful_local_part%& is set. When a router assigns
18872 an address to a transport, the value of &$local_part$& when the transport runs
18873 is the same as it was in the router. Similarly, when a router generates child
18874 addresses by aliasing or forwarding, the values of &$original_local_part$&
18875 and &$parent_local_part$& are those that were used by the redirecting router.
18876
18877 This option applies to the processing of an address by a router. When a
18878 recipient address is being processed in an ACL, there is a separate &%control%&
18879 modifier that can be used to specify case-sensitive processing within the ACL
18880 (see section &<<SECTcontrols>>&).
18881
18882
18883
18884 .option check_local_user routers&!? boolean false
18885 .cindex "local user, checking in router"
18886 .cindex "router" "checking for local user"
18887 .cindex "&_/etc/passwd_&"
18888 .vindex "&$home$&"
18889 When this option is true, Exim checks that the local part of the recipient
18890 address (with affixes removed if relevant) is the name of an account on the
18891 local system. The check is done by calling the &[getpwnam()]& function rather
18892 than trying to read &_/etc/passwd_& directly. This means that other methods of
18893 holding password data (such as NIS) are supported. If the local part is a local
18894 user,
18895 .cindex "tainted data" "de-tainting"
18896 &$local_part_data$& is set to an untainted version of the local part and
18897 &$home$& is set from the password data. The latter can be tested in other
18898 preconditions that are evaluated after this one (the order of evaluation is
18899 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18900 overridden by &%router_home_directory%&. If the local part is not a local user,
18901 the router is skipped.
18902
18903 If you want to check that the local part is either the name of a local user
18904 or matches something else, you cannot combine &%check_local_user%& with a
18905 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18906 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18907 setting to achieve this. For example:
18908 .code
18909 local_parts = passwd;$local_part : lsearch;/etc/other/users
18910 .endd
18911 Note, however, that the side effects of &%check_local_user%& (such as setting
18912 up a home directory) do not occur when a &(passwd)& lookup is used in a
18913 &%local_parts%& (or any other) precondition.
18914
18915
18916
18917 .option condition routers&!? string&!! unset
18918 .cindex "router" "customized precondition"
18919 This option specifies a general precondition test that has to succeed for the
18920 router to be called. The &%condition%& option is the last precondition to be
18921 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18922 result is a forced failure, or an empty string, or one of the strings &"0"& or
18923 &"no"& or &"false"& (checked without regard to the case of the letters), the
18924 router is skipped, and the address is offered to the next one.
18925
18926 If the result is any other value, the router is run (as this is the last
18927 precondition to be evaluated, all the other preconditions must be true).
18928
18929 This option is unusual in that multiple &%condition%& options may be present.
18930 All &%condition%& options must succeed.
18931
18932 The &%condition%& option provides a means of applying custom conditions to the
18933 running of routers. Note that in the case of a simple conditional expansion,
18934 the default expansion values are exactly what is wanted. For example:
18935 .code
18936 condition = ${if >{$message_age}{600}}
18937 .endd
18938 Because of the default behaviour of the string expansion, this is equivalent to
18939 .code
18940 condition = ${if >{$message_age}{600}{true}{}}
18941 .endd
18942
18943 A multiple condition example, which succeeds:
18944 .code
18945 condition = ${if >{$message_age}{600}}
18946 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18947 condition = foobar
18948 .endd
18949
18950 If the expansion fails (other than forced failure) delivery is deferred. Some
18951 of the other precondition options are common special cases that could in fact
18952 be specified using &%condition%&.
18953
18954 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18955 are far older, and use one set of semantics.  ACLs are newer and when
18956 they were created, the ACL &%condition%& process was given far stricter
18957 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18958 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18959 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18960 Router rules processing behavior.
18961
18962 This is best illustrated in an example:
18963 .code
18964 # If used in an ACL condition will fail with a syntax error, but
18965 # in a router condition any extra characters are treated as a string
18966
18967 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18968 true {yes} {no}}
18969
18970 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18971  {yes} {no}}
18972 .endd
18973 In each example above, the &%if%& statement actually ends after
18974 &"{google.com}}"&.  Since no true or false braces were defined, the
18975 default &%if%& behavior is to return a boolean true or a null answer
18976 (which evaluates to false). The rest of the line is then treated as a
18977 string. So the first example resulted in the boolean answer &"true"&
18978 with the string &" {yes} {no}}"& appended to it. The second example
18979 resulted in the null output (indicating false) with the string
18980 &" {yes} {no}}"& appended to it.
18981
18982 In fact you can put excess forward braces in too.  In the router
18983 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18984 mean something, like after a &"$"& or when required as part of a
18985 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18986 string characters.
18987
18988 Thus, in a Router, the above expansion strings will both always evaluate
18989 true, as the result of expansion is a non-empty string which doesn't
18990 match an explicit false value.  This can be tricky to debug.  By
18991 contrast, in an ACL either of those strings will always result in an
18992 expansion error because the result doesn't look sufficiently boolean.
18993
18994
18995 .option debug_print routers string&!! unset
18996 .cindex "testing" "variables in drivers"
18997 If this option is set and debugging is enabled (see the &%-d%& command line
18998 option) or in address-testing mode (see the &%-bt%& command line option),
18999 the string is expanded and included in the debugging output.
19000 If expansion of the string fails, the error message is written to the debugging
19001 output, and Exim carries on processing.
19002 This option is provided to help with checking out the values of variables and
19003 so on when debugging router configurations. For example, if a &%condition%&
19004 option appears not to be working, &%debug_print%& can be used to output the
19005 variables it references. The output happens after checks for &%domains%&,
19006 &%local_parts%&, and &%check_local_user%& but before any other preconditions
19007 are tested. A newline is added to the text if it does not end with one.
19008 The variable &$router_name$& contains the name of the router.
19009
19010
19011
19012 .option disable_logging routers boolean false
19013 If this option is set true, nothing is logged for any routing errors
19014 or for any deliveries caused by this router. You should not set this option
19015 unless you really, really know what you are doing. See also the generic
19016 transport option of the same name.
19017
19018 .option dnssec_request_domains routers "domain list&!!" *
19019 .cindex "MX record" "security"
19020 .cindex "DNSSEC" "MX lookup"
19021 .cindex "security" "MX lookup"
19022 .cindex "DNS" "DNSSEC"
19023 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
19024 the DNSSEC request bit set.
19025 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19026
19027 .option dnssec_require_domains routers "domain list&!!" unset
19028 .cindex "MX record" "security"
19029 .cindex "DNSSEC" "MX lookup"
19030 .cindex "security" "MX lookup"
19031 .cindex "DNS" "DNSSEC"
19032 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
19033 the DNSSEC request bit set.  Any returns not having the Authenticated Data bit
19034 (AD bit) set will be ignored and logged as a host-lookup failure.
19035 This applies to all of the SRV, MX, AAAA, A lookup sequence.
19036
19037
19038 .option domains routers&!? "domain list&!!" unset
19039 .cindex "router" "restricting to specific domains"
19040 .vindex "&$domain_data$&"
19041 If this option is set, the router is skipped unless the current domain matches
19042 the list. If the match is achieved by means of a file lookup, the data that the
19043 lookup returned for the domain is placed in &$domain_data$& for use in string
19044 expansions of the driver's private options and in the transport.
19045 See section &<<SECTrouprecon>>& for
19046 a list of the order in which preconditions are evaluated.
19047
19048
19049
19050 .option driver routers string unset
19051 This option must always be set. It specifies which of the available routers is
19052 to be used.
19053
19054
19055 .option dsn_lasthop routers boolean false
19056 .cindex "DSN" "success"
19057 .cindex "Delivery Status Notification" "success"
19058 If this option is set true, and extended DSN (RFC3461) processing is in effect,
19059 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
19060 instead send a success DSN as if the next hop does not support DSN.
19061 Not effective on redirect routers.
19062
19063
19064
19065 .option errors_to routers string&!! unset
19066 .cindex "envelope from"
19067 .cindex "envelope sender"
19068 .cindex "router" "changing address for errors"
19069 If a router successfully handles an address, it may assign the address to a
19070 transport for delivery or it may generate child addresses. In both cases, if
19071 there is a delivery problem during later processing, the resulting bounce
19072 message is sent to the address that results from expanding this string,
19073 provided that the address verifies successfully. The &%errors_to%& option is
19074 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
19075
19076 The &%errors_to%& setting associated with an address can be overridden if it
19077 subsequently passes through other routers that have their own &%errors_to%&
19078 settings, or if the message is delivered by a transport with a &%return_path%&
19079 setting.
19080
19081 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
19082 the expansion fails to verify, the errors address associated with the incoming
19083 address is used. At top level, this is the envelope sender. A non-forced
19084 expansion failure causes delivery to be deferred.
19085
19086 If an address for which &%errors_to%& has been set ends up being delivered over
19087 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
19088 any bounces that are generated by other MTAs on the delivery route are also
19089 sent there. You can set &%errors_to%& to the empty string by either of these
19090 settings:
19091 .code
19092 errors_to =
19093 errors_to = ""
19094 .endd
19095 An expansion item that yields an empty string has the same effect. If you do
19096 this, a locally detected delivery error for addresses processed by this router
19097 no longer gives rise to a bounce message; the error is discarded. If the
19098 address is delivered to a remote host, the return path is set to &`<>`&, unless
19099 overridden by the &%return_path%& option on the transport.
19100
19101 .vindex "&$address_data$&"
19102 If for some reason you want to discard local errors, but use a non-empty
19103 MAIL command for remote delivery, you can preserve the original return
19104 path in &$address_data$& in the router, and reinstate it in the transport by
19105 setting &%return_path%&.
19106
19107 The most common use of &%errors_to%& is to direct mailing list bounces to the
19108 manager of the list, as described in section &<<SECTmailinglists>>&, or to
19109 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
19110
19111
19112
19113 .option expn routers&!? boolean true
19114 .cindex "address" "testing"
19115 .cindex "testing" "addresses"
19116 .cindex "EXPN" "router skipping"
19117 .cindex "router" "skipping for EXPN"
19118 If this option is turned off, the router is skipped when testing an address
19119 as a result of processing an SMTP EXPN command. You might, for example,
19120 want to turn it off on a router for users' &_.forward_& files, while leaving it
19121 on for the system alias file.
19122 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19123 are evaluated.
19124
19125 The use of the SMTP EXPN command is controlled by an ACL (see chapter
19126 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
19127 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
19128
19129
19130
19131 .option fail_verify routers boolean false
19132 .cindex "router" "forcing verification failure"
19133 Setting this option has the effect of setting both &%fail_verify_sender%& and
19134 &%fail_verify_recipient%& to the same value.
19135
19136
19137
19138 .option fail_verify_recipient routers boolean false
19139 If this option is true and an address is accepted by this router when
19140 verifying a recipient, verification fails.
19141
19142
19143
19144 .option fail_verify_sender routers boolean false
19145 If this option is true and an address is accepted by this router when
19146 verifying a sender, verification fails.
19147
19148
19149
19150 .option fallback_hosts routers "string list" unset
19151 .cindex "router" "fallback hosts"
19152 .cindex "fallback" "hosts specified on router"
19153 String expansion is not applied to this option. The argument must be a
19154 colon-separated list of host names or IP addresses. The list separator can be
19155 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
19156 each name or address. In fact, the format of each item is exactly the same as
19157 defined for the list of hosts in a &(manualroute)& router (see section
19158 &<<SECTformatonehostitem>>&).
19159
19160 If a router queues an address for a remote transport, this host list is
19161 associated with the address, and used instead of the transport's fallback host
19162 list. If &%hosts_randomize%& is set on the transport, the order of the list is
19163 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
19164 transport for further details.
19165
19166
19167 .option group routers string&!! "see below"
19168 .cindex "gid (group id)" "local delivery"
19169 .cindex "local transports" "uid and gid"
19170 .cindex "transport" "local"
19171 .cindex "router" "setting group"
19172 When a router queues an address for a transport, and the transport does not
19173 specify a group, the group given here is used when running the delivery
19174 process.
19175 The group may be specified numerically or by name. If expansion fails, the
19176 error is logged and delivery is deferred.
19177 The default is unset, unless &%check_local_user%& is set, when the default
19178 is taken from the password information. See also &%initgroups%& and &%user%&
19179 and the discussion in chapter &<<CHAPenvironment>>&.
19180
19181
19182
19183 .option headers_add routers list&!! unset
19184 .cindex "header lines" "adding"
19185 .cindex "router" "adding header lines"
19186 This option specifies a list of text headers,
19187 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19188 that is associated with any addresses that are accepted by the router.
19189 Each item is separately expanded, at routing time.  However, this
19190 option has no effect when an address is just being verified. The way in which
19191 the text is used to add header lines at transport time is described in section
19192 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19193 message is in the process of being transported. This means that references to
19194 header lines in string expansions in the transport's configuration do not
19195 &"see"& the added header lines.
19196
19197 The &%headers_add%& option is expanded after &%errors_to%&, but before
19198 &%headers_remove%& and &%transport%&. If an item is empty, or if
19199 an item expansion is forced to fail, the item has no effect. Other expansion
19200 failures are treated as configuration errors.
19201
19202 Unlike most options, &%headers_add%& can be specified multiple times
19203 for a router; all listed headers are added.
19204
19205 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19206 router that has the &%one_time%& option set.
19207
19208 .cindex "duplicate addresses"
19209 .oindex "&%unseen%&"
19210 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19211 additions are deleted when the address is passed on to subsequent routers.
19212 For a &%redirect%& router, if a generated address is the same as the incoming
19213 address, this can lead to duplicate addresses with different header
19214 modifications. Exim does not do duplicate deliveries (except, in certain
19215 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19216 which of the duplicates is discarded, so this ambiguous situation should be
19217 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19218
19219
19220
19221 .option headers_remove routers list&!! unset
19222 .cindex "header lines" "removing"
19223 .cindex "router" "removing header lines"
19224 This option specifies a list of text headers,
19225 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19226 that is associated with any addresses that are accepted by the router.
19227 However, the option has no effect when an address is just being verified.
19228 Each list item is separately expanded, at transport time.
19229 If an item ends in *, it will match any header with the given prefix.
19230 The way in which
19231 the text is used to remove header lines at transport time is described in
19232 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19233 the message is in the process of being transported. This means that references
19234 to header lines in string expansions in the transport's configuration still
19235 &"see"& the original header lines.
19236
19237 The &%headers_remove%& option is handled after &%errors_to%& and
19238 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19239 the item has no effect. Other expansion failures are treated as configuration
19240 errors.
19241
19242 Unlike most options, &%headers_remove%& can be specified multiple times
19243 for a router; all listed headers are removed.
19244
19245 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19246 router that has the &%one_time%& option set.
19247
19248 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19249 removal requests are deleted when the address is passed on to subsequent
19250 routers, and this can lead to problems with duplicates -- see the similar
19251 warning for &%headers_add%& above.
19252
19253 &*Warning 3*&: Because of the separate expansion of the list items,
19254 items that contain a list separator must have it doubled.
19255 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19256
19257
19258
19259 .option ignore_target_hosts routers "host list&!!" unset
19260 .cindex "IP address" "discarding"
19261 .cindex "router" "discarding IP addresses"
19262 Although this option is a host list, it should normally contain IP address
19263 entries rather than names. If any host that is looked up by the router has an
19264 IP address that matches an item in this list, Exim behaves as if that IP
19265 address did not exist. This option allows you to cope with rogue DNS entries
19266 like
19267 .code
19268 remote.domain.example.  A  127.0.0.1
19269 .endd
19270 by setting
19271 .code
19272 ignore_target_hosts = 127.0.0.1
19273 .endd
19274 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19275 discarded in this way, the router declines. In a conventional configuration, an
19276 attempt to mail to such a domain would normally provoke the &"unrouteable
19277 domain"& error, and an attempt to verify an address in the domain would fail.
19278 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19279 router declines if presented with one of the listed addresses.
19280
19281 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19282 means of the first or the second of the following settings, respectively:
19283 .code
19284 ignore_target_hosts = 0.0.0.0/0
19285 ignore_target_hosts = <; 0::0/0
19286 .endd
19287 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19288 in the second line matches all IPv6 addresses.
19289
19290 This option may also be useful for ignoring link-local and site-local IPv6
19291 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19292 is expanded before use as a list, it is possible to make it dependent on the
19293 domain that is being routed.
19294
19295 .vindex "&$host_address$&"
19296 During its expansion, &$host_address$& is set to the IP address that is being
19297 checked.
19298
19299 .option initgroups routers boolean false
19300 .cindex "additional groups"
19301 .cindex "groups" "additional"
19302 .cindex "local transports" "uid and gid"
19303 .cindex "transport" "local"
19304 If the router queues an address for a transport, and this option is true, and
19305 the uid supplied by the router is not overridden by the transport, the
19306 &[initgroups()]& function is called when running the transport to ensure that
19307 any additional groups associated with the uid are set up. See also &%group%&
19308 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19309
19310
19311
19312 .option local_part_prefix routers&!? "string list" unset
19313 .cindex affix "router precondition"
19314 .cindex "router" "prefix for local part"
19315 .cindex "prefix" "for local part, used in router"
19316 If this option is set, the router is skipped unless the local part starts with
19317 one of the given strings, or &%local_part_prefix_optional%& is true. See
19318 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19319 evaluated.
19320
19321 The list is scanned from left to right, and the first prefix that matches is
19322 used. A limited form of wildcard is available; if the prefix begins with an
19323 asterisk, it matches the longest possible sequence of arbitrary characters at
19324 the start of the local part. An asterisk should therefore always be followed by
19325 some character that does not occur in normal local parts.
19326 .cindex "multiple mailboxes"
19327 .cindex "mailbox" "multiple"
19328 Wildcarding can be used to set up multiple user mailboxes, as described in
19329 section &<<SECTmulbox>>&.
19330
19331 .vindex "&$local_part$&"
19332 .vindex "&$local_part_prefix$&"
19333 During the testing of the &%local_parts%& option, and while the router is
19334 running, the prefix is removed from the local part, and is available in the
19335 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19336 the router accepts the address, this remains true during subsequent delivery by
19337 a transport. In particular, the local part that is transmitted in the RCPT
19338 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19339 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19340 the relevant transport.
19341
19342 .vindex &$local_part_prefix_v$&
19343 If wildcarding (above) was used then the part of the prefix matching the
19344 wildcard is available in &$local_part_prefix_v$&.
19345
19346 When an address is being verified, &%local_part_prefix%& affects only the
19347 behaviour of the router. If the callout feature of verification is in use, this
19348 means that the full address, including the prefix, will be used during the
19349 callout.
19350
19351 The prefix facility is commonly used to handle local parts of the form
19352 &%owner-something%&. Another common use is to support local parts of the form
19353 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19354 to tell a user their forwarding is broken &-- by placing a router like this one
19355 immediately before the router that handles &_.forward_& files:
19356 .code
19357 real_localuser:
19358   driver = accept
19359   local_part_prefix = real-
19360   check_local_user
19361   transport = local_delivery
19362 .endd
19363 For security, it would probably be a good idea to restrict the use of this
19364 router to locally-generated messages, using a condition such as this:
19365 .code
19366   condition = ${if match {$sender_host_address}\
19367                          {\N^(|127\.0\.0\.1)$\N}}
19368 .endd
19369
19370 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19371 both conditions must be met if not optional. Care must be taken if wildcards
19372 are used in both a prefix and a suffix on the same router. Different
19373 separator characters must be used to avoid ambiguity.
19374
19375
19376 .option local_part_prefix_optional routers boolean false
19377 See &%local_part_prefix%& above.
19378
19379
19380
19381 .option local_part_suffix routers&!? "string list" unset
19382 .cindex "router" "suffix for local part"
19383 .cindex "suffix for local part" "used in router"
19384 This option operates in the same way as &%local_part_prefix%&, except that the
19385 local part must end (rather than start) with the given string, the
19386 &%local_part_suffix_optional%& option determines whether the suffix is
19387 mandatory, and the wildcard * character, if present, must be the last
19388 character of the suffix. This option facility is commonly used to handle local
19389 parts of the form &%something-request%& and multiple user mailboxes of the form
19390 &%username-foo%&.
19391
19392
19393 .option local_part_suffix_optional routers boolean false
19394 See &%local_part_suffix%& above.
19395
19396
19397
19398 .option local_parts routers&!? "local part list&!!" unset
19399 .cindex "router" "restricting to specific local parts"
19400 .cindex "local part" "checking in router"
19401 The router is run only if the local part of the address matches the list.
19402 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19403 are evaluated, and
19404 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19405 string is expanded, it is possible to make it depend on the domain, for
19406 example:
19407 .code
19408 local_parts = dbm;/usr/local/specials/$domain_data
19409 .endd
19410 .vindex "&$local_part_data$&"
19411 If the match is achieved by a lookup, the data that the lookup returned
19412 for the local part is placed in the variable &$local_part_data$& for use in
19413 expansions of the router's private options or in the transport.
19414 You might use this option, for
19415 example, if you have a large number of local virtual domains, and you want to
19416 send all postmaster mail to the same place without having to set up an alias in
19417 each virtual domain:
19418 .code
19419 postmaster:
19420   driver = redirect
19421   local_parts = postmaster
19422   data = postmaster@real.domain.example
19423 .endd
19424
19425
19426 .option log_as_local routers boolean "see below"
19427 .cindex "log" "delivery line"
19428 .cindex "delivery" "log line format"
19429 Exim has two logging styles for delivery, the idea being to make local
19430 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19431 recipient address is given just as the local part, without a domain. The use of
19432 this style is controlled by this option. It defaults to true for the &(accept)&
19433 router, and false for all the others. This option applies only when a
19434 router assigns an address to a transport. It has no effect on routers that
19435 redirect addresses.
19436
19437
19438
19439 .option more routers boolean&!! true
19440 The result of string expansion for this option must be a valid boolean value,
19441 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19442 result causes an error, and delivery is deferred. If the expansion is forced to
19443 fail, the default value for the option (true) is used. Other failures cause
19444 delivery to be deferred.
19445
19446 If this option is set false, and the router declines to handle the address, no
19447 further routers are tried, routing fails, and the address is bounced.
19448 .oindex "&%self%&"
19449 However, if the router explicitly passes an address to the following router by
19450 means of the setting
19451 .code
19452 self = pass
19453 .endd
19454 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19455 does not affect the behaviour if one of the precondition tests fails. In that
19456 case, the address is always passed to the next router.
19457
19458 Note that &%address_data%& is not considered to be a precondition. If its
19459 expansion is forced to fail, the router declines, and the value of &%more%&
19460 controls what happens next.
19461
19462
19463 .option pass_on_timeout routers boolean false
19464 .cindex "timeout" "of router"
19465 .cindex "router" "timeout"
19466 If a router times out during a host lookup, it normally causes deferral of the
19467 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19468 router, overriding &%no_more%&. This may be helpful for systems that are
19469 intermittently connected to the Internet, or those that want to pass to a smart
19470 host any messages that cannot immediately be delivered.
19471
19472 There are occasional other temporary errors that can occur while doing DNS
19473 lookups. They are treated in the same way as a timeout, and this option
19474 applies to all of them.
19475
19476
19477
19478 .option pass_router routers string unset
19479 .cindex "router" "go to after &""pass""&"
19480 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19481 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19482 routing to continue, and overriding a false setting of &%more%&. When one of
19483 these routers returns &"pass"&, the address is normally handed on to the next
19484 router in sequence. This can be changed by setting &%pass_router%& to the name
19485 of another router. However (unlike &%redirect_router%&) the named router must
19486 be below the current router, to avoid loops. Note that this option applies only
19487 to the special case of &"pass"&. It does not apply when a router returns
19488 &"decline"& because it cannot handle an address.
19489
19490
19491
19492 .option redirect_router routers string unset
19493 .cindex "router" "start at after redirection"
19494 Sometimes an administrator knows that it is pointless to reprocess addresses
19495 generated from alias or forward files with the same router again. For
19496 example, if an alias file translates real names into login ids there is no
19497 point searching the alias file a second time, especially if it is a large file.
19498
19499 The &%redirect_router%& option can be set to the name of any router instance.
19500 It causes the routing of any generated addresses to start at the named router
19501 instead of at the first router. This option has no effect if the router in
19502 which it is set does not generate new addresses.
19503
19504
19505
19506 .option require_files routers&!? "string list&!!" unset
19507 .cindex "file" "requiring for router"
19508 .cindex "router" "requiring file existence"
19509 This option provides a general mechanism for predicating the running of a
19510 router on the existence or non-existence of certain files or directories.
19511 Before running a router, as one of its precondition tests, Exim works its way
19512 through the &%require_files%& list, expanding each item separately.
19513
19514 Because the list is split before expansion, any colons in expansion items must
19515 be doubled, or the facility for using a different list separator must be used
19516 (&<<SECTlistsepchange>>&).
19517 If any expansion is forced to fail, the item is ignored. Other expansion
19518 failures cause routing of the address to be deferred.
19519
19520 If any expanded string is empty, it is ignored. Otherwise, except as described
19521 below, each string must be a fully qualified file path, optionally preceded by
19522 &"!"&. The paths are passed to the &[stat()]& function to test for the
19523 existence of the files or directories. The router is skipped if any paths not
19524 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19525
19526 .cindex "NFS"
19527 If &[stat()]& cannot determine whether a file exists or not, delivery of
19528 the message is deferred. This can happen when NFS-mounted filesystems are
19529 unavailable.
19530
19531 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19532 options, so you cannot use it to check for the existence of a file in which to
19533 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19534 full list of the order in which preconditions are evaluated.) However, as
19535 these options are all expanded, you can use the &%exists%& expansion condition
19536 to make such tests. The &%require_files%& option is intended for checking files
19537 that the router may be going to use internally, or which are needed by a
19538 transport (e.g., &_.procmailrc_&).
19539
19540 During delivery, the &[stat()]& function is run as root, but there is a
19541 facility for some checking of the accessibility of a file by another user.
19542 This is not a proper permissions check, but just a &"rough"& check that
19543 operates as follows:
19544
19545 If an item in a &%require_files%& list does not contain any forward slash
19546 characters, it is taken to be the user (and optional group, separated by a
19547 comma) to be checked for subsequent files in the list. If no group is specified
19548 but the user is specified symbolically, the gid associated with the uid is
19549 used. For example:
19550 .code
19551 require_files = mail:/some/file
19552 require_files = $local_part_data:$home/.procmailrc
19553 .endd
19554 If a user or group name in a &%require_files%& list does not exist, the
19555 &%require_files%& condition fails.
19556
19557 Exim performs the check by scanning along the components of the file path, and
19558 checking the access for the given uid and gid. It checks for &"x"& access on
19559 directories, and &"r"& access on the final file. Note that this means that file
19560 access control lists, if the operating system has them, are ignored.
19561
19562 &*Warning 1*&: When the router is being run to verify addresses for an
19563 incoming SMTP message, Exim is not running as root, but under its own uid. This
19564 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19565 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19566 user is not permitted to read one of the directories on the file's path.
19567
19568 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19569 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19570 without root access. In this case, if a check for access by a particular user
19571 is requested, Exim creates a subprocess that runs as that user, and tries the
19572 check again in that process.
19573
19574 The default action for handling an unresolved EACCES is to consider it to
19575 be caused by a configuration error, and routing is deferred because the
19576 existence or non-existence of the file cannot be determined. However, in some
19577 circumstances it may be desirable to treat this condition as if the file did
19578 not exist. If the filename (or the exclamation mark that precedes the filename
19579 for non-existence) is preceded by a plus sign, the EACCES error is treated
19580 as if the file did not exist. For example:
19581 .code
19582 require_files = +/some/file
19583 .endd
19584 If the router is not an essential part of verification (for example, it
19585 handles users' &_.forward_& files), another solution is to set the &%verify%&
19586 option false so that the router is skipped when verifying.
19587
19588
19589
19590 .option retry_use_local_part routers boolean "see below"
19591 .cindex "hints database" "retry keys"
19592 .cindex "local part" "in retry keys"
19593 When a delivery suffers a temporary routing failure, a retry record is created
19594 in Exim's hints database. For addresses whose routing depends only on the
19595 domain, the key for the retry record should not involve the local part, but for
19596 other addresses, both the domain and the local part should be included.
19597 Usually, remote routing is of the former kind, and local routing is of the
19598 latter kind.
19599
19600 This option controls whether the local part is used to form the key for retry
19601 hints for addresses that suffer temporary errors while being handled by this
19602 router. The default value is true for any router that has any of
19603 &%check_local_user%&,
19604 &%local_parts%&,
19605 &%condition%&,
19606 &%local_part_prefix%&,
19607 &%local_part_suffix%&,
19608 &%senders%& or
19609 &%require_files%&
19610 set, and false otherwise. Note that this option does not apply to hints keys
19611 for transport delays; they are controlled by a generic transport option of the
19612 same name.
19613
19614 Failing to set this option when it is needed
19615 (because a remote router handles only some of the local-parts for a domain)
19616 can result in incorrect error messages being generated.
19617
19618 The setting of &%retry_use_local_part%& applies only to the router on which it
19619 appears. If the router generates child addresses, they are routed
19620 independently; this setting does not become attached to them.
19621
19622
19623
19624 .option router_home_directory routers string&!! unset
19625 .cindex "router" "home directory for"
19626 .cindex "home directory" "for router"
19627 .vindex "&$home$&"
19628 This option sets a home directory for use while the router is running. (Compare
19629 &%transport_home_directory%&, which sets a home directory for later
19630 transporting.) In particular, if used on a &(redirect)& router, this option
19631 sets a value for &$home$& while a filter is running. The value is expanded;
19632 forced expansion failure causes the option to be ignored &-- other failures
19633 cause the router to defer.
19634
19635 Expansion of &%router_home_directory%& happens immediately after the
19636 &%check_local_user%& test (if configured), before any further expansions take
19637 place.
19638 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19639 are evaluated.)
19640 While the router is running, &%router_home_directory%& overrides the value of
19641 &$home$& that came from &%check_local_user%&.
19642
19643 When a router accepts an address and assigns it to a local transport (including
19644 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19645 delivery), the home directory setting for the transport is taken from the first
19646 of these values that is set:
19647
19648 .ilist
19649 The &%home_directory%& option on the transport;
19650 .next
19651 The &%transport_home_directory%& option on the router;
19652 .next
19653 The password data if &%check_local_user%& is set on the router;
19654 .next
19655 The &%router_home_directory%& option on the router.
19656 .endlist
19657
19658 In other words, &%router_home_directory%& overrides the password data for the
19659 router, but not for the transport.
19660
19661
19662
19663 .option self routers string freeze
19664 .cindex "MX record" "pointing to local host"
19665 .cindex "local host" "MX pointing to"
19666 This option applies to those routers that use a recipient address to find a
19667 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19668 and &(manualroute)& routers.
19669 Certain configurations of the &(queryprogram)& router can also specify a list
19670 of remote hosts.
19671 Usually such routers are configured to send the message to a remote host via an
19672 &(smtp)& transport. The &%self%& option specifies what happens when the first
19673 host on the list turns out to be the local host.
19674 The way in which Exim checks for the local host is described in section
19675 &<<SECTreclocipadd>>&.
19676
19677 Normally this situation indicates either an error in Exim's configuration (for
19678 example, the router should be configured not to process this domain), or an
19679 error in the DNS (for example, the MX should not point to this host). For this
19680 reason, the default action is to log the incident, defer the address, and
19681 freeze the message. The following alternatives are provided for use in special
19682 cases:
19683
19684 .vlist
19685 .vitem &%defer%&
19686 Delivery of the message is tried again later, but the message is not frozen.
19687
19688 .vitem "&%reroute%&: <&'domain'&>"
19689 The domain is changed to the given domain, and the address is passed back to
19690 be reprocessed by the routers. No rewriting of headers takes place. This
19691 behaviour is essentially a redirection.
19692
19693 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19694 The domain is changed to the given domain, and the address is passed back to be
19695 reprocessed by the routers. Any headers that contain the original domain are
19696 rewritten.
19697
19698 .vitem &%pass%&
19699 .oindex "&%more%&"
19700 .vindex "&$self_hostname$&"
19701 The router passes the address to the next router, or to the router named in the
19702 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19703 subsequent routing and delivery, the variable &$self_hostname$& contains the
19704 name of the local host that the router encountered. This can be used to
19705 distinguish between different cases for hosts with multiple names. The
19706 combination
19707 .code
19708 self = pass
19709 no_more
19710 .endd
19711 ensures that only those addresses that routed to the local host are passed on.
19712 Without &%no_more%&, addresses that were declined for other reasons would also
19713 be passed to the next router.
19714
19715 .vitem &%fail%&
19716 Delivery fails and an error report is generated.
19717
19718 .vitem &%send%&
19719 .cindex "local host" "sending to"
19720 The anomaly is ignored and the address is queued for the transport. This
19721 setting should be used with extreme caution. For an &(smtp)& transport, it
19722 makes sense only in cases where the program that is listening on the SMTP port
19723 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19724 different configuration file that handles the domain in another way.
19725 .endlist
19726
19727
19728
19729 .option senders routers&!? "address list&!!" unset
19730 .cindex "router" "checking senders"
19731 If this option is set, the router is skipped unless the message's sender
19732 address matches something on the list.
19733 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19734 are evaluated.
19735
19736 There are issues concerning verification when the running of routers is
19737 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19738 setting, it sets the sender to the null string. When using the &%-bt%& option
19739 to check a configuration file, it is necessary also to use the &%-f%& option to
19740 set an appropriate sender. For incoming mail, the sender is unset when
19741 verifying the sender, but is available when verifying any recipients. If the
19742 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19743 matters.
19744
19745
19746 .option set routers "string list" unset
19747 .cindex router variables
19748 This option may be used multiple times on a router;
19749 because of this the list aspect is mostly irrelevant.
19750 The list separator is a semicolon but can be changed in the
19751 usual way.
19752
19753 Each list-element given must be of the form &"name = value"&
19754 and the names used must start with the string &"r_"&.
19755 Values containing a list-separator should have them doubled.
19756 When a router runs, the strings are evaluated in order,
19757 to create variables which are added to the set associated with
19758 the address.
19759 .new
19760 This is done immediately after all the preconditions, before the
19761 evaluation of the &%address_data%& option.
19762 .wen
19763 The variable is set with the expansion of the value.
19764 The variables can be used by the router options
19765 (not including any preconditions)
19766 and by the transport.
19767 Later definitions of a given named variable will override former ones.
19768 Variable use is via the usual &$r_...$& syntax.
19769
19770 This is similar to the &%address_data%& option, except that
19771 many independent variables can be used, with choice of naming.
19772
19773
19774 .option translate_ip_address routers string&!! unset
19775 .cindex "IP address" "translating"
19776 .cindex "packet radio"
19777 .cindex "router" "IP address translation"
19778 There exist some rare networking situations (for example, packet radio) where
19779 it is helpful to be able to translate IP addresses generated by normal routing
19780 mechanisms into other IP addresses, thus performing a kind of manual IP
19781 routing. This should be done only if the normal IP routing of the TCP/IP stack
19782 is inadequate or broken. Because this is an extremely uncommon requirement, the
19783 code to support this option is not included in the Exim binary unless
19784 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19785
19786 .vindex "&$host_address$&"
19787 The &%translate_ip_address%& string is expanded for every IP address generated
19788 by the router, with the generated address set in &$host_address$&. If the
19789 expansion is forced to fail, no action is taken.
19790 For any other expansion error, delivery of the message is deferred.
19791 If the result of the expansion is an IP address, that replaces the original
19792 address; otherwise the result is assumed to be a host name &-- this is looked
19793 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19794 produce one or more replacement IP addresses. For example, to subvert all IP
19795 addresses in some specific networks, this could be added to a router:
19796 .code
19797 translate_ip_address = \
19798   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19799     {$value}fail}}
19800 .endd
19801 The file would contain lines like
19802 .code
19803 10.2.3.128/26    some.host
19804 10.8.4.34/26     10.44.8.15
19805 .endd
19806 You should not make use of this facility unless you really understand what you
19807 are doing.
19808
19809
19810
19811 .option transport routers string&!! unset
19812 This option specifies the transport to be used when a router accepts an address
19813 and sets it up for delivery. A transport is never needed if a router is used
19814 only for verification. The value of the option is expanded at routing time,
19815 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19816 and result must be the name of one of the configured transports. If it is not,
19817 delivery is deferred.
19818
19819 The &%transport%& option is not used by the &(redirect)& router, but it does
19820 have some private options that set up transports for pipe and file deliveries
19821 (see chapter &<<CHAPredirect>>&).
19822
19823
19824
19825 .option transport_current_directory routers string&!! unset
19826 .cindex "current directory for local transport"
19827 This option associates a current directory with any address that is routed
19828 to a local transport. This can happen either because a transport is
19829 explicitly configured for the router, or because it generates a delivery to a
19830 file or a pipe. During the delivery process (that is, at transport time), this
19831 option string is expanded and is set as the current directory, unless
19832 overridden by a setting on the transport.
19833 If the expansion fails for any reason, including forced failure, an error is
19834 logged, and delivery is deferred.
19835 See chapter &<<CHAPenvironment>>& for details of the local delivery
19836 environment.
19837
19838
19839
19840
19841 .option transport_home_directory routers string&!! "see below"
19842 .cindex "home directory" "for local transport"
19843 This option associates a home directory with any address that is routed to a
19844 local transport. This can happen either because a transport is explicitly
19845 configured for the router, or because it generates a delivery to a file or a
19846 pipe. During the delivery process (that is, at transport time), the option
19847 string is expanded and is set as the home directory, unless overridden by a
19848 setting of &%home_directory%& on the transport.
19849 If the expansion fails for any reason, including forced failure, an error is
19850 logged, and delivery is deferred.
19851
19852 If the transport does not specify a home directory, and
19853 &%transport_home_directory%& is not set for the router, the home directory for
19854 the transport is taken from the password data if &%check_local_user%& is set for
19855 the router. Otherwise it is taken from &%router_home_directory%& if that option
19856 is set; if not, no home directory is set for the transport.
19857
19858 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19859 environment.
19860
19861
19862
19863
19864 .option unseen routers boolean&!! false
19865 .cindex "router" "carrying on after success"
19866 The result of string expansion for this option must be a valid boolean value,
19867 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19868 result causes an error, and delivery is deferred. If the expansion is forced to
19869 fail, the default value for the option (false) is used. Other failures cause
19870 delivery to be deferred.
19871
19872 When this option is set true, routing does not cease if the router accepts the
19873 address. Instead, a copy of the incoming address is passed to the next router,
19874 overriding a false setting of &%more%&. There is little point in setting
19875 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19876 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19877 sometimes true and sometimes false).
19878
19879 .cindex "copy of message (&%unseen%& option)"
19880 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19881 qualifier in filter files. It can be used to cause copies of messages to be
19882 delivered to some other destination, while also carrying out a normal delivery.
19883 In effect, the current address is made into a &"parent"& that has two children
19884 &-- one that is delivered as specified by this router, and a clone that goes on
19885 to be routed further. For this reason, &%unseen%& may not be combined with the
19886 &%one_time%& option in a &(redirect)& router.
19887
19888 &*Warning*&: Header lines added to the address (or specified for removal) by
19889 this router or by previous routers affect the &"unseen"& copy of the message
19890 only. The clone that continues to be processed by further routers starts with
19891 no added headers and none specified for removal. For a &%redirect%& router, if
19892 a generated address is the same as the incoming address, this can lead to
19893 duplicate addresses with different header modifications. Exim does not do
19894 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19895 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19896 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19897 &%redirect%& router may be of help.
19898
19899 Unlike the handling of header modifications, any data that was set by the
19900 &%address_data%& option in the current or previous routers &'is'& passed on to
19901 subsequent routers.
19902
19903
19904 .option user routers string&!! "see below"
19905 .cindex "uid (user id)" "local delivery"
19906 .cindex "local transports" "uid and gid"
19907 .cindex "transport" "local"
19908 .cindex "router" "user for filter processing"
19909 .cindex "filter" "user for processing"
19910 When a router queues an address for a transport, and the transport does not
19911 specify a user, the user given here is used when running the delivery process.
19912 The user may be specified numerically or by name. If expansion fails, the
19913 error is logged and delivery is deferred.
19914 This user is also used by the &(redirect)& router when running a filter file.
19915 The default is unset, except when &%check_local_user%& is set. In this case,
19916 the default is taken from the password information. If the user is specified as
19917 a name, and &%group%& is not set, the group associated with the user is used.
19918 See also &%initgroups%& and &%group%& and the discussion in chapter
19919 &<<CHAPenvironment>>&.
19920
19921
19922
19923 .option verify routers&!? boolean true
19924 Setting this option has the effect of setting &%verify_sender%& and
19925 &%verify_recipient%& to the same value.
19926
19927
19928 .option verify_only routers&!? boolean false
19929 .cindex "EXPN" "with &%verify_only%&"
19930 .oindex "&%-bv%&"
19931 .cindex "router" "used only when verifying"
19932 If this option is set, the router is used only when verifying an address,
19933 delivering in cutthrough mode or
19934 testing with the &%-bv%& option, not when actually doing a delivery, testing
19935 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19936 restricted to verifying only senders or recipients by means of
19937 &%verify_sender%& and &%verify_recipient%&.
19938
19939 &*Warning*&: When the router is being run to verify addresses for an incoming
19940 SMTP message, Exim is not running as root, but under its own uid. If the router
19941 accesses any files, you need to make sure that they are accessible to the Exim
19942 user or group.
19943
19944
19945 .option verify_recipient routers&!? boolean true
19946 If this option is false, the router is skipped when verifying recipient
19947 addresses,
19948 delivering in cutthrough mode
19949 or testing recipient verification using &%-bv%&.
19950 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19951 are evaluated.
19952 See also the &$verify_mode$& variable.
19953
19954
19955 .option verify_sender routers&!? boolean true
19956 If this option is false, the router is skipped when verifying sender addresses
19957 or testing sender verification using &%-bvs%&.
19958 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19959 are evaluated.
19960 See also the &$verify_mode$& variable.
19961 .ecindex IIDgenoprou1
19962 .ecindex IIDgenoprou2
19963
19964
19965
19966
19967
19968
19969 . ////////////////////////////////////////////////////////////////////////////
19970 . ////////////////////////////////////////////////////////////////////////////
19971
19972 .chapter "The accept router" "CHID4"
19973 .cindex "&(accept)& router"
19974 .cindex "routers" "&(accept)&"
19975 The &(accept)& router has no private options of its own. Unless it is being
19976 used purely for verification (see &%verify_only%&) a transport is required to
19977 be defined by the generic &%transport%& option. If the preconditions that are
19978 specified by generic options are met, the router accepts the address and queues
19979 it for the given transport. The most common use of this router is for setting
19980 up deliveries to local mailboxes. For example:
19981 .code
19982 localusers:
19983   driver = accept
19984   domains = mydomain.example
19985   check_local_user
19986   transport = local_delivery
19987 .endd
19988 The &%domains%& condition in this example checks the domain of the address, and
19989 &%check_local_user%& checks that the local part is the login of a local user.
19990 When both preconditions are met, the &(accept)& router runs, and queues the
19991 address for the &(local_delivery)& transport.
19992
19993
19994
19995
19996
19997
19998 . ////////////////////////////////////////////////////////////////////////////
19999 . ////////////////////////////////////////////////////////////////////////////
20000
20001 .chapter "The dnslookup router" "CHAPdnslookup"
20002 .scindex IIDdnsrou1 "&(dnslookup)& router"
20003 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
20004 The &(dnslookup)& router looks up the hosts that handle mail for the
20005 recipient's domain in the DNS. A transport must always be set for this router,
20006 unless &%verify_only%& is set.
20007
20008 If SRV support is configured (see &%check_srv%& below), Exim first searches for
20009 SRV records. If none are found, or if SRV support is not configured,
20010 MX records are looked up. If no MX records exist, address records are sought.
20011 However, &%mx_domains%& can be set to disable the direct use of address
20012 records.
20013
20014 MX records of equal priority are sorted by Exim into a random order. Exim then
20015 looks for address records for the host names obtained from MX or SRV records.
20016 When a host has more than one IP address, they are sorted into a random order,
20017 except that IPv6 addresses are sorted before IPv4 addresses. If all the
20018 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
20019 generic option, the router declines.
20020
20021 Unless they have the highest priority (lowest MX value), MX records that point
20022 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
20023 are discarded, together with any other MX records of equal or lower priority.
20024
20025 .cindex "MX record" "pointing to local host"
20026 .cindex "local host" "MX pointing to"
20027 .oindex "&%self%&" "in &(dnslookup)& router"
20028 If the host pointed to by the highest priority MX record, or looked up as an
20029 address record, is the local host, or matches &%hosts_treat_as_local%&, what
20030 happens is controlled by the generic &%self%& option.
20031
20032
20033 .section "Problems with DNS lookups" "SECTprowitdnsloo"
20034 There have been problems with DNS servers when SRV records are looked up.
20035 Some misbehaving servers return a DNS error or timeout when a non-existent
20036 SRV record is sought. Similar problems have in the past been reported for
20037 MX records. The global &%dns_again_means_nonexist%& option can help with this
20038 problem, but it is heavy-handed because it is a global option.
20039
20040 For this reason, there are two options, &%srv_fail_domains%& and
20041 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
20042 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
20043 an attempt to look up an SRV or MX record causes one of these results, and the
20044 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
20045 such record"&. In the case of an SRV lookup, this means that the router
20046 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
20047 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
20048 case routing fails.
20049
20050
20051 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
20052 .cindex "&(dnslookup)& router" "declines"
20053 There are a few cases where a &(dnslookup)& router will decline to accept
20054 an address; if such a router is expected to handle "all remaining non-local
20055 domains", then it is important to set &%no_more%&.
20056
20057 The router will defer rather than decline if the domain
20058 is found in the &%fail_defer_domains%& router option.
20059
20060 Reasons for a &(dnslookup)& router to decline currently include:
20061 .ilist
20062 The domain does not exist in DNS
20063 .next
20064 The domain exists but the MX record's host part is just "."; this is a common
20065 convention (borrowed from SRV) used to indicate that there is no such service
20066 for this domain and to not fall back to trying A/AAAA records.
20067 .next
20068 Ditto, but for SRV records, when &%check_srv%& is set on this router.
20069 .next
20070 MX record points to a non-existent host.
20071 .next
20072 MX record points to an IP address and the main section option
20073 &%allow_mx_to_ip%& is not set.
20074 .next
20075 MX records exist and point to valid hosts, but all hosts resolve only to
20076 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
20077 .next
20078 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
20079 &%dns_check_names_pattern%& for handling one variant of this)
20080 .next
20081 &%check_secondary_mx%& is set on this router but the local host can
20082 not be found in the MX records (see below)
20083 .endlist
20084
20085
20086
20087
20088 .section "Private options for dnslookup" "SECID118"
20089 .cindex "options" "&(dnslookup)& router"
20090 The private options for the &(dnslookup)& router are as follows:
20091
20092 .option check_secondary_mx dnslookup boolean false
20093 .cindex "MX record" "checking for secondary"
20094 If this option is set, the router declines unless the local host is found in
20095 (and removed from) the list of hosts obtained by MX lookup. This can be used to
20096 process domains for which the local host is a secondary mail exchanger
20097 differently to other domains. The way in which Exim decides whether a host is
20098 the local host is described in section &<<SECTreclocipadd>>&.
20099
20100
20101 .option check_srv dnslookup string&!! unset
20102 .cindex "SRV record" "enabling use of"
20103 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
20104 addition to MX and address records. The support is disabled by default. To
20105 enable SRV support, set the &%check_srv%& option to the name of the service
20106 required. For example,
20107 .code
20108 check_srv = smtp
20109 .endd
20110 looks for SRV records that refer to the normal smtp service. The option is
20111 expanded, so the service name can vary from message to message or address
20112 to address. This might be helpful if SRV records are being used for a
20113 submission service. If the expansion is forced to fail, the &%check_srv%&
20114 option is ignored, and the router proceeds to look for MX records in the
20115 normal way.
20116
20117 When the expansion succeeds, the router searches first for SRV records for
20118 the given service (it assumes TCP protocol). A single SRV record with a
20119 host name that consists of just a single dot indicates &"no such service for
20120 this domain"&; if this is encountered, the router declines. If other kinds of
20121 SRV record are found, they are used to construct a host list for delivery
20122 according to the rules of RFC 2782. MX records are not sought in this case.
20123
20124 When no SRV records are found, MX records (and address records) are sought in
20125 the traditional way. In other words, SRV records take precedence over MX
20126 records, just as MX records take precedence over address records. Note that
20127 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
20128 defined it. It is apparently believed that MX records are sufficient for email
20129 and that SRV records should not be used for this purpose. However, SRV records
20130 have an additional &"weight"& feature which some people might find useful when
20131 trying to split an SMTP load between hosts of different power.
20132
20133 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
20134 when there is a DNS lookup error.
20135
20136
20137
20138
20139 .option fail_defer_domains dnslookup "domain list&!!" unset
20140 .cindex "MX record" "not found"
20141 DNS lookups for domains matching &%fail_defer_domains%&
20142 which find no matching record will cause the router to defer
20143 rather than the default behaviour of decline.
20144 This maybe be useful for queueing messages for a newly created
20145 domain while the DNS configuration is not ready.
20146 However, it will result in any message with mistyped domains
20147 also being queued.
20148
20149
20150 .option ipv4_only "string&!!" unset
20151 .cindex IPv6 disabling
20152 .cindex DNS "IPv6 disabling"
20153 The string is expanded, and if the result is anything but a forced failure,
20154 or an empty string, or one of the strings “0” or “no” or “false”
20155 (checked without regard to the case of the letters),
20156 only A records are used.
20157
20158 .option ipv4_prefer "string&!!" unset
20159 .cindex IPv4 preference
20160 .cindex DNS "IPv4 preference"
20161 The string is expanded, and if the result is anything but a forced failure,
20162 or an empty string, or one of the strings “0” or “no” or “false”
20163 (checked without regard to the case of the letters),
20164 A records are sorted before AAAA records (inverting the default).
20165
20166 .option mx_domains dnslookup "domain list&!!" unset
20167 .cindex "MX record" "required to exist"
20168 .cindex "SRV record" "required to exist"
20169 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
20170 record in order to be recognized. (The name of this option could be improved.)
20171 For example, if all the mail hosts in &'fict.example'& are known to have MX
20172 records, except for those in &'discworld.fict.example'&, you could use this
20173 setting:
20174 .code
20175 mx_domains = ! *.discworld.fict.example : *.fict.example
20176 .endd
20177 This specifies that messages addressed to a domain that matches the list but
20178 has no MX record should be bounced immediately instead of being routed using
20179 the address record.
20180
20181
20182 .option mx_fail_domains dnslookup "domain list&!!" unset
20183 If the DNS lookup for MX records for one of the domains in this list causes a
20184 DNS lookup error, Exim behaves as if no MX records were found. See section
20185 &<<SECTprowitdnsloo>>& for more discussion.
20186
20187
20188
20189
20190 .option qualify_single dnslookup boolean true
20191 .cindex "DNS" "resolver options"
20192 .cindex "DNS" "qualifying single-component names"
20193 When this option is true, the resolver option RES_DEFNAMES is set for DNS
20194 lookups. Typically, but not standardly, this causes the resolver to qualify
20195 single-component names with the default domain. For example, on a machine
20196 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20197 &'thesaurus.ref.example'& inside the resolver. For details of what your
20198 resolver actually does, consult your man pages for &'resolver'& and
20199 &'resolv.conf'&.
20200
20201
20202
20203 .option rewrite_headers dnslookup boolean true
20204 .cindex "rewriting" "header lines"
20205 .cindex "header lines" "rewriting"
20206 If the domain name in the address that is being processed is not fully
20207 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20208 an address is specified as &'dormouse@teaparty'&, the domain might be
20209 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20210 occur as a result of setting the &%widen_domains%& option. If
20211 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20212 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20213 header lines of the message are rewritten with the full domain name.
20214
20215 This option should be turned off only when it is known that no message is
20216 ever going to be sent outside an environment where the abbreviation makes
20217 sense.
20218
20219 When an MX record is looked up in the DNS and matches a wildcard record, name
20220 servers normally return a record containing the name that has been looked up,
20221 making it impossible to detect whether a wildcard was present or not. However,
20222 some name servers have recently been seen to return the wildcard entry. If the
20223 name returned by a DNS lookup begins with an asterisk, it is not used for
20224 header rewriting.
20225
20226
20227 .option same_domain_copy_routing dnslookup boolean false
20228 .cindex "address" "copying routing"
20229 Addresses with the same domain are normally routed by the &(dnslookup)& router
20230 to the same list of hosts. However, this cannot be presumed, because the router
20231 options and preconditions may refer to the local part of the address. By
20232 default, therefore, Exim routes each address in a message independently. DNS
20233 servers run caches, so repeated DNS lookups are not normally expensive, and in
20234 any case, personal messages rarely have more than a few recipients.
20235
20236 If you are running mailing lists with large numbers of subscribers at the same
20237 domain, and you are using a &(dnslookup)& router which is independent of the
20238 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20239 lookups for identical domains in one message. In this case, when &(dnslookup)&
20240 routes an address to a remote transport, any other unrouted addresses in the
20241 message that have the same domain are automatically given the same routing
20242 without processing them independently,
20243 provided the following conditions are met:
20244
20245 .ilist
20246 No router that processed the address specified &%headers_add%& or
20247 &%headers_remove%&.
20248 .next
20249 The router did not change the address in any way, for example, by &"widening"&
20250 the domain.
20251 .endlist
20252
20253
20254
20255
20256 .option search_parents dnslookup boolean false
20257 .cindex "DNS" "resolver options"
20258 When this option is true, the resolver option RES_DNSRCH is set for DNS
20259 lookups. This is different from the &%qualify_single%& option in that it
20260 applies to domains containing dots. Typically, but not standardly, it causes
20261 the resolver to search for the name in the current domain and in parent
20262 domains. For example, on a machine in the &'fict.example'& domain, if looking
20263 up &'teaparty.wonderland'& failed, the resolver would try
20264 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20265 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20266
20267 Setting this option true can cause problems in domains that have a wildcard MX
20268 record, because any domain that does not have its own MX record matches the
20269 local wildcard.
20270
20271
20272
20273 .option srv_fail_domains dnslookup "domain list&!!" unset
20274 If the DNS lookup for SRV records for one of the domains in this list causes a
20275 DNS lookup error, Exim behaves as if no SRV records were found. See section
20276 &<<SECTprowitdnsloo>>& for more discussion.
20277
20278
20279
20280
20281 .option widen_domains dnslookup "string list" unset
20282 .cindex "domain" "partial; widening"
20283 If a DNS lookup fails and this option is set, each of its strings in turn is
20284 added onto the end of the domain, and the lookup is tried again. For example,
20285 if
20286 .code
20287 widen_domains = fict.example:ref.example
20288 .endd
20289 is set and a lookup of &'klingon.dictionary'& fails,
20290 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20291 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20292 and &%search_parents%& options can cause some widening to be undertaken inside
20293 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20294 when verifying, unless &%rewrite_headers%& is false (not the default).
20295
20296
20297 .section "Effect of qualify_single and search_parents" "SECID119"
20298 When a domain from an envelope recipient is changed by the resolver as a result
20299 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20300 corresponding address in the message's header lines unless &%rewrite_headers%&
20301 is set false. Exim then re-routes the address, using the full domain.
20302
20303 These two options affect only the DNS lookup that takes place inside the router
20304 for the domain of the address that is being routed. They do not affect lookups
20305 such as that implied by
20306 .code
20307 domains = @mx_any
20308 .endd
20309 that may happen while processing a router precondition before the router is
20310 entered. No widening ever takes place for these lookups.
20311 .ecindex IIDdnsrou1
20312 .ecindex IIDdnsrou2
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322 . ////////////////////////////////////////////////////////////////////////////
20323 . ////////////////////////////////////////////////////////////////////////////
20324
20325 .chapter "The ipliteral router" "CHID5"
20326 .cindex "&(ipliteral)& router"
20327 .cindex "domain literal" "routing"
20328 .cindex "routers" "&(ipliteral)&"
20329 This router has no private options. Unless it is being used purely for
20330 verification (see &%verify_only%&) a transport is required to be defined by the
20331 generic &%transport%& option. The router accepts the address if its domain part
20332 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20333 router handles the address
20334 .code
20335 root@[192.168.1.1]
20336 .endd
20337 by setting up delivery to the host with that IP address. IPv4 domain literals
20338 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20339 are similar, but the address is preceded by &`ipv6:`&. For example:
20340 .code
20341 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20342 .endd
20343 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20344 grounds that sooner or later somebody will try it.
20345
20346 .oindex "&%self%&" "in &(ipliteral)& router"
20347 If the IP address matches something in &%ignore_target_hosts%&, the router
20348 declines. If an IP literal turns out to refer to the local host, the generic
20349 &%self%& option determines what happens.
20350
20351 The RFCs require support for domain literals; however, their use is
20352 controversial in today's Internet. If you want to use this router, you must
20353 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20354 Exim will not recognize the domain literal syntax in addresses.
20355
20356
20357
20358 . ////////////////////////////////////////////////////////////////////////////
20359 . ////////////////////////////////////////////////////////////////////////////
20360
20361 .chapter "The iplookup router" "CHID6"
20362 .cindex "&(iplookup)& router"
20363 .cindex "routers" "&(iplookup)&"
20364 The &(iplookup)& router was written to fulfil a specific requirement in
20365 Cambridge University (which in fact no longer exists). For this reason, it is
20366 not included in the binary of Exim by default. If you want to include it, you
20367 must set
20368 .code
20369 ROUTER_IPLOOKUP=yes
20370 .endd
20371 in your &_Local/Makefile_& configuration file.
20372
20373 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20374 connection to one or more specific hosts. The host can then return the same or
20375 a different address &-- in effect rewriting the recipient address in the
20376 message's envelope. The new address is then passed on to subsequent routers. If
20377 this process fails, the address can be passed on to other routers, or delivery
20378 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20379 must not be specified for it.
20380
20381 .cindex "options" "&(iplookup)& router"
20382 .option hosts iplookup string unset
20383 This option must be supplied. Its value is a colon-separated list of host
20384 names. The hosts are looked up using &[gethostbyname()]&
20385 (or &[getipnodebyname()]& when available)
20386 and are tried in order until one responds to the query. If none respond, what
20387 happens is controlled by &%optional%&.
20388
20389
20390 .option optional iplookup boolean false
20391 If &%optional%& is true, if no response is obtained from any host, the address
20392 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20393 delivery to the address is deferred.
20394
20395
20396 .option port iplookup integer 0
20397 .cindex "port" "&(iplookup)& router"
20398 This option must be supplied. It specifies the port number for the TCP or UDP
20399 call.
20400
20401
20402 .option protocol iplookup string udp
20403 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20404 protocols is to be used.
20405
20406
20407 .option query iplookup string&!! "see below"
20408 This defines the content of the query that is sent to the remote hosts. The
20409 default value is:
20410 .code
20411 $local_part@$domain $local_part@$domain
20412 .endd
20413 The repetition serves as a way of checking that a response is to the correct
20414 query in the default case (see &%response_pattern%& below).
20415
20416
20417 .option reroute iplookup string&!! unset
20418 If this option is not set, the rerouted address is precisely the byte string
20419 returned by the remote host, up to the first white space, if any. If set, the
20420 string is expanded to form the rerouted address. It can include parts matched
20421 in the response by &%response_pattern%& by means of numeric variables such as
20422 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20423 whether or not a pattern is in use. In all cases, the rerouted address must end
20424 up in the form &'local_part@domain'&.
20425
20426
20427 .option response_pattern iplookup string unset
20428 This option can be set to a regular expression that is applied to the string
20429 returned from the remote host. If the pattern does not match the response, the
20430 router declines. If &%response_pattern%& is not set, no checking of the
20431 response is done, unless the query was defaulted, in which case there is a
20432 check that the text returned after the first white space is the original
20433 address. This checks that the answer that has been received is in response to
20434 the correct question. For example, if the response is just a new domain, the
20435 following could be used:
20436 .code
20437 response_pattern = ^([^@]+)$
20438 reroute = $local_part@$1
20439 .endd
20440
20441 .option timeout iplookup time 5s
20442 This specifies the amount of time to wait for a response from the remote
20443 machine. The same timeout is used for the &[connect()]& function for a TCP
20444 call. It does not apply to UDP.
20445
20446
20447
20448
20449 . ////////////////////////////////////////////////////////////////////////////
20450 . ////////////////////////////////////////////////////////////////////////////
20451
20452 .chapter "The manualroute router" "CHID7"
20453 .scindex IIDmanrou1 "&(manualroute)& router"
20454 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20455 .cindex "domain" "manually routing"
20456 The &(manualroute)& router is so-called because it provides a way of manually
20457 routing an address according to its domain. It is mainly used when you want to
20458 route addresses to remote hosts according to your own rules, bypassing the
20459 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20460 route to local transports, a facility that may be useful if you want to save
20461 messages for dial-in hosts in local files.
20462
20463 The &(manualroute)& router compares a list of domain patterns with the domain
20464 it is trying to route. If there is no match, the router declines. Each pattern
20465 has associated with it a list of hosts and some other optional data, which may
20466 include a transport. The combination of a pattern and its data is called a
20467 &"routing rule"&. For patterns that do not have an associated transport, the
20468 generic &%transport%& option must specify a transport, unless the router is
20469 being used purely for verification (see &%verify_only%&).
20470
20471 .vindex "&$host$&"
20472 In the case of verification, matching the domain pattern is sufficient for the
20473 router to accept the address. When actually routing an address for delivery,
20474 an address that matches a domain pattern is queued for the associated
20475 transport. If the transport is not a local one, a host list must be associated
20476 with the pattern; IP addresses are looked up for the hosts, and these are
20477 passed to the transport along with the mail address. For local transports, a
20478 host list is optional. If it is present, it is passed in &$host$& as a single
20479 text string.
20480
20481 The list of routing rules can be provided as an inline string in
20482 &%route_list%&, or the data can be obtained by looking up the domain in a file
20483 or database by setting &%route_data%&. Only one of these settings may appear in
20484 any one instance of &(manualroute)&. The format of routing rules is described
20485 below, following the list of private options.
20486
20487
20488 .section "Private options for manualroute" "SECTprioptman"
20489
20490 .cindex "options" "&(manualroute)& router"
20491 The private options for the &(manualroute)& router are as follows:
20492
20493 .option host_all_ignored manualroute string defer
20494 See &%host_find_failed%&.
20495
20496 .option host_find_failed manualroute string freeze
20497 This option controls what happens when &(manualroute)& tries to find an IP
20498 address for a host, and the host does not exist. The option can be set to one
20499 of the following values:
20500 .code
20501 decline
20502 defer
20503 fail
20504 freeze
20505 ignore
20506 pass
20507 .endd
20508 The default (&"freeze"&) assumes that this state is a serious configuration
20509 error. The difference between &"pass"& and &"decline"& is that the former
20510 forces the address to be passed to the next router (or the router defined by
20511 &%pass_router%&),
20512 .oindex "&%more%&"
20513 overriding &%no_more%&, whereas the latter passes the address to the next
20514 router only if &%more%& is true.
20515
20516 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20517 cannot be found. If all the hosts in the list are ignored, the behaviour is
20518 controlled by the &%host_all_ignored%& option. This takes the same values
20519 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20520
20521 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20522 state; if a host lookup gets a temporary error, delivery is deferred unless the
20523 generic &%pass_on_timeout%& option is set.
20524
20525
20526 .option hosts_randomize manualroute boolean false
20527 .cindex "randomized host list"
20528 .cindex "host" "list of; randomized"
20529 If this option is set, the order of the items in a host list in a routing rule
20530 is randomized each time the list is used, unless an option in the routing rule
20531 overrides (see below). Randomizing the order of a host list can be used to do
20532 crude load sharing. However, if more than one mail address is routed by the
20533 same router to the same host list, the host lists are considered to be the same
20534 (even though they may be randomized into different orders) for the purpose of
20535 deciding whether to batch the deliveries into a single SMTP transaction.
20536
20537 When &%hosts_randomize%& is true, a host list may be split
20538 into groups whose order is separately randomized. This makes it possible to
20539 set up MX-like behaviour. The boundaries between groups are indicated by an
20540 item that is just &`+`& in the host list. For example:
20541 .code
20542 route_list = * host1:host2:host3:+:host4:host5
20543 .endd
20544 The order of the first three hosts and the order of the last two hosts is
20545 randomized for each use, but the first three always end up before the last two.
20546 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20547 randomized host list is passed to an &(smtp)& transport that also has
20548 &%hosts_randomize set%&, the list is not re-randomized.
20549
20550
20551 .option route_data manualroute string&!! unset
20552 If this option is set, it must expand to yield the data part of a routing rule.
20553 Typically, the expansion string includes a lookup based on the domain. For
20554 example:
20555 .code
20556 route_data = ${lookup{$domain}dbm{/etc/routes}}
20557 .endd
20558 If the expansion is forced to fail, or the result is an empty string, the
20559 router declines. Other kinds of expansion failure cause delivery to be
20560 deferred.
20561
20562
20563 .option route_list manualroute "string list" unset
20564 This string is a list of routing rules, in the form defined below. Note that,
20565 unlike most string lists, the items are separated by semicolons. This is so
20566 that they may contain colon-separated host lists.
20567
20568
20569 .option same_domain_copy_routing manualroute boolean false
20570 .cindex "address" "copying routing"
20571 Addresses with the same domain are normally routed by the &(manualroute)&
20572 router to the same list of hosts. However, this cannot be presumed, because the
20573 router options and preconditions may refer to the local part of the address. By
20574 default, therefore, Exim routes each address in a message independently. DNS
20575 servers run caches, so repeated DNS lookups are not normally expensive, and in
20576 any case, personal messages rarely have more than a few recipients.
20577
20578 If you are running mailing lists with large numbers of subscribers at the same
20579 domain, and you are using a &(manualroute)& router which is independent of the
20580 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20581 lookups for identical domains in one message. In this case, when
20582 &(manualroute)& routes an address to a remote transport, any other unrouted
20583 addresses in the message that have the same domain are automatically given the
20584 same routing without processing them independently. However, this is only done
20585 if &%headers_add%& and &%headers_remove%& are unset.
20586
20587
20588
20589
20590 .section "Routing rules in route_list" "SECID120"
20591 The value of &%route_list%& is a string consisting of a sequence of routing
20592 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20593 entered as two semicolons. Alternatively, the list separator can be changed as
20594 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20595 Empty rules are ignored. The format of each rule is
20596 .display
20597 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20598 .endd
20599 The following example contains two rules, each with a simple domain pattern and
20600 no options:
20601 .code
20602 route_list = \
20603   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20604   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20605 .endd
20606 The three parts of a rule are separated by white space. The pattern and the
20607 list of hosts can be enclosed in quotes if necessary, and if they are, the
20608 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20609 single domain pattern, which is the only mandatory item in the rule. The
20610 pattern is in the same format as one item in a domain list (see section
20611 &<<SECTdomainlist>>&),
20612 except that it may not be the name of an interpolated file.
20613 That is, it may be wildcarded, or a regular expression, or a file or database
20614 lookup (with semicolons doubled, because of the use of semicolon as a separator
20615 in a &%route_list%&).
20616
20617 The rules in &%route_list%& are searched in order until one of the patterns
20618 matches the domain that is being routed. The list of hosts and then options are
20619 then used as described below. If there is no match, the router declines. When
20620 &%route_list%& is set, &%route_data%& must not be set.
20621
20622
20623
20624 .section "Routing rules in route_data" "SECID121"
20625 The use of &%route_list%& is convenient when there are only a small number of
20626 routing rules. For larger numbers, it is easier to use a file or database to
20627 hold the routing information, and use the &%route_data%& option instead.
20628 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20629 Most commonly, &%route_data%& is set as a string that contains an
20630 expansion lookup. For example, suppose we place two routing rules in a file
20631 like this:
20632 .code
20633 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20634 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20635 .endd
20636 This data can be accessed by setting
20637 .code
20638 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20639 .endd
20640 Failure of the lookup results in an empty string, causing the router to
20641 decline. However, you do not have to use a lookup in &%route_data%&. The only
20642 requirement is that the result of expanding the string is a list of hosts,
20643 possibly followed by options, separated by white space. The list of hosts must
20644 be enclosed in quotes if it contains white space.
20645
20646
20647
20648
20649 .section "Format of the list of hosts" "SECID122"
20650 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20651 always separately expanded before use. If the expansion fails, the router
20652 declines. The result of the expansion must be a colon-separated list of names
20653 and/or IP addresses, optionally also including ports.
20654 If the list is written with spaces, it must be protected with quotes.
20655 The format of each item
20656 in the list is described in the next section. The list separator can be changed
20657 as described in section &<<SECTlistsepchange>>&.
20658
20659 If the list of hosts was obtained from a &%route_list%& item, the following
20660 variables are set during its expansion:
20661
20662 .ilist
20663 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20664 If the domain was matched against a regular expression, the numeric variables
20665 &$1$&, &$2$&, etc. may be set. For example:
20666 .code
20667 route_list = ^domain(\d+)   host-$1.text.example
20668 .endd
20669 .next
20670 &$0$& is always set to the entire domain.
20671 .next
20672 &$1$& is also set when partial matching is done in a file lookup.
20673
20674 .next
20675 .vindex "&$value$&"
20676 If the pattern that matched the domain was a lookup item, the data that was
20677 looked up is available in the expansion variable &$value$&. For example:
20678 .code
20679 route_list = lsearch;;/some/file.routes  $value
20680 .endd
20681 .endlist
20682
20683 Note the doubling of the semicolon in the pattern that is necessary because
20684 semicolon is the default route list separator.
20685
20686
20687
20688 .section "Format of one host item" "SECTformatonehostitem"
20689 Each item in the list of hosts can be either a host name or an IP address,
20690 optionally with an attached port number, or it can be a single "+"
20691 (see &%hosts_randomize%&).
20692 When no port is given, an IP address
20693 is not enclosed in brackets. When a port is specified, it overrides the port
20694 specification on the transport. The port is separated from the name or address
20695 by a colon. This leads to some complications:
20696
20697 .ilist
20698 Because colon is the default separator for the list of hosts, either
20699 the colon that specifies a port must be doubled, or the list separator must
20700 be changed. The following two examples have the same effect:
20701 .code
20702 route_list = * "host1.tld::1225 : host2.tld::1226"
20703 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20704 .endd
20705 .next
20706 When IPv6 addresses are involved, it gets worse, because they contain
20707 colons of their own. To make this case easier, it is permitted to
20708 enclose an IP address (either v4 or v6) in square brackets if a port
20709 number follows. For example:
20710 .code
20711 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20712 .endd
20713 .endlist
20714
20715 .section "How the list of hosts is used" "SECThostshowused"
20716 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20717 the hosts is tried, in the order specified, when carrying out the SMTP
20718 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20719 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20720 transport.
20721
20722 Hosts may be listed by name or by IP address. An unadorned name in the list of
20723 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20724 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20725 records in the DNS. For example:
20726 .code
20727 route_list = *  x.y.z:p.q.r/MX:e.f.g
20728 .endd
20729 If this feature is used with a port specifier, the port must come last. For
20730 example:
20731 .code
20732 route_list = *  dom1.tld/mx::1225
20733 .endd
20734 If the &%hosts_randomize%& option is set, the order of the items in the list is
20735 randomized before any lookups are done. Exim then scans the list; for any name
20736 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20737 be an interface on the local host and the item is not the first in the list,
20738 Exim discards it and any subsequent items. If it is the first item, what
20739 happens is controlled by the
20740 .oindex "&%self%&" "in &(manualroute)& router"
20741 &%self%& option of the router.
20742
20743 A name on the list that is followed by &`/MX`& is replaced with the list of
20744 hosts obtained by looking up MX records for the name. This is always a DNS
20745 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20746 below) are not relevant here. The order of these hosts is determined by the
20747 preference values in the MX records, according to the usual rules. Because
20748 randomizing happens before the MX lookup, it does not affect the order that is
20749 defined by MX preferences.
20750
20751 If the local host is present in the sublist obtained from MX records, but is
20752 not the most preferred host in that list, it and any equally or less
20753 preferred hosts are removed before the sublist is inserted into the main list.
20754
20755 If the local host is the most preferred host in the MX list, what happens
20756 depends on where in the original list of hosts the &`/MX`& item appears. If it
20757 is not the first item (that is, there are previous hosts in the main list),
20758 Exim discards this name and any subsequent items in the main list.
20759
20760 If the MX item is first in the list of hosts, and the local host is the
20761 most preferred host, what happens is controlled by the &%self%& option of the
20762 router.
20763
20764 DNS failures when lookup up the MX records are treated in the same way as DNS
20765 failures when looking up IP addresses: &%pass_on_timeout%& and
20766 &%host_find_failed%& are used when relevant.
20767
20768 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20769 whether obtained from an MX lookup or not.
20770
20771
20772
20773 .section "How the options are used" "SECThowoptused"
20774 The options are a sequence of words, space-separated.
20775 One of the words can be the name of a transport; this overrides the
20776 &%transport%& option on the router for this particular routing rule only. The
20777 other words (if present) control randomization of the list of hosts on a
20778 per-rule basis, and how the IP addresses of the hosts are to be found when
20779 routing to a remote transport. These options are as follows:
20780
20781 .ilist
20782 &%randomize%&: randomize the order of the hosts in this list, overriding the
20783 setting of &%hosts_randomize%& for this routing rule only.
20784 .next
20785 &%no_randomize%&: do not randomize the order of the hosts in this list,
20786 overriding the setting of &%hosts_randomize%& for this routing rule only.
20787 .next
20788 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20789 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20790 also look in &_/etc/hosts_& or other sources of information.
20791 .next
20792 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20793 no address records are found. If there is a temporary DNS error (such as a
20794 timeout), delivery is deferred.
20795 .next
20796 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20797 .next
20798 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20799 .endlist
20800
20801 For example:
20802 .code
20803 route_list = domain1  host1:host2:host3  randomize bydns;\
20804              domain2  host4:host5
20805 .endd
20806 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20807 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20808 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20809 or &[gethostbyname()]&, and the result of the lookup is the result of that
20810 call.
20811
20812 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20813 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20814 instead of TRY_AGAIN. That is why the default action is to try a DNS
20815 lookup first. Only if that gives a definite &"no such host"& is the local
20816 function called.
20817
20818 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20819 inadvertent constraint that a transport name as an option had to be the last
20820 option specified.
20821
20822
20823
20824 If no IP address for a host can be found, what happens is controlled by the
20825 &%host_find_failed%& option.
20826
20827 .vindex "&$host$&"
20828 When an address is routed to a local transport, IP addresses are not looked up.
20829 The host list is passed to the transport in the &$host$& variable.
20830
20831
20832
20833 .section "Manualroute examples" "SECID123"
20834 In some of the examples that follow, the presence of the &%remote_smtp%&
20835 transport, as defined in the default configuration file, is assumed:
20836
20837 .ilist
20838 .cindex "smart host" "example router"
20839 The &(manualroute)& router can be used to forward all external mail to a
20840 &'smart host'&. If you have set up, in the main part of the configuration, a
20841 named domain list that contains your local domains, for example:
20842 .code
20843 domainlist local_domains = my.domain.example
20844 .endd
20845 You can arrange for all other domains to be routed to a smart host by making
20846 your first router something like this:
20847 .code
20848 smart_route:
20849   driver = manualroute
20850   domains = !+local_domains
20851   transport = remote_smtp
20852   route_list = * smarthost.ref.example
20853 .endd
20854 This causes all non-local addresses to be sent to the single host
20855 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20856 they are tried in order
20857 (but you can use &%hosts_randomize%& to vary the order each time).
20858 Another way of configuring the same thing is this:
20859 .code
20860 smart_route:
20861   driver = manualroute
20862   transport = remote_smtp
20863   route_list = !+local_domains  smarthost.ref.example
20864 .endd
20865 There is no difference in behaviour between these two routers as they stand.
20866 However, they behave differently if &%no_more%& is added to them. In the first
20867 example, the router is skipped if the domain does not match the &%domains%&
20868 precondition; the following router is always tried. If the router runs, it
20869 always matches the domain and so can never decline. Therefore, &%no_more%&
20870 would have no effect. In the second case, the router is never skipped; it
20871 always runs. However, if it doesn't match the domain, it declines. In this case
20872 &%no_more%& would prevent subsequent routers from running.
20873
20874 .next
20875 .cindex "mail hub example"
20876 A &'mail hub'& is a host which receives mail for a number of domains via MX
20877 records in the DNS and delivers it via its own private routing mechanism. Often
20878 the final destinations are behind a firewall, with the mail hub being the one
20879 machine that can connect to machines both inside and outside the firewall. The
20880 &(manualroute)& router is usually used on a mail hub to route incoming messages
20881 to the correct hosts. For a small number of domains, the routing can be inline,
20882 using the &%route_list%& option, but for a larger number a file or database
20883 lookup is easier to manage.
20884
20885 If the domain names are in fact the names of the machines to which the mail is
20886 to be sent by the mail hub, the configuration can be quite simple. For
20887 example:
20888 .code
20889 hub_route:
20890   driver = manualroute
20891   transport = remote_smtp
20892   route_list = *.rhodes.tvs.example  $domain
20893 .endd
20894 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20895 whose names are the same as the mail domains. A similar approach can be taken
20896 if the host name can be obtained from the domain name by a string manipulation
20897 that the expansion facilities can handle. Otherwise, a lookup based on the
20898 domain can be used to find the host:
20899 .code
20900 through_firewall:
20901   driver = manualroute
20902   transport = remote_smtp
20903   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20904 .endd
20905 The result of the lookup must be the name or IP address of the host (or
20906 hosts) to which the address is to be routed. If the lookup fails, the route
20907 data is empty, causing the router to decline. The address then passes to the
20908 next router.
20909
20910 .next
20911 .cindex "batched SMTP output example"
20912 .cindex "SMTP" "batched outgoing; example"
20913 You can use &(manualroute)& to deliver messages to pipes or files in batched
20914 SMTP format for onward transportation by some other means. This is one way of
20915 storing mail for a dial-up host when it is not connected. The route list entry
20916 can be as simple as a single domain name in a configuration like this:
20917 .code
20918 save_in_file:
20919   driver = manualroute
20920   transport = batchsmtp_appendfile
20921   route_list = saved.domain.example
20922 .endd
20923 though often a pattern is used to pick up more than one domain. If there are
20924 several domains or groups of domains with different transport requirements,
20925 different transports can be listed in the routing information:
20926 .code
20927 save_in_file:
20928   driver = manualroute
20929   route_list = \
20930     *.saved.domain1.example  $domain  batch_appendfile; \
20931     *.saved.domain2.example  \
20932       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20933       batch_pipe
20934 .endd
20935 .vindex "&$domain$&"
20936 .vindex "&$host$&"
20937 The first of these just passes the domain in the &$host$& variable, which
20938 doesn't achieve much (since it is also in &$domain$&), but the second does a
20939 file lookup to find a value to pass, causing the router to decline to handle
20940 the address if the lookup fails.
20941
20942 .next
20943 .cindex "UUCP" "example of router for"
20944 Routing mail directly to UUCP software is a specific case of the use of
20945 &(manualroute)& in a gateway to another mail environment. This is an example of
20946 one way it can be done:
20947 .code
20948 # Transport
20949 uucp:
20950   driver = pipe
20951   user = nobody
20952   command = /usr/local/bin/uux -r - \
20953     ${substr_-5:$host}!rmail ${local_part}
20954   return_fail_output = true
20955
20956 # Router
20957 uucphost:
20958   transport = uucp
20959   driver = manualroute
20960   route_data = \
20961     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20962 .endd
20963 The file &_/usr/local/exim/uucphosts_& contains entries like
20964 .code
20965 darksite.ethereal.example:           darksite.UUCP
20966 .endd
20967 It can be set up more simply without adding and removing &".UUCP"& but this way
20968 makes clear the distinction between the domain name
20969 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20970 .endlist
20971 .ecindex IIDmanrou1
20972 .ecindex IIDmanrou2
20973
20974
20975
20976
20977
20978
20979
20980
20981 . ////////////////////////////////////////////////////////////////////////////
20982 . ////////////////////////////////////////////////////////////////////////////
20983
20984 .chapter "The queryprogram router" "CHAPdriverlast"
20985 .scindex IIDquerou1 "&(queryprogram)& router"
20986 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20987 .cindex "routing" "by external program"
20988 The &(queryprogram)& router routes an address by running an external command
20989 and acting on its output. This is an expensive way to route, and is intended
20990 mainly for use in lightly-loaded systems, or for performing experiments.
20991 However, if it is possible to use the precondition options (&%domains%&,
20992 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20993 be used in special cases, even on a busy host. There are the following private
20994 options:
20995 .cindex "options" "&(queryprogram)& router"
20996
20997 .option command queryprogram string&!! unset
20998 This option must be set. It specifies the command that is to be run. The
20999 command is split up into a command name and arguments, and then each is
21000 expanded separately (exactly as for a &(pipe)& transport, described in chapter
21001 &<<CHAPpipetransport>>&).
21002
21003
21004 .option command_group queryprogram string unset
21005 .cindex "gid (group id)" "in &(queryprogram)& router"
21006 This option specifies a gid to be set when running the command while routing an
21007 address for deliver. It must be set if &%command_user%& specifies a numerical
21008 uid. If it begins with a digit, it is interpreted as the numerical value of the
21009 gid. Otherwise it is looked up using &[getgrnam()]&.
21010
21011
21012 .option command_user queryprogram string unset
21013 .cindex "uid (user id)" "for &(queryprogram)&"
21014 This option must be set. It specifies the uid which is set when running the
21015 command while routing an address for delivery. If the value begins with a digit,
21016 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
21017 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
21018 not set, a value for the gid also.
21019
21020 &*Warning:*& Changing uid and gid is possible only when Exim is running as
21021 root, which it does during a normal delivery in a conventional configuration.
21022 However, when an address is being verified during message reception, Exim is
21023 usually running as the Exim user, not as root. If the &(queryprogram)& router
21024 is called from a non-root process, Exim cannot change uid or gid before running
21025 the command. In this circumstance the command runs under the current uid and
21026 gid.
21027
21028
21029 .option current_directory queryprogram string /
21030 This option specifies an absolute path which is made the current directory
21031 before running the command.
21032
21033
21034 .option timeout queryprogram time 1h
21035 If the command does not complete within the timeout period, its process group
21036 is killed and the message is frozen. A value of zero time specifies no
21037 timeout.
21038
21039
21040 The standard output of the command is connected to a pipe, which is read when
21041 the command terminates. It should consist of a single line of output,
21042 containing up to five fields, separated by white space. The maximum length of
21043 the line is 1023 characters. Longer lines are silently truncated. The first
21044 field is one of the following words (case-insensitive):
21045
21046 .ilist
21047 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
21048 below).
21049 .next
21050 &'Decline'&: the router declines; pass the address to the next router, unless
21051 &%no_more%& is set.
21052 .next
21053 &'Fail'&: routing failed; do not pass the address to any more routers. Any
21054 subsequent text on the line is an error message. If the router is run as part
21055 of address verification during an incoming SMTP message, the message is
21056 included in the SMTP response.
21057 .next
21058 &'Defer'&: routing could not be completed at this time; try again later. Any
21059 subsequent text on the line is an error message which is logged. It is not
21060 included in any SMTP response.
21061 .next
21062 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
21063 .next
21064 &'Pass'&: pass the address to the next router (or the router specified by
21065 &%pass_router%&), overriding &%no_more%&.
21066 .next
21067 &'Redirect'&: the message is redirected. The remainder of the line is a list of
21068 new addresses, which are routed independently, starting with the first router,
21069 or the router specified by &%redirect_router%&, if set.
21070 .endlist
21071
21072 When the first word is &'accept'&, the remainder of the line consists of a
21073 number of keyed data values, as follows (split into two lines here, to fit on
21074 the page):
21075 .code
21076 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
21077 LOOKUP=byname|bydns DATA=<text>
21078 .endd
21079 The data items can be given in any order, and all are optional. If no transport
21080 is included, the transport specified by the generic &%transport%& option is
21081 used. The list of hosts and the lookup type are needed only if the transport is
21082 an &(smtp)& transport that does not itself supply a list of hosts.
21083
21084 The format of the list of hosts is the same as for the &(manualroute)& router.
21085 As well as host names and IP addresses with optional port numbers, as described
21086 in section &<<SECTformatonehostitem>>&, it may contain names followed by
21087 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
21088 (see section &<<SECThostshowused>>&).
21089
21090 If the lookup type is not specified, Exim behaves as follows when trying to
21091 find an IP address for each host: First, a DNS lookup is done. If this yields
21092 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
21093 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
21094 result of the lookup is the result of that call.
21095
21096 .vindex "&$address_data$&"
21097 If the DATA field is set, its value is placed in the &$address_data$&
21098 variable. For example, this return line
21099 .code
21100 accept hosts=x1.y.example:x2.y.example data="rule1"
21101 .endd
21102 routes the address to the default transport, passing a list of two hosts. When
21103 the transport runs, the string &"rule1"& is in &$address_data$&.
21104 .ecindex IIDquerou1
21105 .ecindex IIDquerou2
21106
21107
21108
21109
21110 . ////////////////////////////////////////////////////////////////////////////
21111 . ////////////////////////////////////////////////////////////////////////////
21112
21113 .chapter "The redirect router" "CHAPredirect"
21114 .scindex IIDredrou1 "&(redirect)& router"
21115 .scindex IIDredrou2 "routers" "&(redirect)&"
21116 .cindex "alias file" "in a &(redirect)& router"
21117 .cindex "address redirection" "&(redirect)& router"
21118 The &(redirect)& router handles several kinds of address redirection. Its most
21119 common uses are for resolving local part aliases from a central alias file
21120 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
21121 files, but it has many other potential uses. The incoming address can be
21122 redirected in several different ways:
21123
21124 .ilist
21125 It can be replaced by one or more new addresses which are themselves routed
21126 independently.
21127 .next
21128 It can be routed to be delivered to a given file or directory.
21129 .next
21130 It can be routed to be delivered to a specified pipe command.
21131 .next
21132 It can cause an automatic reply to be generated.
21133 .next
21134 It can be forced to fail, optionally with a custom error message.
21135 .next
21136 It can be temporarily deferred, optionally with a custom message.
21137 .next
21138 It can be discarded.
21139 .endlist
21140
21141 The generic &%transport%& option must not be set for &(redirect)& routers.
21142 However, there are some private options which define transports for delivery to
21143 files and pipes, and for generating autoreplies. See the &%file_transport%&,
21144 &%pipe_transport%& and &%reply_transport%& descriptions below.
21145
21146 If success DSNs have been requested
21147 .cindex "DSN" "success"
21148 .cindex "Delivery Status Notification" "success"
21149 redirection triggers one and the DSN options are not passed any further.
21150
21151
21152
21153 .section "Redirection data" "SECID124"
21154 The router operates by interpreting a text string which it obtains either by
21155 expanding the contents of the &%data%& option, or by reading the entire
21156 contents of a file whose name is given in the &%file%& option. These two
21157 options are mutually exclusive. The first is commonly used for handling system
21158 aliases, in a configuration like this:
21159 .code
21160 system_aliases:
21161   driver = redirect
21162   data = ${lookup{$local_part}lsearch{/etc/aliases}}
21163 .endd
21164 If the lookup fails, the expanded string in this example is empty. When the
21165 expansion of &%data%& results in an empty string, the router declines. A forced
21166 expansion failure also causes the router to decline; other expansion failures
21167 cause delivery to be deferred.
21168
21169 A configuration using &%file%& is commonly used for handling users'
21170 &_.forward_& files, like this:
21171 .code
21172 userforward:
21173   driver = redirect
21174   check_local_user
21175   file = $home/.forward
21176   no_verify
21177 .endd
21178 If the file does not exist, or causes no action to be taken (for example, it is
21179 empty or consists only of comments), the router declines. &*Warning*&: This
21180 is not the case when the file contains syntactically valid items that happen to
21181 yield empty addresses, for example, items containing only RFC 2822 address
21182 comments.
21183
21184 .cindex "tainted data" "in filenames"
21185 .cindex redirect "tainted data"
21186 Tainted data may not be used for a filename.
21187
21188 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
21189 directly for redirection,
21190 as they are provided by a potential attacker.
21191 In the examples above, &$local_part$& is used for looking up data held locally
21192 on the system, and not used directly (the second example derives &$home$& via
21193 the passsword file or database, using &$local_part$&).
21194
21195
21196
21197 .section "Forward files and address verification" "SECID125"
21198 .cindex "address redirection" "while verifying"
21199 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21200 &_.forward_& files, as in the example above. There are two reasons for this:
21201
21202 .ilist
21203 When Exim is receiving an incoming SMTP message from a remote host, it is
21204 running under the Exim uid, not as root. Exim is unable to change uid to read
21205 the file as the user, and it may not be able to read it as the Exim user. So in
21206 practice the router may not be able to operate.
21207 .next
21208 However, even when the router can operate, the existence of a &_.forward_& file
21209 is unimportant when verifying an address. What should be checked is whether the
21210 local part is a valid user name or not. Cutting out the redirection processing
21211 saves some resources.
21212 .endlist
21213
21214
21215
21216
21217
21218
21219 .section "Interpreting redirection data" "SECID126"
21220 .cindex "Sieve filter" "specifying in redirection data"
21221 .cindex "filter" "specifying in redirection data"
21222 The contents of the data string, whether obtained from &%data%& or &%file%&,
21223 can be interpreted in two different ways:
21224
21225 .ilist
21226 If the &%allow_filter%& option is set true, and the data begins with the text
21227 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21228 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21229 respectively. Details of the syntax and semantics of filter files are described
21230 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21231 document is intended for use by end users.
21232 .next
21233 Otherwise, the data must be a comma-separated list of redirection items, as
21234 described in the next section.
21235 .endlist
21236
21237 When a message is redirected to a file (a &"mail folder"&), the filename given
21238 in a non-filter redirection list must always be an absolute path. A filter may
21239 generate a relative path &-- how this is handled depends on the transport's
21240 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21241 for the &(appendfile)& transport.
21242
21243
21244
21245 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21246 .cindex "address redirection" "non-filter list items"
21247 When the redirection data is not an Exim or Sieve filter, for example, if it
21248 comes from a conventional alias or forward file, it consists of a list of
21249 addresses, filenames, pipe commands, or certain special items (see section
21250 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21251 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21252 depending on their default values. The items in the list are separated by
21253 commas or newlines.
21254 If a comma is required in an item, the entire item must be enclosed in double
21255 quotes.
21256
21257 Lines starting with a # character are comments, and are ignored, and # may
21258 also appear following a comma, in which case everything between the # and the
21259 next newline character is ignored.
21260
21261 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21262 double quotes are retained because some forms of mail address require their use
21263 (but never to enclose the entire address). In the following description,
21264 &"item"& refers to what remains after any surrounding double quotes have been
21265 removed.
21266
21267 .vindex "&$local_part$&"
21268 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21269 and the expansion contains a reference to &$local_part$&, you should make use
21270 of the &%quote_local_part%& expansion operator, in case the local part contains
21271 special characters. For example, to redirect all mail for the domain
21272 &'obsolete.example'&, retaining the existing local part, you could use this
21273 setting:
21274 .code
21275 data = ${quote_local_part:$local_part}@newdomain.example
21276 .endd
21277
21278
21279 .section "Redirecting to a local mailbox" "SECTredlocmai"
21280 .cindex "routing" "loops in"
21281 .cindex "loop" "while routing, avoidance of"
21282 .cindex "address redirection" "to local mailbox"
21283 A redirection item may safely be the same as the address currently under
21284 consideration. This does not cause a routing loop, because a router is
21285 automatically skipped if any ancestor of the address that is being processed
21286 is the same as the current address and was processed by the current router.
21287 Such an address is therefore passed to the following routers, so it is handled
21288 as if there were no redirection. When making this loop-avoidance test, the
21289 complete local part, including any prefix or suffix, is used.
21290
21291 .cindex "address redirection" "local part without domain"
21292 Specifying the same local part without a domain is a common usage in personal
21293 filter files when the user wants to have messages delivered to the local
21294 mailbox and also forwarded elsewhere. For example, the user whose login is
21295 &'cleo'& might have a &_.forward_& file containing this:
21296 .code
21297 cleo, cleopatra@egypt.example
21298 .endd
21299 .cindex "backslash in alias file"
21300 .cindex "alias file" "backslash in"
21301 For compatibility with other MTAs, such unqualified local parts may be
21302 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21303 it does make a difference if more than one domain is being handled
21304 synonymously.
21305
21306 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21307 2822 address that does not include a domain, the item is qualified using the
21308 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21309 addresses are qualified using the value in &%qualify_recipient%&, but you can
21310 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21311
21312 Care must be taken if there are alias names for local users.
21313 Consider an MTA handling a single local domain where the system alias file
21314 contains:
21315 .code
21316 Sam.Reman: spqr
21317 .endd
21318 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21319 messages in the local mailbox, and also forward copies elsewhere. He creates
21320 this forward file:
21321 .code
21322 Sam.Reman, spqr@reme.elsewhere.example
21323 .endd
21324 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21325 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21326 second time round, because it has previously routed it,
21327 and the following routers presumably cannot handle the alias. The forward file
21328 should really contain
21329 .code
21330 spqr, spqr@reme.elsewhere.example
21331 .endd
21332 but because this is such a common error, the &%check_ancestor%& option (see
21333 below) exists to provide a way to get round it. This is normally set on a
21334 &(redirect)& router that is handling users' &_.forward_& files.
21335
21336
21337
21338 .section "Special items in redirection lists" "SECTspecitredli"
21339 In addition to addresses, the following types of item may appear in redirection
21340 lists (that is, in non-filter redirection data):
21341
21342 .ilist
21343 .cindex "pipe" "in redirection list"
21344 .cindex "address redirection" "to pipe"
21345 An item is treated as a pipe command if it begins with &"|"& and does not parse
21346 as a valid RFC 2822 address that includes a domain. A transport for running the
21347 command must be specified by the &%pipe_transport%& option.
21348 Normally, either the router or the transport specifies a user and a group under
21349 which to run the delivery. The default is to use the Exim user and group.
21350
21351 Single or double quotes can be used for enclosing the individual arguments of
21352 the pipe command; no interpretation of escapes is done for single quotes. If
21353 the command contains a comma character, it is necessary to put the whole item
21354 in double quotes, for example:
21355 .code
21356 "|/some/command ready,steady,go"
21357 .endd
21358 since items in redirection lists are terminated by commas. Do not, however,
21359 quote just the command. An item such as
21360 .code
21361 |"/some/command ready,steady,go"
21362 .endd
21363 is interpreted as a pipe with a rather strange command name, and no arguments.
21364
21365 Note that the above example assumes that the text comes from a lookup source
21366 of some sort, so that the quotes are part of the data.  If composing a
21367 redirect router with a &%data%& option directly specifying this command, the
21368 quotes will be used by the configuration parser to define the extent of one
21369 string, but will not be passed down into the redirect router itself.  There
21370 are two main approaches to get around this: escape quotes to be part of the
21371 data itself, or avoid using this mechanism and instead create a custom
21372 transport with the &%command%& option set and reference that transport from
21373 an &%accept%& router.
21374
21375 .next
21376 .cindex "file" "in redirection list"
21377 .cindex "address redirection" "to file"
21378 An item is interpreted as a path name if it begins with &"/"& and does not
21379 parse as a valid RFC 2822 address that includes a domain. For example,
21380 .code
21381 /home/world/minbari
21382 .endd
21383 is treated as a filename, but
21384 .code
21385 /s=molari/o=babylon/@x400gate.way
21386 .endd
21387 is treated as an address. For a filename, a transport must be specified using
21388 the &%file_transport%& option. However, if the generated path name ends with a
21389 forward slash character, it is interpreted as a directory name rather than a
21390 filename, and &%directory_transport%& is used instead.
21391
21392 Normally, either the router or the transport specifies a user and a group under
21393 which to run the delivery. The default is to use the Exim user and group.
21394
21395 .cindex "&_/dev/null_&"
21396 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21397 bypassed at a high level, and the log entry shows &"**bypassed**"&
21398 instead of a transport name. In this case the user and group are not used.
21399
21400 .next
21401 .cindex "included address list"
21402 .cindex "address redirection" "included external list"
21403 If an item is of the form
21404 .code
21405 :include:<path name>
21406 .endd
21407 a list of further items is taken from the given file and included at that
21408 point. &*Note*&: Such a file can not be a filter file; it is just an
21409 out-of-line addition to the list. The items in the included list are separated
21410 by commas or newlines and are not subject to expansion. If this is the first
21411 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21412 the alias name. This example is incorrect:
21413 .code
21414 list1    :include:/opt/lists/list1
21415 .endd
21416 It must be given as
21417 .code
21418 list1:   :include:/opt/lists/list1
21419 .endd
21420 .cindex "tainted data" "in filenames"
21421 .cindex redirect "tainted data"
21422 Tainted data may not be used for a filename.
21423 .next
21424 .cindex "address redirection" "to black hole"
21425 .cindex "delivery" "discard"
21426 .cindex "delivery" "blackhole"
21427 .cindex "black hole"
21428 .cindex "abandoning mail"
21429 Sometimes you want to throw away mail to a particular local part.  Making the
21430 &%data%& option expand to an empty string does not work, because that causes
21431 the router to decline. Instead, the alias item
21432 .code
21433 :blackhole:
21434 .endd
21435 can be used. It does what its name implies. No delivery is
21436 done, and no error message is generated. This has the same effect as specifying
21437 &_/dev/null_& as a destination, but it can be independently disabled.
21438
21439 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21440 delivery is done for the original local part, even if other redirection items
21441 are present. If you are generating a multi-item list (for example, by reading a
21442 database) and need the ability to provide a no-op item, you must use
21443 &_/dev/null_&.
21444
21445 .next
21446 .cindex "delivery" "forcing failure"
21447 .cindex "delivery" "forcing deferral"
21448 .cindex "failing delivery" "forcing"
21449 .cindex "deferred delivery, forcing"
21450 .cindex "customizing" "failure message"
21451 An attempt to deliver a particular address can be deferred or forced to fail by
21452 redirection items of the form
21453 .code
21454 :defer:
21455 :fail:
21456 .endd
21457 respectively. When a redirection list contains such an item, it applies
21458 to the entire redirection; any other items in the list are ignored. Any
21459 text following &':fail:'& or &':defer:'& is placed in the error text
21460 associated with the failure. For example, an alias file might contain:
21461 .code
21462 X.Employee:  :fail: Gone away, no forwarding address
21463 .endd
21464 In the case of an address that is being verified from an ACL or as the subject
21465 of a
21466 .cindex "VRFY" "error text, display of"
21467 VRFY command, the text is included in the SMTP error response by
21468 default.
21469 .cindex "EXPN" "error text, display of"
21470 The text is not included in the response to an EXPN command. In non-SMTP cases
21471 the text is included in the error message that Exim generates.
21472
21473 .cindex "SMTP" "error codes"
21474 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21475 &':fail:'&. However, if the message starts with three digits followed by a
21476 space, optionally followed by an extended code of the form &'n.n.n'&, also
21477 followed by a space, and the very first digit is the same as the default error
21478 code, the code from the message is used instead. If the very first digit is
21479 incorrect, a panic error is logged, and the default code is used. You can
21480 suppress the use of the supplied code in a redirect router by setting the
21481 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21482 ignored.
21483
21484 .vindex "&$acl_verify_message$&"
21485 In an ACL, an explicitly provided message overrides the default, but the
21486 default message is available in the variable &$acl_verify_message$& and can
21487 therefore be included in a custom message if this is desired.
21488
21489 Normally the error text is the rest of the redirection list &-- a comma does
21490 not terminate it &-- but a newline does act as a terminator. Newlines are not
21491 normally present in alias expansions. In &(lsearch)& lookups they are removed
21492 as part of the continuation process, but they may exist in other kinds of
21493 lookup and in &':include:'& files.
21494
21495 During routing for message delivery (as opposed to verification), a redirection
21496 containing &':fail:'& causes an immediate failure of the incoming address,
21497 whereas &':defer:'& causes the message to remain in the queue so that a
21498 subsequent delivery attempt can happen at a later time. If an address is
21499 deferred for too long, it will ultimately fail, because the normal retry
21500 rules still apply.
21501
21502 .next
21503 .cindex "alias file" "exception to default"
21504 Sometimes it is useful to use a single-key search type with a default (see
21505 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21506 for exceptions to the default. These can be handled by aliasing them to
21507 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21508 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21509 results in an empty redirection list has the same effect.
21510 .endlist
21511
21512
21513 .section "Duplicate addresses" "SECTdupaddr"
21514 .cindex "duplicate addresses"
21515 .cindex "address duplicate, discarding"
21516 .cindex "pipe" "duplicated"
21517 Exim removes duplicate addresses from the list to which it is delivering, so as
21518 to deliver just one copy to each address. This does not apply to deliveries
21519 routed to pipes by different immediate parent addresses, but an indirect
21520 aliasing scheme of the type
21521 .code
21522 pipe:       |/some/command $local_part
21523 localpart1: pipe
21524 localpart2: pipe
21525 .endd
21526 does not work with a message that is addressed to both local parts, because
21527 when the second is aliased to the intermediate local part &"pipe"& it gets
21528 discarded as being the same as a previously handled address. However, a scheme
21529 such as
21530 .code
21531 localpart1: |/some/command $local_part
21532 localpart2: |/some/command $local_part
21533 .endd
21534 does result in two different pipe deliveries, because the immediate parents of
21535 the pipes are distinct.
21536
21537
21538
21539 .section "Repeated redirection expansion" "SECID128"
21540 .cindex "repeated redirection expansion"
21541 .cindex "address redirection" "repeated for each delivery attempt"
21542 When a message cannot be delivered to all of its recipients immediately,
21543 leading to two or more delivery attempts, redirection expansion is carried out
21544 afresh each time for those addresses whose children were not all previously
21545 delivered. If redirection is being used as a mailing list, this can lead to new
21546 members of the list receiving copies of old messages. The &%one_time%& option
21547 can be used to avoid this.
21548
21549
21550 .section "Errors in redirection lists" "SECID129"
21551 .cindex "address redirection" "errors"
21552 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21553 error is skipped, and an entry is written to the main log. This may be useful
21554 for mailing lists that are automatically managed. Otherwise, if an error is
21555 detected while generating the list of new addresses, the original address is
21556 deferred. See also &%syntax_errors_to%&.
21557
21558
21559
21560 .section "Private options for the redirect router" "SECID130"
21561
21562 .cindex "options" "&(redirect)& router"
21563 The private options for the &(redirect)& router are as follows:
21564
21565
21566 .option allow_defer redirect boolean false
21567 Setting this option allows the use of &':defer:'& in non-filter redirection
21568 data, or the &%defer%& command in an Exim filter file.
21569
21570
21571 .option allow_fail redirect boolean false
21572 .cindex "failing delivery" "from filter"
21573 If this option is true, the &':fail:'& item can be used in a redirection list,
21574 and the &%fail%& command may be used in an Exim filter file.
21575
21576
21577 .option allow_filter redirect boolean false
21578 .cindex "filter" "enabling use of"
21579 .cindex "Sieve filter" "enabling use of"
21580 Setting this option allows Exim to interpret redirection data that starts with
21581 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21582 are some features of Exim filter files that some administrators may wish to
21583 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21584
21585 It is also possible to lock out Exim filters or Sieve filters while allowing
21586 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21587
21588
21589 The filter is run using the uid and gid set by the generic &%user%& and
21590 &%group%& options. These take their defaults from the password data if
21591 &%check_local_user%& is set, so in the normal case of users' personal filter
21592 files, the filter is run as the relevant user. When &%allow_filter%& is set
21593 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21594
21595
21596
21597 .option allow_freeze redirect boolean false
21598 .cindex "freezing messages" "allowing in filter"
21599 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21600 This command is more normally encountered in system filters, and is disabled by
21601 default for redirection filters because it isn't something you usually want to
21602 let ordinary users do.
21603
21604
21605
21606 .option check_ancestor redirect boolean false
21607 This option is concerned with handling generated addresses that are the same
21608 as some address in the list of redirection ancestors of the current address.
21609 Although it is turned off by default in the code, it is set in the default
21610 configuration file for handling users' &_.forward_& files. It is recommended
21611 for this use of the &(redirect)& router.
21612
21613 When &%check_ancestor%& is set, if a generated address (including the domain)
21614 is the same as any ancestor of the current address, it is replaced by a copy of
21615 the current address. This helps in the case where local part A is aliased to B,
21616 and B has a &_.forward_& file pointing back to A. For example, within a single
21617 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21618 &_&~jb/.forward_& contains:
21619 .code
21620 \Joe.Bloggs, <other item(s)>
21621 .endd
21622 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21623 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21624 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21625 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21626 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21627 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21628 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21629 original address. See also the &%repeat_use%& option below.
21630
21631
21632 .option check_group redirect boolean "see below"
21633 When the &%file%& option is used, the group owner of the file is checked only
21634 when this option is set. The permitted groups are those listed in the
21635 &%owngroups%& option, together with the user's default group if
21636 &%check_local_user%& is set. If the file has the wrong group, routing is
21637 deferred. The default setting for this option is true if &%check_local_user%&
21638 is set and the &%modemask%& option permits the group write bit, or if the
21639 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21640
21641
21642
21643 .option check_owner redirect boolean "see below"
21644 When the &%file%& option is used, the owner of the file is checked only when
21645 this option is set. If &%check_local_user%& is set, the local user is
21646 permitted; otherwise the owner must be one of those listed in the &%owners%&
21647 option. The default value for this option is true if &%check_local_user%& or
21648 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21649
21650
21651 .option data redirect string&!! unset
21652 This option is mutually exclusive with &%file%&. One or other of them must be
21653 set, but not both. The contents of &%data%& are expanded, and then used as the
21654 list of forwarding items, or as a set of filtering instructions. If the
21655 expansion is forced to fail, or the result is an empty string or a string that
21656 has no effect (consists entirely of comments), the router declines.
21657
21658 When filtering instructions are used, the string must begin with &"#Exim
21659 filter"&, and all comments in the string, including this initial one, must be
21660 terminated with newline characters. For example:
21661 .code
21662 data = #Exim filter\n\
21663        if $h_to: contains Exim then save $home/mail/exim endif
21664 .endd
21665 If you are reading the data from a database where newlines cannot be included,
21666 you can use the &${sg}$& expansion item to turn the escape string of your
21667 choice into a newline.
21668
21669
21670 .option directory_transport redirect string&!! unset
21671 A &(redirect)& router sets up a direct delivery to a directory when a path name
21672 ending with a slash is specified as a new &"address"&. The transport used is
21673 specified by this option, which, after expansion, must be the name of a
21674 configured transport. This should normally be an &(appendfile)& transport.
21675
21676
21677 .option file redirect string&!! unset
21678 This option specifies the name of a file that contains the redirection data. It
21679 is mutually exclusive with the &%data%& option. The string is expanded before
21680 use; if the expansion is forced to fail, the router declines. Other expansion
21681 failures cause delivery to be deferred. The result of a successful expansion
21682 must be an absolute path. The entire file is read and used as the redirection
21683 data. If the data is an empty string or a string that has no effect (consists
21684 entirely of comments), the router declines.
21685
21686 .cindex "NFS" "checking for file existence"
21687 If the attempt to open the file fails with a &"does not exist"& error, Exim
21688 runs a check on the containing directory,
21689 unless &%ignore_enotdir%& is true (see below).
21690 If the directory does not appear to exist, delivery is deferred. This can
21691 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21692 is a mount problem. If the containing directory does exist, but the file does
21693 not, the router declines.
21694
21695
21696 .option file_transport redirect string&!! unset
21697 .vindex "&$address_file$&"
21698 A &(redirect)& router sets up a direct delivery to a file when a path name not
21699 ending in a slash is specified as a new &"address"&. The transport used is
21700 specified by this option, which, after expansion, must be the name of a
21701 configured transport. This should normally be an &(appendfile)& transport. When
21702 it is running, the filename is in &$address_file$&.
21703
21704
21705 .option filter_prepend_home redirect boolean true
21706 When this option is true, if a &(save)& command in an Exim filter specifies a
21707 relative path, and &$home$& is defined, it is automatically prepended to the
21708 relative path. If this option is set false, this action does not happen. The
21709 relative path is then passed to the transport unmodified.
21710
21711
21712 .option forbid_blackhole redirect boolean false
21713 .cindex "restricting access to features"
21714 .cindex "filter" "locking out certain features"
21715 If this option is true, the &':blackhole:'& item may not appear in a
21716 redirection list.
21717
21718
21719 .option forbid_exim_filter redirect boolean false
21720 .cindex "restricting access to features"
21721 .cindex "filter" "locking out certain features"
21722 If this option is set true, only Sieve filters are permitted when
21723 &%allow_filter%& is true.
21724
21725
21726
21727
21728 .option forbid_file redirect boolean false
21729 .cindex "restricting access to features"
21730 .cindex "delivery" "to file; forbidding"
21731 .cindex "filter" "locking out certain features"
21732 .cindex "Sieve filter" "forbidding delivery to a file"
21733 .cindex "Sieve filter" "&""keep""& facility; disabling"
21734 If this option is true, this router may not generate a new address that
21735 specifies delivery to a local file or directory, either from a filter or from a
21736 conventional forward file. This option is forced to be true if &%one_time%& is
21737 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21738 locks out the Sieve's &"keep"& facility.
21739
21740
21741 .option forbid_filter_dlfunc redirect boolean false
21742 .cindex "restricting access to features"
21743 .cindex "filter" "locking out certain features"
21744 If this option is true, string expansions in Exim filters are not allowed to
21745 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21746 functions.
21747
21748 .option forbid_filter_existstest redirect boolean false
21749 .cindex "restricting access to features"
21750 .cindex "filter" "locking out certain features"
21751 .cindex "expansion" "statting a file"
21752 If this option is true, string expansions in Exim filters are not allowed to
21753 make use of the &%exists%& condition or the &%stat%& expansion item.
21754
21755 .option forbid_filter_logwrite redirect boolean false
21756 .cindex "restricting access to features"
21757 .cindex "filter" "locking out certain features"
21758 If this option is true, use of the logging facility in Exim filters is not
21759 permitted. Logging is in any case available only if the filter is being run
21760 under some unprivileged uid (which is normally the case for ordinary users'
21761 &_.forward_& files).
21762
21763
21764 .option forbid_filter_lookup redirect boolean false
21765 .cindex "restricting access to features"
21766 .cindex "filter" "locking out certain features"
21767 If this option is true, string expansions in Exim filter files are not allowed
21768 to make use of &%lookup%& items.
21769
21770
21771 .option forbid_filter_perl redirect boolean false
21772 .cindex "restricting access to features"
21773 .cindex "filter" "locking out certain features"
21774 This option has an effect only if Exim is built with embedded Perl support. If
21775 it is true, string expansions in Exim filter files are not allowed to make use
21776 of the embedded Perl support.
21777
21778
21779 .option forbid_filter_readfile redirect boolean false
21780 .cindex "restricting access to features"
21781 .cindex "filter" "locking out certain features"
21782 If this option is true, string expansions in Exim filter files are not allowed
21783 to make use of &%readfile%& items.
21784
21785
21786 .option forbid_filter_readsocket redirect boolean false
21787 .cindex "restricting access to features"
21788 .cindex "filter" "locking out certain features"
21789 If this option is true, string expansions in Exim filter files are not allowed
21790 to make use of &%readsocket%& items.
21791
21792
21793 .option forbid_filter_reply redirect boolean false
21794 .cindex "restricting access to features"
21795 .cindex "filter" "locking out certain features"
21796 If this option is true, this router may not generate an automatic reply
21797 message. Automatic replies can be generated only from Exim or Sieve filter
21798 files, not from traditional forward files. This option is forced to be true if
21799 &%one_time%& is set.
21800
21801
21802 .option forbid_filter_run redirect boolean false
21803 .cindex "restricting access to features"
21804 .cindex "filter" "locking out certain features"
21805 If this option is true, string expansions in Exim filter files are not allowed
21806 to make use of &%run%& items.
21807
21808
21809 .option forbid_include redirect boolean false
21810 .cindex "restricting access to features"
21811 .cindex "filter" "locking out certain features"
21812 If this option is true, items of the form
21813 .code
21814 :include:<path name>
21815 .endd
21816 are not permitted in non-filter redirection lists.
21817
21818
21819 .option forbid_pipe redirect boolean false
21820 .cindex "restricting access to features"
21821 .cindex "filter" "locking out certain features"
21822 .cindex "delivery" "to pipe; forbidding"
21823 If this option is true, this router may not generate a new address which
21824 specifies delivery to a pipe, either from an Exim filter or from a conventional
21825 forward file. This option is forced to be true if &%one_time%& is set.
21826
21827
21828 .option forbid_sieve_filter redirect boolean false
21829 .cindex "restricting access to features"
21830 .cindex "filter" "locking out certain features"
21831 If this option is set true, only Exim filters are permitted when
21832 &%allow_filter%& is true.
21833
21834
21835 .cindex "SMTP" "error codes"
21836 .option forbid_smtp_code redirect boolean false
21837 If this option is set true, any SMTP error codes that are present at the start
21838 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21839 the default codes (451 and 550, respectively) are always used.
21840
21841
21842
21843
21844 .option hide_child_in_errmsg redirect boolean false
21845 .cindex "bounce message" "redirection details; suppressing"
21846 If this option is true, it prevents Exim from quoting a child address if it
21847 generates a bounce or delay message for it. Instead it says &"an address
21848 generated from <&'the top level address'&>"&. Of course, this applies only to
21849 bounces generated locally. If a message is forwarded to another host, &'its'&
21850 bounce may well quote the generated address.
21851
21852
21853 .option ignore_eacces redirect boolean false
21854 .cindex "EACCES"
21855 If this option is set and an attempt to open a redirection file yields the
21856 EACCES error (permission denied), the &(redirect)& router behaves as if the
21857 file did not exist.
21858
21859
21860 .option ignore_enotdir redirect boolean false
21861 .cindex "ENOTDIR"
21862 If this option is set and an attempt to open a redirection file yields the
21863 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21864 router behaves as if the file did not exist.
21865
21866 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21867 router that has the &%file%& option set discovers that the file does not exist
21868 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21869 against unmounted NFS directories. If the parent can not be statted, delivery
21870 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21871 is set, because that option tells Exim to ignore &"something on the path is not
21872 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21873 that some operating systems give ENOENT where others give ENOTDIR.
21874
21875
21876
21877 .option include_directory redirect string unset
21878 If this option is set, the path names of any &':include:'& items in a
21879 redirection list must start with this directory.
21880
21881
21882 .option modemask redirect "octal integer" 022
21883 This specifies mode bits which must not be set for a file specified by the
21884 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21885
21886
21887 .option one_time redirect boolean false
21888 .cindex "one-time aliasing/forwarding expansion"
21889 .cindex "alias file" "one-time expansion"
21890 .cindex "forward file" "one-time expansion"
21891 .cindex "mailing lists" "one-time expansion"
21892 .cindex "address redirection" "one-time expansion"
21893 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21894 files each time it tries to deliver a message causes a problem when one or more
21895 of the generated addresses fails be delivered at the first attempt. The problem
21896 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21897 but of what happens when the redirection list changes during the time that the
21898 message is on Exim's queue. This is particularly true in the case of mailing
21899 lists, where new subscribers might receive copies of messages that were posted
21900 before they subscribed.
21901
21902 If &%one_time%& is set and any addresses generated by the router fail to
21903 deliver at the first attempt, the failing addresses are added to the message as
21904 &"top level"& addresses, and the parent address that generated them is marked
21905 &"delivered"&. Thus, redirection does not happen again at the next delivery
21906 attempt.
21907
21908 &*Warning 1*&: Any header line addition or removal that is specified by this
21909 router would be lost if delivery did not succeed at the first attempt. For this
21910 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21911 permitted when &%one_time%& is set.
21912
21913 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21914 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21915 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21916
21917 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21918 &%one_time%&.
21919
21920 The original top-level address is remembered with each of the generated
21921 addresses, and is output in any log messages. However, any intermediate parent
21922 addresses are not recorded. This makes a difference to the log only if
21923 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21924 typically be used for mailing lists, where there is normally just one level of
21925 expansion.
21926
21927
21928 .option owners redirect "string list" unset
21929 .cindex "ownership" "alias file"
21930 .cindex "ownership" "forward file"
21931 .cindex "alias file" "ownership"
21932 .cindex "forward file" "ownership"
21933 This specifies a list of permitted owners for the file specified by &%file%&.
21934 This list is in addition to the local user when &%check_local_user%& is set.
21935 See &%check_owner%& above.
21936
21937
21938 .option owngroups redirect "string list" unset
21939 This specifies a list of permitted groups for the file specified by &%file%&.
21940 The list is in addition to the local user's primary group when
21941 &%check_local_user%& is set. See &%check_group%& above.
21942
21943
21944 .option pipe_transport redirect string&!! unset
21945 .vindex "&$address_pipe$&"
21946 A &(redirect)& router sets up a direct delivery to a pipe when a string
21947 starting with a vertical bar character is specified as a new &"address"&. The
21948 transport used is specified by this option, which, after expansion, must be the
21949 name of a configured transport. This should normally be a &(pipe)& transport.
21950 When the transport is run, the pipe command is in &$address_pipe$&.
21951
21952
21953 .option qualify_domain redirect string&!! unset
21954 .vindex "&$qualify_recipient$&"
21955 If this option is set, and an unqualified address (one without a domain) is
21956 generated, and that address would normally be qualified by the global setting
21957 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21958 expanding this string. If the expansion fails, the router declines. If you want
21959 to revert to the default, you can have the expansion generate
21960 &$qualify_recipient$&.
21961
21962 This option applies to all unqualified addresses generated by Exim filters,
21963 but for traditional &_.forward_& files, it applies only to addresses that are
21964 not preceded by a backslash. Sieve filters cannot generate unqualified
21965 addresses.
21966
21967 .option qualify_preserve_domain redirect boolean false
21968 .cindex "domain" "in redirection; preserving"
21969 .cindex "preserving domain in redirection"
21970 .cindex "address redirection" "domain; preserving"
21971 If this option is set, the router's local &%qualify_domain%& option must not be
21972 set (a configuration error occurs if it is). If an unqualified address (one
21973 without a domain) is generated, it is qualified with the domain of the parent
21974 address (the immediately preceding ancestor) instead of the global
21975 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21976 this applies whether or not the address is preceded by a backslash.
21977
21978
21979 .option repeat_use redirect boolean true
21980 If this option is set false, the router is skipped for a child address that has
21981 any ancestor that was routed by this router. This test happens before any of
21982 the other preconditions are tested. Exim's default anti-looping rules skip
21983 only when the ancestor is the same as the current address. See also
21984 &%check_ancestor%& above and the generic &%redirect_router%& option.
21985
21986
21987 .option reply_transport redirect string&!! unset
21988 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21989 &%vacation%& command is used in a filter file. The transport used is specified
21990 by this option, which, after expansion, must be the name of a configured
21991 transport. This should normally be an &(autoreply)& transport. Other transports
21992 are unlikely to do anything sensible or useful.
21993
21994
21995 .option rewrite redirect boolean true
21996 .cindex "address redirection" "disabling rewriting"
21997 If this option is set false, addresses generated by the router are not
21998 subject to address rewriting. Otherwise, they are treated like new addresses
21999 and are rewritten according to the global rewriting rules.
22000
22001
22002 .option sieve_subaddress redirect string&!! unset
22003 The value of this option is passed to a Sieve filter to specify the
22004 :subaddress part of an address.
22005
22006 .option sieve_useraddress redirect string&!! unset
22007 The value of this option is passed to a Sieve filter to specify the :user part
22008 of an address. However, if it is unset, the entire original local part
22009 (including any prefix or suffix) is used for :user.
22010
22011
22012 .option sieve_vacation_directory redirect string&!! unset
22013 .cindex "Sieve filter" "vacation directory"
22014 To enable the &"vacation"& extension for Sieve filters, you must set
22015 &%sieve_vacation_directory%& to the directory where vacation databases are held
22016 (do not put anything else in that directory), and ensure that the
22017 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
22018 needs their own directory; Exim will create it if necessary.
22019
22020
22021
22022 .option skip_syntax_errors redirect boolean false
22023 .cindex "forward file" "broken"
22024 .cindex "address redirection" "broken files"
22025 .cindex "alias file" "broken"
22026 .cindex "broken alias or forward files"
22027 .cindex "ignoring faulty addresses"
22028 .cindex "skipping faulty addresses"
22029 .cindex "error" "skipping bad syntax"
22030 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
22031 non-filter redirection data are skipped, and each failing address is logged. If
22032 &%syntax_errors_to%& is set, a message is sent to the address it defines,
22033 giving details of the failures. If &%syntax_errors_text%& is set, its contents
22034 are expanded and placed at the head of the error message generated by
22035 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
22036 be the same address as the generic &%errors_to%& option. The
22037 &%skip_syntax_errors%& option is often used when handling mailing lists.
22038
22039 If all the addresses in a redirection list are skipped because of syntax
22040 errors, the router declines to handle the original address, and it is passed to
22041 the following routers.
22042
22043 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
22044 error in the filter causes filtering to be abandoned without any action being
22045 taken. The incident is logged, and the router declines to handle the address,
22046 so it is passed to the following routers.
22047
22048 .cindex "Sieve filter" "syntax errors in"
22049 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
22050 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
22051 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
22052
22053 &%skip_syntax_errors%& can be used to specify that errors in users' forward
22054 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
22055 option, used with an address that does not get redirected, can be used to
22056 notify users of these errors, by means of a router like this:
22057 .code
22058 userforward:
22059   driver = redirect
22060   allow_filter
22061   check_local_user
22062   file = $home/.forward
22063   file_transport = address_file
22064   pipe_transport = address_pipe
22065   reply_transport = address_reply
22066   no_verify
22067   skip_syntax_errors
22068   syntax_errors_to = real-$local_part@$domain
22069   syntax_errors_text = \
22070    This is an automatically generated message. An error has\n\
22071    been found in your .forward file. Details of the error are\n\
22072    reported below. While this error persists, you will receive\n\
22073    a copy of this message for every message that is addressed\n\
22074    to you. If your .forward file is a filter file, or if it is\n\
22075    a non-filter file containing no valid forwarding addresses,\n\
22076    a copy of each incoming message will be put in your normal\n\
22077    mailbox. If a non-filter file contains at least one valid\n\
22078    forwarding address, forwarding to the valid addresses will\n\
22079    happen, and those will be the only deliveries that occur.
22080 .endd
22081 You also need a router to ensure that local addresses that are prefixed by
22082 &`real-`& are recognized, but not forwarded or filtered. For example, you could
22083 put this immediately before the &(userforward)& router:
22084 .code
22085 real_localuser:
22086   driver = accept
22087   check_local_user
22088   local_part_prefix = real-
22089   transport = local_delivery
22090 .endd
22091 For security, it would probably be a good idea to restrict the use of this
22092 router to locally-generated messages, using a condition such as this:
22093 .code
22094   condition = ${if match {$sender_host_address}\
22095                          {\N^(|127\.0\.0\.1)$\N}}
22096 .endd
22097
22098
22099 .option syntax_errors_text redirect string&!! unset
22100 See &%skip_syntax_errors%& above.
22101
22102
22103 .option syntax_errors_to redirect string unset
22104 See &%skip_syntax_errors%& above.
22105 .ecindex IIDredrou1
22106 .ecindex IIDredrou2
22107
22108
22109
22110
22111
22112
22113 . ////////////////////////////////////////////////////////////////////////////
22114 . ////////////////////////////////////////////////////////////////////////////
22115
22116 .chapter "Environment for running local transports" "CHAPenvironment" &&&
22117          "Environment for local transports"
22118 .scindex IIDenvlotra1 "local transports" "environment for"
22119 .scindex IIDenvlotra2 "environment" "local transports"
22120 .scindex IIDenvlotra3 "transport" "local; environment for"
22121 Local transports handle deliveries to files and pipes. (The &(autoreply)&
22122 transport can be thought of as similar to a pipe.) Exim always runs transports
22123 in subprocesses, under specified uids and gids. Typical deliveries to local
22124 mailboxes run under the uid and gid of the local user.
22125
22126 Exim also sets a specific current directory while running the transport; for
22127 some transports a home directory setting is also relevant. The &(pipe)&
22128 transport is the only one that sets up environment variables; see section
22129 &<<SECTpipeenv>>& for details.
22130
22131 The values used for the uid, gid, and the directories may come from several
22132 different places. In many cases, the router that handles the address associates
22133 settings with that address as a result of its &%check_local_user%&, &%group%&,
22134 or &%user%& options. However, values may also be given in the transport's own
22135 configuration, and these override anything that comes from the router.
22136
22137
22138
22139 .section "Concurrent deliveries" "SECID131"
22140 .cindex "concurrent deliveries"
22141 .cindex "simultaneous deliveries"
22142 If two different messages for the same local recipient arrive more or less
22143 simultaneously, the two delivery processes are likely to run concurrently. When
22144 the &(appendfile)& transport is used to write to a file, Exim applies locking
22145 rules to stop concurrent processes from writing to the same file at the same
22146 time.
22147
22148 However, when you use a &(pipe)& transport, it is up to you to arrange any
22149 locking that is needed. Here is a silly example:
22150 .code
22151 my_transport:
22152   driver = pipe
22153   command = /bin/sh -c 'cat >>/some/file'
22154 .endd
22155 This is supposed to write the message at the end of the file. However, if two
22156 messages arrive at the same time, the file will be scrambled. You can use the
22157 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
22158 file using the same algorithm that Exim itself uses.
22159
22160
22161
22162
22163 .section "Uids and gids" "SECTenvuidgid"
22164 .cindex "local transports" "uid and gid"
22165 .cindex "transport" "local; uid and gid"
22166 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
22167 overrides any group that the router set in the address, even if &%user%& is not
22168 set for the transport. This makes it possible, for example, to run local mail
22169 delivery under the uid of the recipient (set by the router), but in a special
22170 group (set by the transport). For example:
22171 .code
22172 # Routers ...
22173 # User/group are set by check_local_user in this router
22174 local_users:
22175   driver = accept
22176   check_local_user
22177   transport = group_delivery
22178
22179 # Transports ...
22180 # This transport overrides the group
22181 group_delivery:
22182   driver = appendfile
22183   file = /var/spool/mail/$local_part_data
22184   group = mail
22185 .endd
22186 If &%user%& is set for a transport, its value overrides what is set in the
22187 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
22188 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
22189 set.
22190
22191 .oindex "&%initgroups%&"
22192 When the uid is taken from the transport's configuration, the &[initgroups()]&
22193 function is called for the groups associated with that uid if the
22194 &%initgroups%& option is set for the transport. When the uid is not specified
22195 by the transport, but is associated with the address by a router, the option
22196 for calling &[initgroups()]& is taken from the router configuration.
22197
22198 .cindex "&(pipe)& transport" "uid for"
22199 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22200 is set and &%user%& is not set, the uid of the process that called Exim to
22201 receive the message is used, and if &%group%& is not set, the corresponding
22202 original gid is also used.
22203
22204 This is the detailed preference order for obtaining a gid; the first of the
22205 following that is set is used:
22206
22207 .ilist
22208 A &%group%& setting of the transport;
22209 .next
22210 A &%group%& setting of the router;
22211 .next
22212 A gid associated with a user setting of the router, either as a result of
22213 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22214 .next
22215 The group associated with a non-numeric &%user%& setting of the transport;
22216 .next
22217 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22218 the uid is the creator's uid;
22219 .next
22220 The Exim gid if the Exim uid is being used as a default.
22221 .endlist
22222
22223 If, for example, the user is specified numerically on the router and there are
22224 no group settings, no gid is available. In this situation, an error occurs.
22225 This is different for the uid, for which there always is an ultimate default.
22226 The first of the following that is set is used:
22227
22228 .ilist
22229 A &%user%& setting of the transport;
22230 .next
22231 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22232 .next
22233 A &%user%& setting of the router;
22234 .next
22235 A &%check_local_user%& setting of the router;
22236 .next
22237 The Exim uid.
22238 .endlist
22239
22240 Of course, an error will still occur if the uid that is chosen is on the
22241 &%never_users%& list.
22242
22243
22244
22245
22246
22247 .section "Current and home directories" "SECID132"
22248 .cindex "current directory for local transport"
22249 .cindex "home directory" "for local transport"
22250 .cindex "transport" "local; home directory for"
22251 .cindex "transport" "local; current directory for"
22252 Routers may set current and home directories for local transports by means of
22253 the &%transport_current_directory%& and &%transport_home_directory%& options.
22254 However, if the transport's &%current_directory%& or &%home_directory%& options
22255 are set, they override the router's values. In detail, the home directory
22256 for a local transport is taken from the first of these values that is set:
22257
22258 .ilist
22259 The &%home_directory%& option on the transport;
22260 .next
22261 The &%transport_home_directory%& option on the router;
22262 .next
22263 The password data if &%check_local_user%& is set on the router;
22264 .next
22265 The &%router_home_directory%& option on the router.
22266 .endlist
22267
22268 The current directory is taken from the first of these values that is set:
22269
22270 .ilist
22271 The &%current_directory%& option on the transport;
22272 .next
22273 The &%transport_current_directory%& option on the router.
22274 .endlist
22275
22276
22277 If neither the router nor the transport sets a current directory, Exim uses the
22278 value of the home directory, if it is set. Otherwise it sets the current
22279 directory to &_/_& before running a local transport.
22280
22281
22282
22283 .section "Expansion variables derived from the address" "SECID133"
22284 .vindex "&$domain$&"
22285 .vindex "&$local_part$&"
22286 .vindex "&$original_domain$&"
22287 Normally a local delivery is handling a single address, and in that case the
22288 variables such as &$domain$& and &$local_part$& are set during local
22289 deliveries. However, in some circumstances more than one address may be handled
22290 at once (for example, while writing batch SMTP for onward transmission by some
22291 other means). In this case, the variables associated with the local part are
22292 never set, &$domain$& is set only if all the addresses have the same domain,
22293 and &$original_domain$& is never set.
22294 .ecindex IIDenvlotra1
22295 .ecindex IIDenvlotra2
22296 .ecindex IIDenvlotra3
22297
22298
22299
22300
22301
22302
22303
22304 . ////////////////////////////////////////////////////////////////////////////
22305 . ////////////////////////////////////////////////////////////////////////////
22306
22307 .chapter "Generic options for transports" "CHAPtransportgeneric"
22308 .scindex IIDgenoptra1 "generic options" "transport"
22309 .scindex IIDgenoptra2 "options" "generic; for transports"
22310 .scindex IIDgenoptra3 "transport" "generic options for"
22311 The following generic options apply to all transports:
22312
22313
22314 .option body_only transports boolean false
22315 .cindex "transport" "body only"
22316 .cindex "message" "transporting body only"
22317 .cindex "body of message" "transporting"
22318 If this option is set, the message's headers are not transported. It is
22319 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22320 or &(pipe)& transports, the settings of &%message_prefix%& and
22321 &%message_suffix%& should be checked, because this option does not
22322 automatically suppress them.
22323
22324
22325 .option current_directory transports string&!! unset
22326 .cindex "transport" "current directory for"
22327 This specifies the current directory that is to be set while running the
22328 transport, overriding any value that may have been set by the router.
22329 If the expansion fails for any reason, including forced failure, an error is
22330 logged, and delivery is deferred.
22331
22332
22333 .option disable_logging transports boolean false
22334 If this option is set true, nothing is logged for any
22335 deliveries by the transport or for any
22336 transport errors. You should not set this option unless you really, really know
22337 what you are doing.
22338
22339
22340 .option debug_print transports string&!! unset
22341 .cindex "testing" "variables in drivers"
22342 If this option is set and debugging is enabled (see the &%-d%& command line
22343 option), the string is expanded and included in the debugging output when the
22344 transport is run.
22345 If expansion of the string fails, the error message is written to the debugging
22346 output, and Exim carries on processing.
22347 This facility is provided to help with checking out the values of variables and
22348 so on when debugging driver configurations. For example, if a &%headers_add%&
22349 option is not working properly, &%debug_print%& could be used to output the
22350 variables it references. A newline is added to the text if it does not end with
22351 one.
22352 The variables &$transport_name$& and &$router_name$& contain the name of the
22353 transport and the router that called it.
22354
22355 .option delivery_date_add transports boolean false
22356 .cindex "&'Delivery-date:'& header line"
22357 If this option is true, a &'Delivery-date:'& header is added to the message.
22358 This gives the actual time the delivery was made. As this is not a standard
22359 header, Exim has a configuration option (&%delivery_date_remove%&) which
22360 requests its removal from incoming messages, so that delivered messages can
22361 safely be resent to other recipients.
22362
22363
22364 .option driver transports string unset
22365 This specifies which of the available transport drivers is to be used.
22366 There is no default, and this option must be set for every transport.
22367
22368
22369 .option envelope_to_add transports boolean false
22370 .cindex "&'Envelope-to:'& header line"
22371 If this option is true, an &'Envelope-to:'& header is added to the message.
22372 This gives the original address(es) in the incoming envelope that caused this
22373 delivery to happen. More than one address may be present if the transport is
22374 configured to handle several addresses at once, or if more than one original
22375 address was redirected to the same final address. As this is not a standard
22376 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22377 its removal from incoming messages, so that delivered messages can safely be
22378 resent to other recipients.
22379
22380
22381 .option event_action transports string&!! unset
22382 .cindex events
22383 This option declares a string to be expanded for Exim's events mechanism.
22384 For details see chapter &<<CHAPevents>>&.
22385
22386
22387 .option group transports string&!! "Exim group"
22388 .cindex "transport" "group; specifying"
22389 This option specifies a gid for running the transport process, overriding any
22390 value that the router supplies, and also overriding any value associated with
22391 &%user%& (see below).
22392
22393
22394 .option headers_add transports list&!! unset
22395 .cindex "header lines" "adding in transport"
22396 .cindex "transport" "header lines; adding"
22397 This option specifies a list of text headers,
22398 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22399 which are (separately) expanded and added to the header
22400 portion of a message as it is transported, as described in section
22401 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22402 routers. If the result of the expansion is an empty string, or if the expansion
22403 is forced to fail, no action is taken. Other expansion failures are treated as
22404 errors and cause the delivery to be deferred.
22405
22406 Unlike most options, &%headers_add%& can be specified multiple times
22407 for a transport; all listed headers are added.
22408
22409
22410 .option headers_only transports boolean false
22411 .cindex "transport" "header lines only"
22412 .cindex "message" "transporting headers only"
22413 .cindex "header lines" "transporting"
22414 If this option is set, the message's body is not transported. It is mutually
22415 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22416 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22417 checked, since this option does not automatically suppress them.
22418
22419
22420 .option headers_remove transports list&!! unset
22421 .cindex "header lines" "removing"
22422 .cindex "transport" "header lines; removing"
22423 This option specifies a list of text headers,
22424 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22425 to be removed from the message.
22426 However, the option has no effect when an address is just being verified.
22427 Each list item is separately expanded.
22428 If the result of the expansion is an empty string, or if the expansion
22429 is forced to fail, no action is taken. Other expansion failures are treated as
22430 errors and cause the delivery to be deferred.
22431 If an item ends in *, it will match any header with the given prefix.
22432
22433 Matching headers are omitted from the message as it is transported, as described
22434 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22435 routers.
22436
22437 Unlike most options, &%headers_remove%& can be specified multiple times
22438 for a transport; all listed headers are removed.
22439
22440 &*Warning*&: Because of the separate expansion of the list items,
22441 items that contain a list separator must have it doubled.
22442 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22443
22444
22445
22446 .option headers_rewrite transports string unset
22447 .cindex "transport" "header lines; rewriting"
22448 .cindex "rewriting" "at transport time"
22449 This option allows addresses in header lines to be rewritten at transport time,
22450 that is, as the message is being copied to its destination. The contents of the
22451 option are a colon-separated list of rewriting rules. Each rule is in exactly
22452 the same form as one of the general rewriting rules that are applied when a
22453 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22454 example,
22455 .code
22456 headers_rewrite = a@b c@d f : \
22457                   x@y w@z
22458 .endd
22459 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22460 &'w@z'& in all address-bearing header lines. The rules are applied to the
22461 header lines just before they are written out at transport time, so they affect
22462 only those copies of the message that pass through the transport. However, only
22463 the message's original header lines, and any that were added by a system
22464 filter, are rewritten. If a router or transport adds header lines, they are not
22465 affected by this option. These rewriting rules are &'not'& applied to the
22466 envelope. You can change the return path using &%return_path%&, but you cannot
22467 change envelope recipients at this time.
22468
22469
22470 .option home_directory transports string&!! unset
22471 .cindex "transport" "home directory for"
22472 .vindex "&$home$&"
22473 This option specifies a home directory setting for a local transport,
22474 overriding any value that may be set by the router. The home directory is
22475 placed in &$home$& while expanding the transport's private options. It is also
22476 used as the current directory if no current directory is set by the
22477 &%current_directory%& option on the transport or the
22478 &%transport_current_directory%& option on the router. If the expansion fails
22479 for any reason, including forced failure, an error is logged, and delivery is
22480 deferred.
22481
22482
22483 .option initgroups transports boolean false
22484 .cindex "additional groups"
22485 .cindex "groups" "additional"
22486 .cindex "transport" "group; additional"
22487 If this option is true and the uid for the delivery process is provided by the
22488 transport, the &[initgroups()]& function is called when running the transport
22489 to ensure that any additional groups associated with the uid are set up.
22490
22491
22492 .option max_parallel transports integer&!! unset
22493 .cindex limit "transport parallelism"
22494 .cindex transport "parallel processes"
22495 .cindex transport "concurrency limit"
22496 .cindex "delivery" "parallelism for transport"
22497 If this option is set and expands to an integer greater than zero
22498 it limits the number of concurrent runs of the transport.
22499 The control does not apply to shadow transports.
22500
22501 .cindex "hints database" "transport concurrency control"
22502 Exim implements this control by means of a hints database in which a record is
22503 incremented whenever a transport process is being created. The record
22504 is decremented and possibly removed when the process terminates.
22505 Obviously there is scope for
22506 records to get left lying around if there is a system or program crash. To
22507 guard against this, Exim ignores any records that are more than six hours old.
22508
22509 If you use this option, you should also arrange to delete the
22510 relevant hints database whenever your system reboots. The names of the files
22511 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22512 may be one or two files, depending on the type of DBM in use. The same files
22513 are used for ETRN and smtp transport serialization.
22514
22515
22516 .option message_size_limit transports string&!! 0
22517 .cindex "limit" "message size per transport"
22518 .cindex "size" "of message, limit"
22519 .cindex "transport" "message size; limiting"
22520 This option controls the size of messages passed through the transport. It is
22521 expanded before use; the result of the expansion must be a sequence of decimal
22522 digits, optionally followed by K or M. If the expansion fails for any reason,
22523 including forced failure, or if the result is not of the required form,
22524 delivery is deferred. If the value is greater than zero and the size of a
22525 message exceeds this limit, the address is failed. If there is any chance that
22526 the resulting bounce message could be routed to the same transport, you should
22527 ensure that &%return_size_limit%& is less than the transport's
22528 &%message_size_limit%&, as otherwise the bounce message will fail to get
22529 delivered.
22530
22531
22532
22533 .option rcpt_include_affixes transports boolean false
22534 .cindex "prefix" "for local part, including in envelope"
22535 .cindex "suffix for local part" "including in envelope"
22536 .cindex "local part" "prefix"
22537 .cindex "local part" "suffix"
22538 When this option is false (the default), and an address that has had any
22539 affixes (prefixes or suffixes) removed from the local part is delivered by any
22540 form of SMTP or LMTP, the affixes are not included. For example, if a router
22541 that contains
22542 .code
22543 local_part_prefix = *-
22544 .endd
22545 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22546 is delivered with
22547 .code
22548 RCPT TO:<xyz@some.domain>
22549 .endd
22550 This is also the case when an ACL-time callout is being used to verify a
22551 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22552 whole local part is included in the RCPT command. This option applies to BSMTP
22553 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22554 &(lmtp)& and &(smtp)& transports.
22555
22556
22557 .option retry_use_local_part transports boolean "see below"
22558 .cindex "hints database" "retry keys"
22559 When a delivery suffers a temporary failure, a retry record is created
22560 in Exim's hints database. For remote deliveries, the key for the retry record
22561 is based on the name and/or IP address of the failing remote host. For local
22562 deliveries, the key is normally the entire address, including both the local
22563 part and the domain. This is suitable for most common cases of local delivery
22564 temporary failure &-- for example, exceeding a mailbox quota should delay only
22565 deliveries to that mailbox, not to the whole domain.
22566
22567 However, in some special cases you may want to treat a temporary local delivery
22568 as a failure associated with the domain, and not with a particular local part.
22569 (For example, if you are storing all mail for some domain in files.) You can do
22570 this by setting &%retry_use_local_part%& false.
22571
22572 For all the local transports, its default value is true. For remote transports,
22573 the default value is false for tidiness, but changing the value has no effect
22574 on a remote transport in the current implementation.
22575
22576
22577 .option return_path transports string&!! unset
22578 .cindex "envelope sender"
22579 .cindex "envelope from"
22580 .cindex "transport" "return path; changing"
22581 .cindex "return path" "changing in transport"
22582 If this option is set, the string is expanded at transport time and replaces
22583 the existing return path (envelope sender) value in the copy of the message
22584 that is being delivered. An empty return path is permitted. This feature is
22585 designed for remote deliveries, where the value of this option is used in the
22586 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22587 only effect is to change the address that is placed in the &'Return-path:'&
22588 header line, if one is added to the message (see the next option).
22589
22590 &*Note:*& A changed return path is not logged unless you add
22591 &%return_path_on_delivery%& to the log selector.
22592
22593 .vindex "&$return_path$&"
22594 The expansion can refer to the existing value via &$return_path$&. This is
22595 either the message's envelope sender, or an address set by the
22596 &%errors_to%& option on a router. If the expansion is forced to fail, no
22597 replacement occurs; if it fails for another reason, delivery is deferred. This
22598 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22599 section &<<SECTverp>>&.
22600
22601 &*Note*&: If a delivery error is detected locally, including the case when a
22602 remote server rejects a message at SMTP time, the bounce message is not sent to
22603 the value of this option. It is sent to the previously set errors address.
22604 This defaults to the incoming sender address, but can be changed by setting
22605 &%errors_to%& in a router.
22606
22607
22608
22609 .option return_path_add transports boolean false
22610 .chindex Return-path:
22611 If this option is true, a &'Return-path:'& header is added to the message.
22612 Although the return path is normally available in the prefix line of BSD
22613 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22614 have easy access to it.
22615
22616 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22617 the delivery SMTP server makes the final delivery"&. This implies that this
22618 header should not be present in incoming messages. Exim has a configuration
22619 option, &%return_path_remove%&, which requests removal of this header from
22620 incoming messages, so that delivered messages can safely be resent to other
22621 recipients.
22622
22623
22624 .option shadow_condition transports string&!! unset
22625 See &%shadow_transport%& below.
22626
22627
22628 .option shadow_transport transports string unset
22629 .cindex "shadow transport"
22630 .cindex "transport" "shadow"
22631 A local transport may set the &%shadow_transport%& option to the name of
22632 another local transport. Shadow remote transports are not supported.
22633
22634 Whenever a delivery to the main transport succeeds, and either
22635 &%shadow_condition%& is unset, or its expansion does not result in the empty
22636 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22637 passed to the shadow transport, with the same delivery address or addresses. If
22638 expansion fails, no action is taken except that non-forced expansion failures
22639 cause a log line to be written.
22640
22641 The result of the shadow transport is discarded and does not affect the
22642 subsequent processing of the message. Only a single level of shadowing is
22643 provided; the &%shadow_transport%& option is ignored on any transport when it
22644 is running as a shadow. Options concerned with output from pipes are also
22645 ignored. The log line for the successful delivery has an item added on the end,
22646 of the form
22647 .code
22648 ST=<shadow transport name>
22649 .endd
22650 If the shadow transport did not succeed, the error message is put in
22651 parentheses afterwards. Shadow transports can be used for a number of different
22652 purposes, including keeping more detailed log information than Exim normally
22653 provides, and implementing automatic acknowledgment policies based on message
22654 headers that some sites insist on.
22655
22656
22657 .option transport_filter transports string&!! unset
22658 .cindex "transport" "filter"
22659 .cindex "filter" "transport filter"
22660 This option sets up a filtering (in the Unix shell sense) process for messages
22661 at transport time. It should not be confused with mail filtering as set up by
22662 individual users or via a system filter.
22663 If unset, or expanding to an empty string, no filtering is done.
22664
22665 When the message is about to be written out, the command specified by
22666 &%transport_filter%& is started up in a separate, parallel process, and
22667 the entire message, including the header lines, is passed to it on its standard
22668 input (this in fact is done from a third process, to avoid deadlock). The
22669 command must be specified as an absolute path.
22670
22671 The lines of the message that are written to the transport filter are
22672 terminated by newline (&"\n"&). The message is passed to the filter before any
22673 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22674 lines beginning with a dot, and also before any processing implied by the
22675 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22676 &(pipe)& transports.
22677
22678 The standard error for the filter process is set to the same destination as its
22679 standard output; this is read and written to the message's ultimate
22680 destination. The process that writes the message to the filter, the
22681 filter itself, and the original process that reads the result and delivers it
22682 are all run in parallel, like a shell pipeline.
22683
22684 The filter can perform any transformations it likes, but of course should take
22685 care not to break RFC 2822 syntax. Exim does not check the result, except to
22686 test for a final newline when SMTP is in use. All messages transmitted over
22687 SMTP must end with a newline, so Exim supplies one if it is missing.
22688
22689 .cindex "content scanning" "per user"
22690 A transport filter can be used to provide content-scanning on a per-user basis
22691 at delivery time if the only required effect of the scan is to modify the
22692 message. For example, a content scan could insert a new header line containing
22693 a spam score. This could be interpreted by a filter in the user's MUA. It is
22694 not possible to discard a message at this stage.
22695
22696 .cindex "SIZE" "ESMTP extension"
22697 A problem might arise if the filter increases the size of a message that is
22698 being sent down an SMTP connection. If the receiving SMTP server has indicated
22699 support for the SIZE parameter, Exim will have sent the size of the message
22700 at the start of the SMTP session. If what is actually sent is substantially
22701 more, the server might reject the message. This can be worked round by setting
22702 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22703 additions to the message, or to disable the use of SIZE altogether.
22704
22705 .vindex "&$pipe_addresses$&"
22706 The value of the &%transport_filter%& option is the command string for starting
22707 the filter, which is run directly from Exim, not under a shell. The string is
22708 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22709 Exim breaks it up into arguments and then expands each argument separately (see
22710 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22711 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22712 of arguments, one for each address that applies to this delivery. (This isn't
22713 an ideal name for this feature here, but as it was already implemented for the
22714 &(pipe)& transport, it seemed sensible not to change it.)
22715
22716 .vindex "&$host$&"
22717 .vindex "&$host_address$&"
22718 The expansion variables &$host$& and &$host_address$& are available when the
22719 transport is a remote one. They contain the name and IP address of the host to
22720 which the message is being sent. For example:
22721 .code
22722 transport_filter = /some/directory/transport-filter.pl \
22723   $host $host_address $sender_address $pipe_addresses
22724 .endd
22725
22726 Two problems arise if you want to use more complicated expansion items to
22727 generate transport filter commands, both of which due to the fact that the
22728 command is split up &'before'& expansion.
22729 .ilist
22730 If an expansion item contains white space, you must quote it, so that it is all
22731 part of the same command item. If the entire option setting is one such
22732 expansion item, you have to take care what kind of quoting you use. For
22733 example:
22734 .code
22735 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22736 .endd
22737 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22738 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22739 stripped by Exim when it read the option's value. When the value is used, if
22740 the single quotes were missing, the line would be split into two items,
22741 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22742 Exim tried to expand the first one.
22743 .next
22744 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22745 expansion cannot generate multiple arguments, or a command name followed by
22746 arguments. Consider this example:
22747 .code
22748 transport_filter = ${lookup{$host}lsearch{/a/file}\
22749                     {$value}{/bin/cat}}
22750 .endd
22751 The result of the lookup is interpreted as the name of the command, even
22752 if it contains white space. The simplest way round this is to use a shell:
22753 .code
22754 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22755                                {$value}{/bin/cat}}
22756 .endd
22757 .endlist
22758
22759 The filter process is run under the same uid and gid as the normal delivery.
22760 For remote deliveries this is the Exim uid/gid by default. The command should
22761 normally yield a zero return code. Transport filters are not supposed to fail.
22762 A non-zero code is taken to mean that the transport filter encountered some
22763 serious problem. Delivery of the message is deferred; the message remains on
22764 the queue and is tried again later. It is not possible to cause a message to be
22765 bounced from a transport filter.
22766
22767 If a transport filter is set on an autoreply transport, the original message is
22768 passed through the filter as it is being copied into the newly generated
22769 message, which happens if the &%return_message%& option is set.
22770
22771
22772 .option transport_filter_timeout transports time 5m
22773 .cindex "transport" "filter, timeout"
22774 When Exim is reading the output of a transport filter, it applies a timeout
22775 that can be set by this option. Exceeding the timeout is normally treated as a
22776 temporary delivery failure. However, if a transport filter is used with a
22777 &(pipe)& transport, a timeout in the transport filter is treated in the same
22778 way as a timeout in the pipe command itself. By default, a timeout is a hard
22779 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22780 becomes a temporary error.
22781
22782
22783 .option user transports string&!! "Exim user"
22784 .cindex "uid (user id)" "local delivery"
22785 .cindex "transport" "user, specifying"
22786 This option specifies the user under whose uid the delivery process is to be
22787 run, overriding any uid that may have been set by the router. If the user is
22788 given as a name, the uid is looked up from the password data, and the
22789 associated group is taken as the value of the gid to be used if the &%group%&
22790 option is not set.
22791
22792 For deliveries that use local transports, a user and group are normally
22793 specified explicitly or implicitly (for example, as a result of
22794 &%check_local_user%&) by the router or transport.
22795
22796 .cindex "hints database" "access by remote transport"
22797 For remote transports, you should leave this option unset unless you really are
22798 sure you know what you are doing. When a remote transport is running, it needs
22799 to be able to access Exim's hints databases, because each host may have its own
22800 retry data.
22801 .ecindex IIDgenoptra1
22802 .ecindex IIDgenoptra2
22803 .ecindex IIDgenoptra3
22804
22805
22806
22807
22808
22809
22810 . ////////////////////////////////////////////////////////////////////////////
22811 . ////////////////////////////////////////////////////////////////////////////
22812
22813 .chapter "Address batching in local transports" "CHAPbatching" &&&
22814          "Address batching"
22815 .cindex "transport" "local; address batching in"
22816 The only remote transport (&(smtp)&) is normally configured to handle more than
22817 one address at a time, so that when several addresses are routed to the same
22818 remote host, just one copy of the message is sent. Local transports, however,
22819 normally handle one address at a time. That is, a separate instance of the
22820 transport is run for each address that is routed to the transport. A separate
22821 copy of the message is delivered each time.
22822
22823 .cindex "batched local delivery"
22824 .oindex "&%batch_max%&"
22825 .oindex "&%batch_id%&"
22826 In special cases, it may be desirable to handle several addresses at once in a
22827 local transport, for example:
22828
22829 .ilist
22830 In an &(appendfile)& transport, when storing messages in files for later
22831 delivery by some other means, a single copy of the message with multiple
22832 recipients saves space.
22833 .next
22834 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22835 a single copy saves time, and is the normal way LMTP is expected to work.
22836 .next
22837 In a &(pipe)& transport, when passing the message
22838 to a scanner program or
22839 to some other delivery mechanism such as UUCP, multiple recipients may be
22840 acceptable.
22841 .endlist
22842
22843 These three local transports all have the same options for controlling multiple
22844 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22845 repeating the information for each transport, these options are described here.
22846
22847 The &%batch_max%& option specifies the maximum number of addresses that can be
22848 delivered together in a single run of the transport. Its default value is one
22849 (no batching). When more than one address is routed to a transport that has a
22850 &%batch_max%& value greater than one, the addresses are delivered in a batch
22851 (that is, in a single run of the transport with multiple recipients), subject
22852 to certain conditions:
22853
22854 .ilist
22855 .vindex "&$local_part$&"
22856 If any of the transport's options contain a reference to &$local_part$&, no
22857 batching is possible.
22858 .next
22859 .vindex "&$domain$&"
22860 If any of the transport's options contain a reference to &$domain$&, only
22861 addresses with the same domain are batched.
22862 .next
22863 .cindex "customizing" "batching condition"
22864 If &%batch_id%& is set, it is expanded for each address, and only those
22865 addresses with the same expanded value are batched. This allows you to specify
22866 customized batching conditions. Failure of the expansion for any reason,
22867 including forced failure, disables batching, but it does not stop the delivery
22868 from taking place.
22869 .next
22870 Batched addresses must also have the same errors address (where to send
22871 delivery errors), the same header additions and removals, the same user and
22872 group for the transport, and if a host list is present, the first host must
22873 be the same.
22874 .endlist
22875
22876 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22877 both when the file or pipe command is specified in the transport, and when it
22878 is specified by a &(redirect)& router, but all the batched addresses must of
22879 course be routed to the same file or pipe command. These two transports have an
22880 option called &%use_bsmtp%&, which causes them to deliver the message in
22881 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22882 &%check_string%& and &%escape_string%& options are forced to the values
22883 .code
22884 check_string = "."
22885 escape_string = ".."
22886 .endd
22887 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22888 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22889 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22890
22891 .cindex "&'Envelope-to:'& header line"
22892 If the generic &%envelope_to_add%& option is set for a batching transport, the
22893 &'Envelope-to:'& header that is added to the message contains all the addresses
22894 that are being processed together. If you are using a batching &(appendfile)&
22895 transport without &%use_bsmtp%&, the only way to preserve the recipient
22896 addresses is to set the &%envelope_to_add%& option.
22897
22898 .cindex "&(pipe)& transport" "with multiple addresses"
22899 .vindex "&$pipe_addresses$&"
22900 If you are using a &(pipe)& transport without BSMTP, and setting the
22901 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22902 the command. This is not a true variable; it is a bit of magic that causes each
22903 of the recipient addresses to be inserted into the command as a separate
22904 argument. This provides a way of accessing all the addresses that are being
22905 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22906 are specified by a &(redirect)& router.
22907
22908
22909
22910
22911 . ////////////////////////////////////////////////////////////////////////////
22912 . ////////////////////////////////////////////////////////////////////////////
22913
22914 .chapter "The appendfile transport" "CHAPappendfile"
22915 .scindex IIDapptra1 "&(appendfile)& transport"
22916 .scindex IIDapptra2 "transports" "&(appendfile)&"
22917 .cindex "directory creation"
22918 .cindex "creating directories"
22919 The &(appendfile)& transport delivers a message by appending it to an existing
22920 file, or by creating an entirely new file in a specified directory. Single
22921 files to which messages are appended can be in the traditional Unix mailbox
22922 format, or optionally in the MBX format supported by the Pine MUA and
22923 University of Washington IMAP daemon, &'inter alia'&. When each message is
22924 being delivered as a separate file, &"maildir"& format can optionally be used
22925 to give added protection against failures that happen part-way through the
22926 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22927 supported. For all file formats, Exim attempts to create as many levels of
22928 directory as necessary, provided that &%create_directory%& is set.
22929
22930 The code for the optional formats is not included in the Exim binary by
22931 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22932 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22933 included.
22934
22935 .cindex "quota" "system"
22936 Exim recognizes system quota errors, and generates an appropriate message. Exim
22937 also supports its own quota control within the transport, for use when the
22938 system facility is unavailable or cannot be used for some reason.
22939
22940 If there is an error while appending to a file (for example, quota exceeded or
22941 partition filled), Exim attempts to reset the file's length and last
22942 modification time back to what they were before. If there is an error while
22943 creating an entirely new file, the new file is removed.
22944
22945 Before appending to a file, a number of security checks are made, and the
22946 file is locked. A detailed description is given below, after the list of
22947 private options.
22948
22949 The &(appendfile)& transport is most commonly used for local deliveries to
22950 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22951 putting messages into files for remote delivery by some means other than Exim.
22952 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22953 option).
22954
22955
22956
22957 .section "The file and directory options" "SECTfildiropt"
22958 The &%file%& option specifies a single file, to which the message is appended;
22959 the &%directory%& option specifies a directory, in which a new file containing
22960 the message is created. Only one of these two options can be set, and for
22961 normal deliveries to mailboxes, one of them &'must'& be set.
22962
22963 .vindex "&$address_file$&"
22964 .vindex "&$local_part$&"
22965 However, &(appendfile)& is also used for delivering messages to files or
22966 directories whose names (or parts of names) are obtained from alias,
22967 forwarding, or filtering operations (for example, a &%save%& command in a
22968 user's Exim filter). When such a transport is running, &$local_part$& contains
22969 the local part that was aliased or forwarded, and &$address_file$& contains the
22970 name (or partial name) of the file or directory generated by the redirection
22971 operation. There are two cases:
22972
22973 .ilist
22974 If neither &%file%& nor &%directory%& is set, the redirection operation
22975 must specify an absolute path (one that begins with &`/`&). This is the most
22976 common case when users with local accounts use filtering to sort mail into
22977 different folders. See for example, the &(address_file)& transport in the
22978 default configuration. If the path ends with a slash, it is assumed to be the
22979 name of a directory. A delivery to a directory can also be forced by setting
22980 &%maildir_format%& or &%mailstore_format%&.
22981 .next
22982 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22983 used to determine the file or directory name for the delivery. Normally, the
22984 contents of &$address_file$& are used in some way in the string expansion.
22985 .endlist
22986 .cindex "tainted data" "in filenames"
22987 .cindex appendfile "tainted data"
22988 Tainted data may not be used for a file or directory name.
22989 This means that, for instance, &$local_part$& cannot be used directly
22990 as a component of a path.  It can however be used as the key for a lookup
22991 which returns a path (or component).
22992
22993
22994 .cindex "Sieve filter" "configuring &(appendfile)&"
22995 .cindex "Sieve filter" "relative mailbox path handling"
22996 As an example of the second case, consider an environment where users do not
22997 have home directories. They may be permitted to use Exim filter commands of the
22998 form:
22999 .code
23000 save folder23
23001 .endd
23002 or Sieve filter commands of the form:
23003 .code
23004 require "fileinto";
23005 fileinto "folder23";
23006 .endd
23007 In this situation, the expansion of &%file%& or &%directory%& in the transport
23008 must transform the relative path into an appropriate absolute filename. In the
23009 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
23010 is used as a result of a &"keep"& action in the filter. This example shows one
23011 way of handling this requirement:
23012 .code
23013 file = ${if eq{$address_file}{inbox} \
23014             {/var/mail/$local_part_data} \
23015             {${if eq{${substr_0_1:$address_file}}{/} \
23016                   {$address_file} \
23017                   {$home/mail/$address_file} \
23018             }} \
23019        }
23020 .endd
23021 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
23022 location, absolute paths are used without change, and other folders are in the
23023 &_mail_& directory within the home directory.
23024
23025 &*Note 1*&: While processing an Exim filter, a relative path such as
23026 &_folder23_& is turned into an absolute path if a home directory is known to
23027 the router. In particular, this is the case if &%check_local_user%& is set. If
23028 you want to prevent this happening at routing time, you can set
23029 &%router_home_directory%& empty. This forces the router to pass the relative
23030 path to the transport.
23031
23032 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
23033 the &%file%& or &%directory%& option is still used if it is set.
23034
23035
23036
23037
23038 .section "Private options for appendfile" "SECID134"
23039 .cindex "options" "&(appendfile)& transport"
23040
23041
23042
23043 .option allow_fifo appendfile boolean false
23044 .cindex "fifo (named pipe)"
23045 .cindex "named pipe (fifo)"
23046 .cindex "pipe" "named (fifo)"
23047 Setting this option permits delivery to named pipes (FIFOs) as well as to
23048 regular files. If no process is reading the named pipe at delivery time, the
23049 delivery is deferred.
23050
23051
23052 .option allow_symlink appendfile boolean false
23053 .cindex "symbolic link" "to mailbox"
23054 .cindex "mailbox" "symbolic link"
23055 By default, &(appendfile)& will not deliver if the path name for the file is
23056 that of a symbolic link. Setting this option relaxes that constraint, but there
23057 are security issues involved in the use of symbolic links. Be sure you know
23058 what you are doing if you set this. Details of exactly what this option affects
23059 are included in the discussion which follows this list of options.
23060
23061
23062 .option batch_id appendfile string&!! unset
23063 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23064 However, batching is automatically disabled for &(appendfile)& deliveries that
23065 happen as a result of forwarding or aliasing or other redirection directly to a
23066 file.
23067
23068
23069 .option batch_max appendfile integer 1
23070 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23071
23072
23073 .option check_group appendfile boolean false
23074 When this option is set, the group owner of the file defined by the &%file%&
23075 option is checked to see that it is the same as the group under which the
23076 delivery process is running. The default setting is false because the default
23077 file mode is 0600, which means that the group is irrelevant.
23078
23079
23080 .option check_owner appendfile boolean true
23081 When this option is set, the owner of the file defined by the &%file%& option
23082 is checked to ensure that it is the same as the user under which the delivery
23083 process is running.
23084
23085
23086 .option check_string appendfile string "see below"
23087 .cindex "&""From""& line"
23088 As &(appendfile)& writes the message, the start of each line is tested for
23089 matching &%check_string%&, and if it does, the initial matching characters are
23090 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
23091 a literal string, not a regular expression, and the case of any letters it
23092 contains is significant.
23093
23094 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
23095 are forced to &"."& and &".."& respectively, and any settings in the
23096 configuration are ignored. Otherwise, they default to &"From&~"& and
23097 &">From&~"& when the &%file%& option is set, and unset when any of the
23098 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
23099
23100 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
23101 suitable for traditional &"BSD"& mailboxes, where a line beginning with
23102 &"From&~"& indicates the start of a new message. All four options need changing
23103 if another format is used. For example, to deliver to mailboxes in MMDF format:
23104 .cindex "MMDF format mailbox"
23105 .cindex "mailbox" "MMDF format"
23106 .code
23107 check_string = "\1\1\1\1\n"
23108 escape_string = "\1\1\1\1 \n"
23109 message_prefix = "\1\1\1\1\n"
23110 message_suffix = "\1\1\1\1\n"
23111 .endd
23112 .option create_directory appendfile boolean true
23113 .cindex "directory creation"
23114 When this option is true, Exim attempts to create any missing superior
23115 directories for the file that it is about to write. A created directory's mode
23116 is given by the &%directory_mode%& option.
23117
23118 The group ownership of a newly created directory is highly dependent on the
23119 operating system (and possibly the file system) that is being used. For
23120 example, in Solaris, if the parent directory has the setgid bit set, its group
23121 is propagated to the child; if not, the currently set group is used. However,
23122 in FreeBSD, the parent's group is always used.
23123
23124
23125
23126 .option create_file appendfile string anywhere
23127 This option constrains the location of files and directories that are created
23128 by this transport. It applies to files defined by the &%file%& option and
23129 directories defined by the &%directory%& option. In the case of maildir
23130 delivery, it applies to the top level directory, not the maildir directories
23131 beneath.
23132
23133 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
23134 &"belowhome"&. In the second and third cases, a home directory must have been
23135 set for the transport. This option is not useful when an explicit filename is
23136 given for normal mailbox deliveries. It is intended for the case when filenames
23137 are generated from users' &_.forward_& files. These are usually handled
23138 by an &(appendfile)& transport called &%address_file%&. See also
23139 &%file_must_exist%&.
23140
23141
23142 .option directory appendfile string&!! unset
23143 This option is mutually exclusive with the &%file%& option, but one of &%file%&
23144 or &%directory%& must be set, unless the delivery is the direct result of a
23145 redirection (see section &<<SECTfildiropt>>&).
23146
23147 When &%directory%& is set, the string is expanded, and the message is delivered
23148 into a new file or files in or below the given directory, instead of being
23149 appended to a single mailbox file. A number of different formats are provided
23150 (see &%maildir_format%& and &%mailstore_format%&), and see section
23151 &<<SECTopdir>>& for further details of this form of delivery.
23152
23153
23154 .option directory_file appendfile string&!! "see below"
23155 .cindex "base62"
23156 .vindex "&$inode$&"
23157 When &%directory%& is set, but neither &%maildir_format%& nor
23158 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
23159 whose name is obtained by expanding this string. The default value is:
23160 .code
23161 q${base62:$tod_epoch}-$inode
23162 .endd
23163 This generates a unique name from the current time, in base 62 form, and the
23164 inode of the file. The variable &$inode$& is available only when expanding this
23165 option.
23166
23167
23168 .option directory_mode appendfile "octal integer" 0700
23169 If &(appendfile)& creates any directories as a result of the
23170 &%create_directory%& option, their mode is specified by this option.
23171
23172
23173 .option escape_string appendfile string "see description"
23174 See &%check_string%& above.
23175
23176
23177 .option file appendfile string&!! unset
23178 This option is mutually exclusive with the &%directory%& option, but one of
23179 &%file%& or &%directory%& must be set, unless the delivery is the direct result
23180 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
23181 specifies a single file, to which the message is appended. One or more of
23182 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
23183 &%file%&.
23184
23185 .cindex "NFS" "lock file"
23186 .cindex "locking files"
23187 .cindex "lock files"
23188 If you are using more than one host to deliver over NFS into the same
23189 mailboxes, you should always use lock files.
23190
23191 The string value is expanded for each delivery, and must yield an absolute
23192 path. The most common settings of this option are variations on one of these
23193 examples:
23194 .code
23195 file = /var/spool/mail/$local_part_data
23196 file = /home/$local_part_data/inbox
23197 file = $home/inbox
23198 .endd
23199 .cindex "&""sticky""& bit"
23200 In the first example, all deliveries are done into the same directory. If Exim
23201 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23202 create a file in the directory, so the &"sticky"& bit must be turned on for
23203 deliveries to be possible, or alternatively the &%group%& option can be used to
23204 run the delivery under a group id which has write access to the directory.
23205
23206
23207
23208 .option file_format appendfile string unset
23209 .cindex "file" "mailbox; checking existing format"
23210 This option requests the transport to check the format of an existing file
23211 before adding to it. The check consists of matching a specific string at the
23212 start of the file. The value of the option consists of an even number of
23213 colon-separated strings. The first of each pair is the test string, and the
23214 second is the name of a transport. If the transport associated with a matched
23215 string is not the current transport, control is passed over to the other
23216 transport. For example, suppose the standard &(local_delivery)& transport has
23217 this added to it:
23218 .code
23219 file_format = "From       : local_delivery :\
23220                \1\1\1\1\n : local_mmdf_delivery"
23221 .endd
23222 Mailboxes that begin with &"From"& are still handled by this transport, but if
23223 a mailbox begins with four binary ones followed by a newline, control is passed
23224 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23225 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23226 is assumed to match the current transport. If the start of a mailbox doesn't
23227 match any string, or if the transport named for a given string is not defined,
23228 delivery is deferred.
23229
23230
23231 .option file_must_exist appendfile boolean false
23232 If this option is true, the file specified by the &%file%& option must exist.
23233 A temporary error occurs if it does not, causing delivery to be deferred.
23234 If this option is false, the file is created if it does not exist.
23235
23236
23237 .option lock_fcntl_timeout appendfile time 0s
23238 .cindex "timeout" "mailbox locking"
23239 .cindex "mailbox" "locking, blocking and non-blocking"
23240 .cindex "locking files"
23241 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23242 when locking an open mailbox file. If the call fails, the delivery process
23243 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23244 Non-blocking calls are used so that the file is not kept open during the wait
23245 for the lock; the reason for this is to make it as safe as possible for
23246 deliveries over NFS in the case when processes might be accessing an NFS
23247 mailbox without using a lock file. This should not be done, but
23248 misunderstandings and hence misconfigurations are not unknown.
23249
23250 On a busy system, however, the performance of a non-blocking lock approach is
23251 not as good as using a blocking lock with a timeout. In this case, the waiting
23252 is done inside the system call, and Exim's delivery process acquires the lock
23253 and can proceed as soon as the previous lock holder releases it.
23254
23255 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23256 timeout, are used. There may still be some retrying: the maximum number of
23257 retries is
23258 .code
23259 (lock_retries * lock_interval) / lock_fcntl_timeout
23260 .endd
23261 rounded up to the next whole number. In other words, the total time during
23262 which &(appendfile)& is trying to get a lock is roughly the same, unless
23263 &%lock_fcntl_timeout%& is set very large.
23264
23265 You should consider setting this option if you are getting a lot of delayed
23266 local deliveries because of errors of the form
23267 .code
23268 failed to lock mailbox /some/file (fcntl)
23269 .endd
23270
23271 .option lock_flock_timeout appendfile time 0s
23272 This timeout applies to file locking when using &[flock()]& (see
23273 &%use_flock%&); the timeout operates in a similar manner to
23274 &%lock_fcntl_timeout%&.
23275
23276
23277 .option lock_interval appendfile time 3s
23278 This specifies the time to wait between attempts to lock the file. See below
23279 for details of locking.
23280
23281
23282 .option lock_retries appendfile integer 10
23283 This specifies the maximum number of attempts to lock the file. A value of zero
23284 is treated as 1. See below for details of locking.
23285
23286
23287 .option lockfile_mode appendfile "octal integer" 0600
23288 This specifies the mode of the created lock file, when a lock file is being
23289 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23290
23291
23292 .option lockfile_timeout appendfile time 30m
23293 .cindex "timeout" "mailbox locking"
23294 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23295 exists and is older than this value, it is assumed to have been left behind by
23296 accident, and Exim attempts to remove it.
23297
23298
23299 .option mailbox_filecount appendfile string&!! unset
23300 .cindex "mailbox" "specifying size of"
23301 .cindex "size" "of mailbox"
23302 If this option is set, it is expanded, and the result is taken as the current
23303 number of files in the mailbox. It must be a decimal number, optionally
23304 followed by K or M. This provides a way of obtaining this information from an
23305 external source that maintains the data.
23306
23307
23308 .option mailbox_size appendfile string&!! unset
23309 .cindex "mailbox" "specifying size of"
23310 .cindex "size" "of mailbox"
23311 If this option is set, it is expanded, and the result is taken as the current
23312 size the mailbox. It must be a decimal number, optionally followed by K or M.
23313 This provides a way of obtaining this information from an external source that
23314 maintains the data. This is likely to be helpful for maildir deliveries where
23315 it is computationally expensive to compute the size of a mailbox.
23316
23317
23318
23319 .option maildir_format appendfile boolean false
23320 .cindex "maildir format" "specifying"
23321 If this option is set with the &%directory%& option, the delivery is into a new
23322 file, in the &"maildir"& format that is used by other mail software. When the
23323 transport is activated directly from a &(redirect)& router (for example, the
23324 &(address_file)& transport in the default configuration), setting
23325 &%maildir_format%& causes the path received from the router to be treated as a
23326 directory, whether or not it ends with &`/`&. This option is available only if
23327 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23328 &<<SECTmaildirdelivery>>& below for further details.
23329
23330
23331 .option maildir_quota_directory_regex appendfile string "See below"
23332 .cindex "maildir format" "quota; directories included in"
23333 .cindex "quota" "maildir; directories included in"
23334 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23335 a regular expression for specifying directories, relative to the quota
23336 directory (see &%quota_directory%&), that should be included in the quota
23337 calculation. The default value is:
23338 .code
23339 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23340 .endd
23341 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23342 (directories whose names begin with a dot). If you want to exclude the
23343 &_Trash_&
23344 folder from the count (as some sites do), you need to change this setting to
23345 .code
23346 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23347 .endd
23348 This uses a negative lookahead in the regular expression to exclude the
23349 directory whose name is &_.Trash_&. When a directory is excluded from quota
23350 calculations, quota processing is bypassed for any messages that are delivered
23351 directly into that directory.
23352
23353
23354 .option maildir_retries appendfile integer 10
23355 This option specifies the number of times to retry when writing a file in
23356 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23357
23358
23359 .option maildir_tag appendfile string&!! unset
23360 This option applies only to deliveries in maildir format, and is described in
23361 section &<<SECTmaildirdelivery>>& below.
23362
23363
23364 .option maildir_use_size_file appendfile&!! boolean false
23365 .cindex "maildir format" "&_maildirsize_& file"
23366 The result of string expansion for this option must be a valid boolean value.
23367 If it is true, it enables support for &_maildirsize_& files. Exim
23368 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23369 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23370 value is zero. See &%maildir_quota_directory_regex%& above and section
23371 &<<SECTmaildirdelivery>>& below for further details.
23372
23373 .option maildirfolder_create_regex appendfile string unset
23374 .cindex "maildir format" "&_maildirfolder_& file"
23375 .cindex "&_maildirfolder_&, creating"
23376 The value of this option is a regular expression. If it is unset, it has no
23377 effect. Otherwise, before a maildir delivery takes place, the pattern is
23378 matched against the name of the maildir directory, that is, the directory
23379 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23380 delivery. If there is a match, Exim checks for the existence of a file called
23381 &_maildirfolder_& in the directory, and creates it if it does not exist.
23382 See section &<<SECTmaildirdelivery>>& for more details.
23383
23384
23385 .option mailstore_format appendfile boolean false
23386 .cindex "mailstore format" "specifying"
23387 If this option is set with the &%directory%& option, the delivery is into two
23388 new files in  &"mailstore"& format. The option is available only if
23389 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23390 below for further details.
23391
23392
23393 .option mailstore_prefix appendfile string&!! unset
23394 This option applies only to deliveries in mailstore format, and is described in
23395 section &<<SECTopdir>>& below.
23396
23397
23398 .option mailstore_suffix appendfile string&!! unset
23399 This option applies only to deliveries in mailstore format, and is described in
23400 section &<<SECTopdir>>& below.
23401
23402
23403 .option mbx_format appendfile boolean false
23404 .cindex "locking files"
23405 .cindex "file" "locking"
23406 .cindex "file" "MBX format"
23407 .cindex "MBX format, specifying"
23408 This option is available only if Exim has been compiled with SUPPORT_MBX
23409 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23410 the message is appended to the mailbox file in MBX format instead of
23411 traditional Unix format. This format is supported by Pine4 and its associated
23412 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23413
23414 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23415 automatically changed by the use of &%mbx_format%&. They should normally be set
23416 empty when using MBX format, so this option almost always appears in this
23417 combination:
23418 .code
23419 mbx_format = true
23420 message_prefix =
23421 message_suffix =
23422 .endd
23423 If none of the locking options are mentioned in the configuration,
23424 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23425 is possible to specify the other kinds of locking with &%mbx_format%&, but
23426 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23427 interworks with &'c-client'&, providing for shared access to the mailbox. It
23428 should not be used if any program that does not use this form of locking is
23429 going to access the mailbox, nor should it be used if the mailbox file is NFS
23430 mounted, because it works only when the mailbox is accessed from a single host.
23431
23432 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23433 the standard version of &'c-client'&, because as long as it has a mailbox open
23434 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23435 append messages to it.
23436
23437
23438 .option message_prefix appendfile string&!! "see below"
23439 .cindex "&""From""& line"
23440 The string specified here is expanded and output at the start of every message.
23441 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23442 in which case it is:
23443 .code
23444 message_prefix = "From ${if def:return_path{$return_path}\
23445   {MAILER-DAEMON}} $tod_bsdinbox\n"
23446 .endd
23447 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23448 &`\n`& to &`\r\n`& in &%message_prefix%&.
23449
23450 .option message_suffix appendfile string&!! "see below"
23451 The string specified here is expanded and output at the end of every message.
23452 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23453 in which case it is a single newline character. The suffix can be suppressed by
23454 setting
23455 .code
23456 message_suffix =
23457 .endd
23458 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23459 &`\n`& to &`\r\n`& in &%message_suffix%&.
23460
23461 .option mode appendfile "octal integer" 0600
23462 If the output file is created, it is given this mode. If it already exists and
23463 has wider permissions, they are reduced to this mode. If it has narrower
23464 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23465 if the delivery is the result of a &%save%& command in a filter file specifying
23466 a particular mode, the mode of the output file is always forced to take that
23467 value, and this option is ignored.
23468
23469
23470 .option mode_fail_narrower appendfile boolean true
23471 This option applies in the case when an existing mailbox file has a narrower
23472 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23473 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23474 continues with the delivery attempt, using the existing mode of the file.
23475
23476
23477 .option notify_comsat appendfile boolean false
23478 If this option is true, the &'comsat'& daemon is notified after every
23479 successful delivery to a user mailbox. This is the daemon that notifies logged
23480 on users about incoming mail.
23481
23482
23483 .option quota appendfile string&!! unset
23484 .cindex "quota" "imposed by Exim"
23485 This option imposes a limit on the size of the file to which Exim is appending,
23486 or to the total space used in the directory tree when the &%directory%& option
23487 is set. In the latter case, computation of the space used is expensive, because
23488 all the files in the directory (and any sub-directories) have to be
23489 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23490 &%maildir_use_size_file%& for ways to avoid this in environments where users
23491 have no shell access to their mailboxes).
23492
23493 As there is no interlock against two simultaneous deliveries into a
23494 multi-file mailbox, it is possible for the quota to be overrun in this case.
23495 For single-file mailboxes, of course, an interlock is a necessity.
23496
23497 A file's size is taken as its &'used'& value. Because of blocking effects, this
23498 may be a lot less than the actual amount of disk space allocated to the file.
23499 If the sizes of a number of files are being added up, the rounding effect can
23500 become quite noticeable, especially on systems that have large block sizes.
23501 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23502 the obvious value which users understand most easily.
23503
23504 The value of the option is expanded, and must then be a numerical value
23505 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23506 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23507 and further option modifiers. If Exim is running on a system with
23508 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23509 be handled.
23510
23511 The option modifier &%no_check%& can be used to force delivery even if the over
23512 quota condition is met. The quota gets updated as usual.
23513
23514 &*Note*&: A value of zero is interpreted as &"no quota"&.
23515
23516 The expansion happens while Exim is running as root, before it changes uid for
23517 the delivery. This means that files that are inaccessible to the end user can
23518 be used to hold quota values that are looked up in the expansion. When delivery
23519 fails because this quota is exceeded, the handling of the error is as for
23520 system quota failures.
23521
23522 By default, Exim's quota checking mimics system quotas, and restricts the
23523 mailbox to the specified maximum size, though the value is not accurate to the
23524 last byte, owing to separator lines and additional headers that may get added
23525 during message delivery. When a mailbox is nearly full, large messages may get
23526 refused even though small ones are accepted, because the size of the current
23527 message is added to the quota when the check is made. This behaviour can be
23528 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23529 for exceeding the quota does not include the current message. Thus, deliveries
23530 continue until the quota has been exceeded; thereafter, no further messages are
23531 delivered. See also &%quota_warn_threshold%&.
23532
23533
23534 .option quota_directory appendfile string&!! unset
23535 This option defines the directory to check for quota purposes when delivering
23536 into individual files. The default is the delivery directory, or, if a file
23537 called &_maildirfolder_& exists in a maildir directory, the parent of the
23538 delivery directory.
23539
23540
23541 .option quota_filecount appendfile string&!! 0
23542 This option applies when the &%directory%& option is set. It limits the total
23543 number of files in the directory (compare the inode limit in system quotas). It
23544 can only be used if &%quota%& is also set. The value is expanded; an expansion
23545 failure causes delivery to be deferred. A value of zero is interpreted as
23546 &"no quota"&.
23547
23548 The option modifier &%no_check%& can be used to force delivery even if the over
23549 quota condition is met. The quota gets updated as usual.
23550
23551 .option quota_is_inclusive appendfile boolean true
23552 See &%quota%& above.
23553
23554
23555 .option quota_size_regex appendfile string unset
23556 This option applies when one of the delivery modes that writes a separate file
23557 for each message is being used. When Exim wants to find the size of one of
23558 these files in order to test the quota, it first checks &%quota_size_regex%&.
23559 If this is set to a regular expression that matches the filename, and it
23560 captures one string, that string is interpreted as a representation of the
23561 file's size. The value of &%quota_size_regex%& is not expanded.
23562
23563 This feature is useful only when users have no shell access to their mailboxes
23564 &-- otherwise they could defeat the quota simply by renaming the files. This
23565 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23566 the file length to the filename. For example:
23567 .code
23568 maildir_tag = ,S=$message_size
23569 quota_size_regex = ,S=(\d+)
23570 .endd
23571 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23572 number of lines in the message.
23573
23574 The regular expression should not assume that the length is at the end of the
23575 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23576 sometimes add other information onto the ends of message filenames.
23577
23578 Section &<<SECID136>>& contains further information.
23579
23580 This option should not be used when other message-handling software
23581 may duplicate messages by making hardlinks to the files.  When that is done Exim
23582 will count the message size once for each filename, in contrast with the actual
23583 disk usage.  When the option is not set, calculating total usage requires
23584 a system-call per file to get the size; the number of links is then available also
23585 as is used to adjust the effective size.
23586
23587
23588 .option quota_warn_message appendfile string&!! "see below"
23589 See below for the use of this option. If it is not set when
23590 &%quota_warn_threshold%& is set, it defaults to
23591 .code
23592 quota_warn_message = "\
23593   To: $local_part@$domain\n\
23594   Subject: Your mailbox\n\n\
23595   This message is automatically created \
23596   by mail delivery software.\n\n\
23597   The size of your mailbox has exceeded \
23598   a warning threshold that is\n\
23599   set by the system administrator.\n"
23600 .endd
23601
23602
23603 .option quota_warn_threshold appendfile string&!! 0
23604 .cindex "quota" "warning threshold"
23605 .cindex "mailbox" "size warning"
23606 .cindex "size" "of mailbox"
23607 This option is expanded in the same way as &%quota%& (see above). If the
23608 resulting value is greater than zero, and delivery of the message causes the
23609 size of the file or total space in the directory tree to cross the given
23610 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23611 may be specified as a percentage of it by following the value with a percent
23612 sign. For example:
23613 .code
23614 quota = 10M
23615 quota_warn_threshold = 75%
23616 .endd
23617 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23618 percent sign is ignored.
23619
23620 The warning message itself is specified by the &%quota_warn_message%& option,
23621 and it must start with a &'To:'& header line containing the recipient(s) of the
23622 warning message. These do not necessarily have to include the recipient(s) of
23623 the original message. A &'Subject:'& line should also normally be supplied. You
23624 can include any other header lines that you want. If you do not include a
23625 &'From:'& line, the default is:
23626 .code
23627 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23628 .endd
23629 .oindex &%errors_reply_to%&
23630 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23631 option.
23632
23633 The &%quota%& option does not have to be set in order to use this option; they
23634 are independent of one another except when the threshold is specified as a
23635 percentage.
23636
23637
23638 .option use_bsmtp appendfile boolean false
23639 .cindex "envelope from"
23640 .cindex "envelope sender"
23641 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23642 format, with the envelope sender and recipient(s) included as SMTP commands. If
23643 you want to include a leading HELO command with such messages, you can do
23644 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23645 for details of batch SMTP.
23646
23647
23648 .option use_crlf appendfile boolean false
23649 .cindex "carriage return"
23650 .cindex "linefeed"
23651 This option causes lines to be terminated with the two-character CRLF sequence
23652 (carriage return, linefeed) instead of just a linefeed character. In the case
23653 of batched SMTP, the byte sequence written to the file is then an exact image
23654 of what would be sent down a real SMTP connection.
23655
23656 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23657 (which are used to supply the traditional &"From&~"& and blank line separators
23658 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23659 carriage return characters if these are needed. In cases where these options
23660 have non-empty defaults, the values end with a single linefeed, so they must be
23661 changed to end with &`\r\n`& if &%use_crlf%& is set.
23662
23663
23664 .option use_fcntl_lock appendfile boolean "see below"
23665 This option controls the use of the &[fcntl()]& function to lock a file for
23666 exclusive use when a message is being appended. It is set by default unless
23667 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23668 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23669 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23670
23671
23672 .option use_flock_lock appendfile boolean false
23673 This option is provided to support the use of &[flock()]& for file locking, for
23674 the few situations where it is needed. Most modern operating systems support
23675 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23676 each other. Exim uses &[fcntl()]& locking by default.
23677
23678 This option is required only if you are using an operating system where
23679 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23680 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23681 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23682
23683 .cindex "Solaris" "&[flock()]& support"
23684 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23685 have it (and some, I think, provide a not quite right version built on top of
23686 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23687 the ability to use it, and any attempt to do so will cause a configuration
23688 error.
23689
23690 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23691 is just being mapped onto &[fcntl()]& by the OS).
23692
23693
23694 .option use_lockfile appendfile boolean "see below"
23695 If this option is turned off, Exim does not attempt to create a lock file when
23696 appending to a mailbox file. In this situation, the only locking is by
23697 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23698 sure that every MUA that is ever going to look at your users' mailboxes uses
23699 &[fcntl()]& rather than a lock file, and even then only when you are not
23700 delivering over NFS from more than one host.
23701
23702 .cindex "NFS" "lock file"
23703 In order to append to an NFS file safely from more than one host, it is
23704 necessary to take out a lock &'before'& opening the file, and the lock file
23705 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23706 file corruption.
23707
23708 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23709 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23710 except when &%mbx_format%& is set.
23711
23712
23713 .option use_mbx_lock appendfile boolean "see below"
23714 This option is available only if Exim has been compiled with SUPPORT_MBX
23715 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23716 locking rules be used. It is set by default if &%mbx_format%& is set and none
23717 of the locking options are mentioned in the configuration. The locking rules
23718 are the same as are used by the &'c-client'& library that underlies Pine and
23719 the IMAP4 and POP daemons that come with it (see the discussion below). The
23720 rules allow for shared access to the mailbox. However, this kind of locking
23721 does not work when the mailbox is NFS mounted.
23722
23723 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23724 &%use_flock_lock%& to control what kind of locking is used in implementing the
23725 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23726 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23727
23728
23729
23730
23731 .section "Operational details for appending" "SECTopappend"
23732 .cindex "appending to a file"
23733 .cindex "file" "appending"
23734 Before appending to a file, the following preparations are made:
23735
23736 .ilist
23737 If the name of the file is &_/dev/null_&, no action is taken, and a success
23738 return is given.
23739
23740 .next
23741 .cindex "directory creation"
23742 If any directories on the file's path are missing, Exim creates them if the
23743 &%create_directory%& option is set. A created directory's mode is given by the
23744 &%directory_mode%& option.
23745
23746 .next
23747 If &%file_format%& is set, the format of an existing file is checked. If this
23748 indicates that a different transport should be used, control is passed to that
23749 transport.
23750
23751 .next
23752 .cindex "file" "locking"
23753 .cindex "locking files"
23754 .cindex "NFS" "lock file"
23755 If &%use_lockfile%& is set, a lock file is built in a way that will work
23756 reliably over NFS, as follows:
23757
23758 .olist
23759 Create a &"hitching post"& file whose name is that of the lock file with the
23760 current time, primary host name, and process id added, by opening for writing
23761 as a new file. If this fails with an access error, delivery is deferred.
23762 .next
23763 Close the hitching post file, and hard link it to the lock filename.
23764 .next
23765 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23766 Unlink the hitching post name.
23767 .next
23768 Otherwise, use &[stat()]& to get information about the hitching post file, and
23769 then unlink hitching post name. If the number of links is exactly two, creation
23770 of the lock file succeeded but something (for example, an NFS server crash and
23771 restart) caused this fact not to be communicated to the &[link()]& call.
23772 .next
23773 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23774 up to &%lock_retries%& times. However, since any program that writes to a
23775 mailbox should complete its task very quickly, it is reasonable to time out old
23776 lock files that are normally the result of user agent and system crashes. If an
23777 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23778 it before trying again.
23779 .endlist olist
23780
23781 .next
23782 A call is made to &[lstat()]& to discover whether the main file exists, and if
23783 so, what its characteristics are. If &[lstat()]& fails for any reason other
23784 than non-existence, delivery is deferred.
23785
23786 .next
23787 .cindex "symbolic link" "to mailbox"
23788 .cindex "mailbox" "symbolic link"
23789 If the file does exist and is a symbolic link, delivery is deferred, unless the
23790 &%allow_symlink%& option is set, in which case the ownership of the link is
23791 checked, and then &[stat()]& is called to find out about the real file, which
23792 is then subjected to the checks below. The check on the top-level link
23793 ownership prevents one user creating a link for another's mailbox in a sticky
23794 directory, though allowing symbolic links in this case is definitely not a good
23795 idea. If there is a chain of symbolic links, the intermediate ones are not
23796 checked.
23797
23798 .next
23799 If the file already exists but is not a regular file, or if the file's owner
23800 and group (if the group is being checked &-- see &%check_group%& above) are
23801 different from the user and group under which the delivery is running,
23802 delivery is deferred.
23803
23804 .next
23805 If the file's permissions are more generous than specified, they are reduced.
23806 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23807 is set false, in which case the delivery is tried using the existing
23808 permissions.
23809
23810 .next
23811 The file's inode number is saved, and the file is then opened for appending.
23812 If this fails because the file has vanished, &(appendfile)& behaves as if it
23813 hadn't existed (see below). For any other failures, delivery is deferred.
23814
23815 .next
23816 If the file is opened successfully, check that the inode number hasn't
23817 changed, that it is still a regular file, and that the owner and permissions
23818 have not changed. If anything is wrong, defer delivery and freeze the message.
23819
23820 .next
23821 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23822 option is set. Otherwise, check that the file is being created in a permitted
23823 directory if the &%create_file%& option is set (deferring on failure), and then
23824 open for writing as a new file, with the O_EXCL and O_CREAT options,
23825 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23826 set). In this case, which can happen if the link points to a non-existent file,
23827 the file is opened for writing using O_CREAT but not O_EXCL, because
23828 that prevents link following.
23829
23830 .next
23831 .cindex "loop" "while file testing"
23832 If opening fails because the file exists, obey the tests given above for
23833 existing files. However, to avoid looping in a situation where the file is
23834 being continuously created and destroyed, the exists/not-exists loop is broken
23835 after 10 repetitions, and the message is then frozen.
23836
23837 .next
23838 If opening fails with any other error, defer delivery.
23839
23840 .next
23841 .cindex "file" "locking"
23842 .cindex "locking files"
23843 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23844 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23845 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23846 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23847 file, and an exclusive lock on the file whose name is
23848 .code
23849 /tmp/.<device-number>.<inode-number>
23850 .endd
23851 using the device and inode numbers of the open mailbox file, in accordance with
23852 the MBX locking rules. This file is created with a mode that is specified by
23853 the &%lockfile_mode%& option.
23854
23855 If Exim fails to lock the file, there are two possible courses of action,
23856 depending on the value of the locking timeout. This is obtained from
23857 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23858
23859 If the timeout value is zero, the file is closed, Exim waits for
23860 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23861 to lock it again. This happens up to &%lock_retries%& times, after which the
23862 delivery is deferred.
23863
23864 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23865 &[flock()]& are used (with the given timeout), so there has already been some
23866 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23867 immediately. It retries up to
23868 .code
23869 (lock_retries * lock_interval) / <timeout>
23870 .endd
23871 times (rounded up).
23872 .endlist
23873
23874 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23875 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23876
23877
23878 .section "Operational details for delivery to a new file" "SECTopdir"
23879 .cindex "delivery" "to single file"
23880 .cindex "&""From""& line"
23881 When the &%directory%& option is set instead of &%file%&, each message is
23882 delivered into a newly-created file or set of files. When &(appendfile)& is
23883 activated directly from a &(redirect)& router, neither &%file%& nor
23884 &%directory%& is normally set, because the path for delivery is supplied by the
23885 router. (See for example, the &(address_file)& transport in the default
23886 configuration.) In this case, delivery is to a new file if either the path name
23887 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23888
23889 No locking is required while writing the message to a new file, so the various
23890 locking options of the transport are ignored. The &"From"& line that by default
23891 separates messages in a single file is not normally needed, nor is the escaping
23892 of message lines that start with &"From"&, and there is no need to ensure a
23893 newline at the end of each message. Consequently, the default values for
23894 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23895 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23896
23897 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23898 the files in the delivery directory by default. However, you can specify a
23899 different directory by setting &%quota_directory%&. Also, for maildir
23900 deliveries (see below) the &_maildirfolder_& convention is honoured.
23901
23902
23903 .cindex "maildir format"
23904 .cindex "mailstore format"
23905 There are three different ways in which delivery to individual files can be
23906 done, controlled by the settings of the &%maildir_format%& and
23907 &%mailstore_format%& options. Note that code to support maildir or mailstore
23908 formats is not included in the binary unless SUPPORT_MAILDIR or
23909 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23910
23911 .cindex "directory creation"
23912 In all three cases an attempt is made to create the directory and any necessary
23913 sub-directories if they do not exist, provided that the &%create_directory%&
23914 option is set (the default). The location of a created directory can be
23915 constrained by setting &%create_file%&. A created directory's mode is given by
23916 the &%directory_mode%& option. If creation fails, or if the
23917 &%create_directory%& option is not set when creation is required, delivery is
23918 deferred.
23919
23920
23921
23922 .section "Maildir delivery" "SECTmaildirdelivery"
23923 .cindex "maildir format" "description of"
23924 If the &%maildir_format%& option is true, Exim delivers each message by writing
23925 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23926 directory that is defined by the &%directory%& option (the &"delivery
23927 directory"&). If the delivery is successful, the file is renamed into the
23928 &_new_& subdirectory.
23929
23930 In the filename, <&'stime'&> is the current time of day in seconds, and
23931 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23932 Exim checks that the time-of-day clock has moved on by at least one microsecond
23933 before terminating the delivery process. This guarantees uniqueness for the
23934 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23935 opening it. If any response other than ENOENT (does not exist) is given,
23936 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23937
23938 Before Exim carries out a maildir delivery, it ensures that subdirectories
23939 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23940 do not exist, Exim tries to create them and any superior directories in their
23941 path, subject to the &%create_directory%& and &%create_file%& options. If the
23942 &%maildirfolder_create_regex%& option is set, and the regular expression it
23943 contains matches the delivery directory, Exim also ensures that a file called
23944 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23945 &_maildirfolder_& file cannot be created, delivery is deferred.
23946
23947 These features make it possible to use Exim to create all the necessary files
23948 and directories in a maildir mailbox, including subdirectories for maildir++
23949 folders. Consider this example:
23950 .code
23951 maildir_format = true
23952 directory = /var/mail/$local_part_data\
23953            ${if eq{$local_part_suffix}{}{}\
23954            {/.${substr_1:$local_part_suffix}}}
23955 maildirfolder_create_regex = /\.[^/]+$
23956 .endd
23957 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23958 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23959 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23960 not match this name, so Exim will not look for or create the file
23961 &_/var/mail/pimbo/maildirfolder_&, though it will create
23962 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23963
23964 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23965 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23966 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23967 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23968 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23969
23970 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23971 not inadvertently match the toplevel maildir directory, because a
23972 &_maildirfolder_& file at top level would completely break quota calculations.
23973
23974 .cindex "quota" "in maildir delivery"
23975 .cindex "maildir++"
23976 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23977 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23978 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23979 Exim assumes the directory is a maildir++ folder directory, which is one level
23980 down from the user's top level mailbox directory. This causes it to start at
23981 the parent directory instead of the current directory when calculating the
23982 amount of space used.
23983
23984 One problem with delivering into a multi-file mailbox is that it is
23985 computationally expensive to compute the size of the mailbox for quota
23986 checking. Various approaches have been taken to reduce the amount of work
23987 needed. The next two sections describe two of them. A third alternative is to
23988 use some external process for maintaining the size data, and use the expansion
23989 of the &%mailbox_size%& option as a way of importing it into Exim.
23990
23991
23992
23993
23994 .section "Using tags to record message sizes" "SECID135"
23995 If &%maildir_tag%& is set, the string is expanded for each delivery.
23996 When the maildir file is renamed into the &_new_& sub-directory, the
23997 tag is added to its name. However, if adding the tag takes the length of the
23998 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23999 the tag is dropped and the maildir file is created with no tag.
24000
24001
24002 .vindex "&$message_size$&"
24003 Tags can be used to encode the size of files in their names; see
24004 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
24005 happens after the message has been written. The value of the &$message_size$&
24006 variable is set to the number of bytes actually written. If the expansion is
24007 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
24008 be deferred. The expanded tag may contain any printing characters except &"/"&.
24009 Non-printing characters in the string are ignored; if the resulting string is
24010 empty, it is ignored. If it starts with an alphanumeric character, a leading
24011 colon is inserted; this default has not proven to be the path that popular
24012 maildir implementations have chosen (but changing it in Exim would break
24013 backwards compatibility).
24014
24015 For one common implementation, you might set:
24016 .code
24017 maildir_tag = ,S=${message_size}
24018 .endd
24019 but you should check the documentation of the other software to be sure.
24020
24021 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
24022 as this allows Exim to extract the size from your tag, instead of having to
24023 &[stat()]& each message file.
24024
24025
24026 .section "Using a maildirsize file" "SECID136"
24027 .cindex "quota" "in maildir delivery"
24028 .cindex "maildir format" "&_maildirsize_& file"
24029 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
24030 storing quota and message size information in a file called &_maildirsize_&
24031 within the toplevel maildir directory. If this file does not exist, Exim
24032 creates it, setting the quota from the &%quota%& option of the transport. If
24033 the maildir directory itself does not exist, it is created before any attempt
24034 to write a &_maildirsize_& file.
24035
24036 The &_maildirsize_& file is used to hold information about the sizes of
24037 messages in the maildir, thus speeding up quota calculations. The quota value
24038 in the file is just a cache; if the quota is changed in the transport, the new
24039 value overrides the cached value when the next message is delivered. The cache
24040 is maintained for the benefit of other programs that access the maildir and
24041 need to know the quota.
24042
24043 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
24044 file is maintained (with a zero quota setting), but no quota is imposed.
24045
24046 A regular expression is available for controlling which directories in the
24047 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
24048 See the description of the &%maildir_quota_directory_regex%& option above for
24049 details.
24050
24051
24052 .section "Mailstore delivery" "SECID137"
24053 .cindex "mailstore format" "description of"
24054 If the &%mailstore_format%& option is true, each message is written as two
24055 files in the given directory. A unique base name is constructed from the
24056 message id and the current delivery process, and the files that are written use
24057 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
24058 contains the message's envelope, and the &_.msg_& file contains the message
24059 itself. The base name is placed in the variable &$mailstore_basename$&.
24060
24061 During delivery, the envelope is first written to a file with the suffix
24062 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
24063 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
24064 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
24065 file before accessing either of them. An alternative approach is to wait for
24066 the absence of a &_.tmp_& file.
24067
24068 The envelope file starts with any text defined by the &%mailstore_prefix%&
24069 option, expanded and terminated by a newline if there isn't one. Then follows
24070 the sender address on one line, then all the recipient addresses, one per line.
24071 There can be more than one recipient only if the &%batch_max%& option is set
24072 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
24073 appended to the file, followed by a newline if it does not end with one.
24074
24075 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
24076 failure, it is ignored. Other expansion errors are treated as serious
24077 configuration errors, and delivery is deferred. The variable
24078 &$mailstore_basename$& is available for use during these expansions.
24079
24080
24081 .section "Non-special new file delivery" "SECID138"
24082 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
24083 file is created directly in the named directory. For example, when delivering
24084 messages into files in batched SMTP format for later delivery to some host (see
24085 section &<<SECTbatchSMTP>>&), a setting such as
24086 .code
24087 directory = /var/bsmtp/$host
24088 .endd
24089 might be used. A message is written to a file with a temporary name, which is
24090 then renamed when the delivery is complete. The final name is obtained by
24091 expanding the contents of the &%directory_file%& option.
24092 .ecindex IIDapptra1
24093 .ecindex IIDapptra2
24094
24095
24096
24097
24098
24099
24100 . ////////////////////////////////////////////////////////////////////////////
24101 . ////////////////////////////////////////////////////////////////////////////
24102
24103 .chapter "The autoreply transport" "CHID8"
24104 .scindex IIDauttra1 "transports" "&(autoreply)&"
24105 .scindex IIDauttra2 "&(autoreply)& transport"
24106 The &(autoreply)& transport is not a true transport in that it does not cause
24107 the message to be transmitted. Instead, it generates a new mail message as an
24108 automatic reply to the incoming message. &'References:'& and
24109 &'Auto-Submitted:'& header lines are included. These are constructed according
24110 to the rules in RFCs 2822 and 3834, respectively.
24111
24112 If the router that passes the message to this transport does not have the
24113 &%unseen%& option set, the original message (for the current recipient) is not
24114 delivered anywhere. However, when the &%unseen%& option is set on the router
24115 that passes the message to this transport, routing of the address continues, so
24116 another router can set up a normal message delivery.
24117
24118
24119 The &(autoreply)& transport is usually run as the result of mail filtering, a
24120 &"vacation"& message being the standard example. However, it can also be run
24121 directly from a router like any other transport. To reduce the possibility of
24122 message cascades, messages created by the &(autoreply)& transport always have
24123 empty envelope sender addresses, like bounce messages.
24124
24125 The parameters of the message to be sent can be specified in the configuration
24126 by options described below. However, these are used only when the address
24127 passed to the transport does not contain its own reply information. When the
24128 transport is run as a consequence of a
24129 &%mail%&
24130 or &%vacation%& command in a filter file, the parameters of the message are
24131 supplied by the filter, and passed with the address. The transport's options
24132 that define the message are then ignored (so they are not usually set in this
24133 case). The message is specified entirely by the filter or by the transport; it
24134 is never built from a mixture of options. However, the &%file_optional%&,
24135 &%mode%&, and &%return_message%& options apply in all cases.
24136
24137 &(Autoreply)& is implemented as a local transport. When used as a result of a
24138 command in a user's filter file, &(autoreply)& normally runs under the uid and
24139 gid of the user, and with appropriate current and home directories (see chapter
24140 &<<CHAPenvironment>>&).
24141
24142 There is a subtle difference between routing a message to a &(pipe)& transport
24143 that generates some text to be returned to the sender, and routing it to an
24144 &(autoreply)& transport. This difference is noticeable only if more than one
24145 address from the same message is so handled. In the case of a pipe, the
24146 separate outputs from the different addresses are gathered up and returned to
24147 the sender in a single message, whereas if &(autoreply)& is used, a separate
24148 message is generated for each address that is passed to it.
24149
24150 Non-printing characters are not permitted in the header lines generated for the
24151 message that &(autoreply)& creates, with the exception of newlines that are
24152 immediately followed by white space. If any non-printing characters are found,
24153 the transport defers.
24154 Whether characters with the top bit set count as printing characters or not is
24155 controlled by the &%print_topbitchars%& global option.
24156
24157 If any of the generic options for manipulating headers (for example,
24158 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
24159 of the original message that is included in the generated message when
24160 &%return_message%& is set. They do not apply to the generated message itself.
24161
24162 .vindex "&$sender_address$&"
24163 If the &(autoreply)& transport receives return code 2 from Exim when it submits
24164 the message, indicating that there were no recipients, it does not treat this
24165 as an error. This means that autoreplies sent to &$sender_address$& when this
24166 is empty (because the incoming message is a bounce message) do not cause
24167 problems. They are just discarded.
24168
24169
24170
24171 .section "Private options for autoreply" "SECID139"
24172 .cindex "options" "&(autoreply)& transport"
24173
24174 .option bcc autoreply string&!! unset
24175 This specifies the addresses that are to receive &"blind carbon copies"& of the
24176 message when the message is specified by the transport.
24177
24178
24179 .option cc autoreply string&!! unset
24180 This specifies recipients of the message and the contents of the &'Cc:'& header
24181 when the message is specified by the transport.
24182
24183
24184 .option file autoreply string&!! unset
24185 The contents of the file are sent as the body of the message when the message
24186 is specified by the transport. If both &%file%& and &%text%& are set, the text
24187 string comes first.
24188
24189
24190 .option file_expand autoreply boolean false
24191 If this is set, the contents of the file named by the &%file%& option are
24192 subjected to string expansion as they are added to the message.
24193
24194
24195 .option file_optional autoreply boolean false
24196 If this option is true, no error is generated if the file named by the &%file%&
24197 option or passed with the address does not exist or cannot be read.
24198
24199
24200 .option from autoreply string&!! unset
24201 This specifies the contents of the &'From:'& header when the message is
24202 specified by the transport.
24203
24204
24205 .option headers autoreply string&!! unset
24206 This specifies additional RFC 2822 headers that are to be added to the message
24207 when the message is specified by the transport. Several can be given by using
24208 &"\n"& to separate them. There is no check on the format.
24209
24210
24211 .option log autoreply string&!! unset
24212 This option names a file in which a record of every message sent is logged when
24213 the message is specified by the transport.
24214
24215
24216 .option mode autoreply "octal integer" 0600
24217 If either the log file or the &"once"& file has to be created, this mode is
24218 used.
24219
24220
24221 .option never_mail autoreply "address list&!!" unset
24222 If any run of the transport creates a message with a recipient that matches any
24223 item in the list, that recipient is quietly discarded. If all recipients are
24224 discarded, no message is created. This applies both when the recipients are
24225 generated by a filter and when they are specified in the transport.
24226
24227
24228
24229 .option once autoreply string&!! unset
24230 This option names a file or DBM database in which a record of each &'To:'&
24231 recipient is kept when the message is specified by the transport. &*Note*&:
24232 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24233
24234 If &%once%& is unset, or is set to an empty string, the message is always sent.
24235 By default, if &%once%& is set to a non-empty filename, the message
24236 is not sent if a potential recipient is already listed in the database.
24237 However, if the &%once_repeat%& option specifies a time greater than zero, the
24238 message is sent if that much time has elapsed since a message was last sent to
24239 this recipient. A setting of zero time for &%once_repeat%& (the default)
24240 prevents a message from being sent a second time &-- in this case, zero means
24241 infinity.
24242
24243 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24244 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24245 greater than zero, it changes the way Exim implements the &%once%& option.
24246 Instead of using a DBM file to record every recipient it sends to, it uses a
24247 regular file, whose size will never get larger than the given value.
24248
24249 In the file, Exim keeps a linear list of recipient addresses and the times at
24250 which they were sent messages. If the file is full when a new address needs to
24251 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24252 means that a given recipient may receive multiple messages, but at
24253 unpredictable intervals that depend on the rate of turnover of addresses in the
24254 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24255
24256
24257 .option once_file_size autoreply integer 0
24258 See &%once%& above.
24259
24260
24261 .option once_repeat autoreply time&!! 0s
24262 See &%once%& above.
24263 After expansion, the value of this option must be a valid time value.
24264
24265
24266 .option reply_to autoreply string&!! unset
24267 This specifies the contents of the &'Reply-To:'& header when the message is
24268 specified by the transport.
24269
24270
24271 .option return_message autoreply boolean false
24272 If this is set, a copy of the original message is returned with the new
24273 message, subject to the maximum size set in the &%return_size_limit%& global
24274 configuration option.
24275
24276
24277 .option subject autoreply string&!! unset
24278 This specifies the contents of the &'Subject:'& header when the message is
24279 specified by the transport. It is tempting to quote the original subject in
24280 automatic responses. For example:
24281 .code
24282 subject = Re: $h_subject:
24283 .endd
24284 There is a danger in doing this, however. It may allow a third party to
24285 subscribe your users to an opt-in mailing list, provided that the list accepts
24286 bounce messages as subscription confirmations. Well-managed lists require a
24287 non-bounce message to confirm a subscription, so the danger is relatively
24288 small.
24289
24290
24291
24292 .option text autoreply string&!! unset
24293 This specifies a single string to be used as the body of the message when the
24294 message is specified by the transport. If both &%text%& and &%file%& are set,
24295 the text comes first.
24296
24297
24298 .option to autoreply string&!! unset
24299 This specifies recipients of the message and the contents of the &'To:'& header
24300 when the message is specified by the transport.
24301 .ecindex IIDauttra1
24302 .ecindex IIDauttra2
24303
24304
24305
24306
24307 . ////////////////////////////////////////////////////////////////////////////
24308 . ////////////////////////////////////////////////////////////////////////////
24309
24310 .chapter "The lmtp transport" "CHAPLMTP"
24311 .cindex "transports" "&(lmtp)&"
24312 .cindex "&(lmtp)& transport"
24313 .cindex "LMTP" "over a pipe"
24314 .cindex "LMTP" "over a socket"
24315 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24316 specified command
24317 or by interacting with a Unix domain socket.
24318 This transport is something of a cross between the &(pipe)& and &(smtp)&
24319 transports. Exim also has support for using LMTP over TCP/IP; this is
24320 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24321 to be of minority interest, the default build-time configure in &_src/EDITME_&
24322 has it commented out. You need to ensure that
24323 .code
24324 TRANSPORT_LMTP=yes
24325 .endd
24326 .cindex "options" "&(lmtp)& transport"
24327 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24328 included in the Exim binary. The private options of the &(lmtp)& transport are
24329 as follows:
24330
24331 .option batch_id lmtp string&!! unset
24332 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24333
24334
24335 .option batch_max lmtp integer 1
24336 This limits the number of addresses that can be handled in a single delivery.
24337 Most LMTP servers can handle several addresses at once, so it is normally a
24338 good idea to increase this value. See the description of local delivery
24339 batching in chapter &<<CHAPbatching>>&.
24340
24341
24342 .option command lmtp string&!! unset
24343 This option must be set if &%socket%& is not set. The string is a command which
24344 is run in a separate process. It is split up into a command name and list of
24345 arguments, each of which is separately expanded (so expansion cannot change the
24346 number of arguments). The command is run directly, not via a shell. The message
24347 is passed to the new process using the standard input and output to operate the
24348 LMTP protocol.
24349
24350 .option ignore_quota lmtp boolean false
24351 .cindex "LMTP" "ignoring quota errors"
24352 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24353 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24354 in its response to the LHLO command.
24355
24356 .option socket lmtp string&!! unset
24357 This option must be set if &%command%& is not set. The result of expansion must
24358 be the name of a Unix domain socket. The transport connects to the socket and
24359 delivers the message to it using the LMTP protocol.
24360
24361
24362 .option timeout lmtp time 5m
24363 The transport is aborted if the created process or Unix domain socket does not
24364 respond to LMTP commands or message input within this timeout. Delivery
24365 is deferred, and will be tried again later. Here is an example of a typical
24366 LMTP transport:
24367 .code
24368 lmtp:
24369   driver = lmtp
24370   command = /some/local/lmtp/delivery/program
24371   batch_max = 20
24372   user = exim
24373 .endd
24374 This delivers up to 20 addresses at a time, in a mixture of domains if
24375 necessary, running as the user &'exim'&.
24376
24377
24378
24379 . ////////////////////////////////////////////////////////////////////////////
24380 . ////////////////////////////////////////////////////////////////////////////
24381
24382 .chapter "The pipe transport" "CHAPpipetransport"
24383 .scindex IIDpiptra1 "transports" "&(pipe)&"
24384 .scindex IIDpiptra2 "&(pipe)& transport"
24385 The &(pipe)& transport is used to deliver messages via a pipe to a command
24386 running in another process. One example is the use of &(pipe)& as a
24387 pseudo-remote transport for passing messages to some other delivery mechanism
24388 (such as UUCP). Another is the use by individual users to automatically process
24389 their incoming messages. The &(pipe)& transport can be used in one of the
24390 following ways:
24391
24392 .ilist
24393 .vindex "&$local_part$&"
24394 A router routes one address to a transport in the normal way, and the
24395 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24396 contains the local part of the address (as usual), and the command that is run
24397 is specified by the &%command%& option on the transport.
24398 .next
24399 .vindex "&$pipe_addresses$&"
24400 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24401 transport can handle more than one address in a single run. In this case, when
24402 more than one address is routed to the transport, &$local_part$& is not set
24403 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24404 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24405 that are routed to the transport.
24406 .next
24407 .vindex "&$address_pipe$&"
24408 A router redirects an address directly to a pipe command (for example, from an
24409 alias or forward file). In this case, &$address_pipe$& contains the text of the
24410 pipe command, and the &%command%& option on the transport is ignored unless
24411 &%force_command%& is set. If only one address is being transported
24412 (&%batch_max%& is not greater than one, or only one address was redirected to
24413 this pipe command), &$local_part$& contains the local part that was redirected.
24414 .endlist
24415
24416
24417 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24418 deliver messages over pipes using the LMTP interactive protocol. This is
24419 implemented by the &(lmtp)& transport.
24420
24421 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24422 &_.forward_& file, the command runs under the uid and gid of that user. In
24423 other cases, the uid and gid have to be specified explicitly, either on the
24424 transport or on the router that handles the address. Current and &"home"&
24425 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24426 details of the local delivery environment and chapter &<<CHAPbatching>>&
24427 for a discussion of local delivery batching.
24428
24429 .cindex "tainted data" "in pipe command"
24430 .cindex pipe "tainted data"
24431 Tainted data may not be used for the command name.
24432
24433
24434 .section "Concurrent delivery" "SECID140"
24435 If two messages arrive at almost the same time, and both are routed to a pipe
24436 delivery, the two pipe transports may be run concurrently. You must ensure that
24437 any pipe commands you set up are robust against this happening. If the commands
24438 write to a file, the &%exim_lock%& utility might be of use.
24439 Alternatively the &%max_parallel%& option could be used with a value
24440 of "1" to enforce serialization.
24441
24442
24443
24444
24445 .section "Returned status and data" "SECID141"
24446 .cindex "&(pipe)& transport" "returned data"
24447 If the command exits with a non-zero return code, the delivery is deemed to
24448 have failed, unless either the &%ignore_status%& option is set (in which case
24449 the return code is treated as zero), or the return code is one of those listed
24450 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24451 later"&. In this case, delivery is deferred. Details of a permanent failure are
24452 logged, but are not included in the bounce message, which merely contains
24453 &"local delivery failed"&.
24454
24455 If the command exits on a signal and the &%freeze_signal%& option is set then
24456 the message will be frozen in the queue. If that option is not set, a bounce
24457 will be sent as normal.
24458
24459 If the return code is greater than 128 and the command being run is a shell
24460 script, it normally means that the script was terminated by a signal whose
24461 value is the return code minus 128. The &%freeze_signal%& option does not
24462 apply in this case.
24463
24464 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24465 return code is set to 127. This is the value that a shell returns if it is
24466 asked to run a non-existent command. The wording for the log line suggests that
24467 a non-existent command may be the problem.
24468
24469 The &%return_output%& option can affect the result of a pipe delivery. If it is
24470 set and the command produces any output on its standard output or standard
24471 error streams, the command is considered to have failed, even if it gave a zero
24472 return code or if &%ignore_status%& is set. The output from the command is
24473 included as part of the bounce message. The &%return_fail_output%& option is
24474 similar, except that output is returned only when the command exits with a
24475 failure return code, that is, a value other than zero or a code that matches
24476 &%temp_errors%&.
24477
24478
24479
24480 .section "How the command is run" "SECThowcommandrun"
24481 .cindex "&(pipe)& transport" "path for command"
24482 The command line is (by default) broken down into a command name and arguments
24483 by the &(pipe)& transport itself. The &%allow_commands%& and
24484 &%restrict_to_path%& options can be used to restrict the commands that may be
24485 run.
24486
24487 .cindex "quoting" "in pipe command"
24488 Unquoted arguments are delimited by white space. If an argument appears in
24489 double quotes, backslash is interpreted as an escape character in the usual
24490 way. If an argument appears in single quotes, no escaping is done.
24491
24492 String expansion is applied to the command line except when it comes from a
24493 traditional &_.forward_& file (commands from a filter file are expanded). The
24494 expansion is applied to each argument in turn rather than to the whole line.
24495 For this reason, any string expansion item that contains white space must be
24496 quoted so as to be contained within a single argument. A setting such as
24497 .code
24498 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24499 .endd
24500 will not work, because the expansion item gets split between several
24501 arguments. You have to write
24502 .code
24503 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24504 .endd
24505 to ensure that it is all in one argument. The expansion is done in this way,
24506 argument by argument, so that the number of arguments cannot be changed as a
24507 result of expansion, and quotes or backslashes in inserted variables do not
24508 interact with external quoting. However, this leads to problems if you want to
24509 generate multiple arguments (or the command name plus arguments) from a single
24510 expansion. In this situation, the simplest solution is to use a shell. For
24511 example:
24512 .code
24513 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24514 .endd
24515
24516 .cindex "transport" "filter"
24517 .cindex "filter" "transport filter"
24518 .vindex "&$pipe_addresses$&"
24519 Special handling takes place when an argument consists of precisely the text
24520 &`$pipe_addresses`& (no quotes).
24521 This is not a general expansion variable; the only
24522 place this string is recognized is when it appears as an argument for a pipe or
24523 transport filter command. It causes each address that is being handled to be
24524 inserted in the argument list at that point &'as a separate argument'&. This
24525 avoids any problems with spaces or shell metacharacters, and is of use when a
24526 &(pipe)& transport is handling groups of addresses in a batch.
24527
24528 If &%force_command%& is enabled on the transport, special handling takes place
24529 for an argument that consists of precisely the text &`$address_pipe`&.  It
24530 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24531 argument is inserted in the argument list at that point
24532 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24533 the only item in the argument; in fact, if it were then &%force_command%&
24534 should behave as a no-op.  Rather, it should be used to adjust the command
24535 run while preserving the argument vector separation.
24536
24537 After splitting up into arguments and expansion, the resulting command is run
24538 in a subprocess directly from the transport, &'not'& under a shell. The
24539 message that is being delivered is supplied on the standard input, and the
24540 standard output and standard error are both connected to a single pipe that is
24541 read by Exim. The &%max_output%& option controls how much output the command
24542 may produce, and the &%return_output%& and &%return_fail_output%& options
24543 control what is done with it.
24544
24545 Not running the command under a shell (by default) lessens the security risks
24546 in cases when a command from a user's filter file is built out of data that was
24547 taken from an incoming message. If a shell is required, it can of course be
24548 explicitly specified as the command to be run. However, there are circumstances
24549 where existing commands (for example, in &_.forward_& files) expect to be run
24550 under a shell and cannot easily be modified. To allow for these cases, there is
24551 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24552 works. Instead of breaking up the command line as just described, it expands it
24553 as a single string and passes the result to &_/bin/sh_&. The
24554 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24555 with &%use_shell%&, and the whole mechanism is inherently less secure.
24556
24557
24558
24559 .section "Environment variables" "SECTpipeenv"
24560 .cindex "&(pipe)& transport" "environment for command"
24561 .cindex "environment" "&(pipe)& transport"
24562 The environment variables listed below are set up when the command is invoked.
24563 This list is a compromise for maximum compatibility with other MTAs. Note that
24564 the &%environment%& option can be used to add additional variables to this
24565 environment. The environment for the &(pipe)& transport is not subject
24566 to the &%add_environment%& and &%keep_environment%& main config options.
24567 .display
24568 &`DOMAIN            `&   the domain of the address
24569 &`HOME              `&   the home directory, if set
24570 &`HOST              `&   the host name when called from a router (see below)
24571 &`LOCAL_PART        `&   see below
24572 &`LOCAL_PART_PREFIX `&   see below
24573 &`LOCAL_PART_SUFFIX `&   see below
24574 &`LOGNAME           `&   see below
24575 &`MESSAGE_ID        `&   Exim's local ID for the message
24576 &`PATH              `&   as specified by the &%path%& option below
24577 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24578 &`RECIPIENT         `&   the complete recipient address
24579 &`SENDER            `&   the sender of the message (empty if a bounce)
24580 &`SHELL             `&   &`/bin/sh`&
24581 &`TZ                `&   the value of the &%timezone%& option, if set
24582 &`USER              `&   see below
24583 .endd
24584 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24585 router, LOCAL_PART is set to the local part of the address. When it is
24586 called as a result of a forward or alias expansion, LOCAL_PART is set to
24587 the local part of the address that was expanded. In both cases, any affixes are
24588 removed from the local part, and made available in LOCAL_PART_PREFIX and
24589 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24590 same value as LOCAL_PART for compatibility with other MTAs.
24591
24592 .cindex "HOST"
24593 HOST is set only when a &(pipe)& transport is called from a router that
24594 associates hosts with an address, typically when using &(pipe)& as a
24595 pseudo-remote transport. HOST is set to the first host name specified by
24596 the router.
24597
24598 .cindex "HOME"
24599 If the transport's generic &%home_directory%& option is set, its value is used
24600 for the HOME environment variable. Otherwise, a home directory may be set
24601 by the router's &%transport_home_directory%& option, which defaults to the
24602 user's home directory if &%check_local_user%& is set.
24603
24604
24605 .section "Private options for pipe" "SECID142"
24606 .cindex "options" "&(pipe)& transport"
24607
24608
24609
24610 .option allow_commands pipe "string list&!!" unset
24611 .cindex "&(pipe)& transport" "permitted commands"
24612 The string is expanded, and is then interpreted as a colon-separated list of
24613 permitted commands. If &%restrict_to_path%& is not set, the only commands
24614 permitted are those in the &%allow_commands%& list. They need not be absolute
24615 paths; the &%path%& option is still used for relative paths. If
24616 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24617 in the &%allow_commands%& list, or a name without any slashes that is found on
24618 the path. In other words, if neither &%allow_commands%& nor
24619 &%restrict_to_path%& is set, there is no restriction on the command, but
24620 otherwise only commands that are permitted by one or the other are allowed. For
24621 example, if
24622 .code
24623 allow_commands = /usr/bin/vacation
24624 .endd
24625 and &%restrict_to_path%& is not set, the only permitted command is
24626 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24627 &%use_shell%& is set.
24628
24629
24630 .option batch_id pipe string&!! unset
24631 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24632
24633
24634 .option batch_max pipe integer 1
24635 This limits the number of addresses that can be handled in a single delivery.
24636 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24637
24638
24639 .option check_string pipe string unset
24640 As &(pipe)& writes the message, the start of each line is tested for matching
24641 &%check_string%&, and if it does, the initial matching characters are replaced
24642 by the contents of &%escape_string%&, provided both are set. The value of
24643 &%check_string%& is a literal string, not a regular expression, and the case of
24644 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24645 of &%check_string%& and &%escape_string%& are forced to values that implement
24646 the SMTP escaping protocol. Any settings made in the configuration file are
24647 ignored.
24648
24649
24650 .option command pipe string&!! unset
24651 This option need not be set when &(pipe)& is being used to deliver to pipes
24652 obtained directly from address redirections. In other cases, the option must be
24653 set, to provide a command to be run. It need not yield an absolute path (see
24654 the &%path%& option below). The command is split up into separate arguments by
24655 Exim, and each argument is separately expanded, as described in section
24656 &<<SECThowcommandrun>>& above.
24657
24658
24659 .option environment pipe string&!! unset
24660 .cindex "&(pipe)& transport" "environment for command"
24661 .cindex "environment" "&(pipe)& transport"
24662 This option is used to add additional variables to the environment in which the
24663 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24664 a string which is expanded, and then interpreted as a colon-separated list of
24665 environment settings of the form <&'name'&>=<&'value'&>.
24666
24667
24668 .option escape_string pipe string unset
24669 See &%check_string%& above.
24670
24671
24672 .option freeze_exec_fail pipe boolean false
24673 .cindex "exec failure"
24674 .cindex "failure of exec"
24675 .cindex "&(pipe)& transport" "failure of exec"
24676 Failure to exec the command in a pipe transport is by default treated like
24677 any other failure while running the command. However, if &%freeze_exec_fail%&
24678 is set, failure to exec is treated specially, and causes the message to be
24679 frozen, whatever the setting of &%ignore_status%&.
24680
24681
24682 .option freeze_signal pipe boolean false
24683 .cindex "signal exit"
24684 .cindex "&(pipe)& transport", "signal exit"
24685 Normally if the process run by a command in a pipe transport exits on a signal,
24686 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24687 frozen in Exim's queue instead.
24688
24689
24690 .option force_command pipe boolean false
24691 .cindex "force command"
24692 .cindex "&(pipe)& transport", "force command"
24693 Normally when a router redirects an address directly to a pipe command
24694 the &%command%& option on the transport is ignored.  If &%force_command%&
24695 is set, the &%command%& option will used. This is especially
24696 useful for forcing a wrapper or additional argument to be added to the
24697 command. For example:
24698 .code
24699 command = /usr/bin/remote_exec myhost -- $address_pipe
24700 force_command
24701 .endd
24702
24703 Note that &$address_pipe$& is handled specially in &%command%& when
24704 &%force_command%& is set, expanding out to the original argument vector as
24705 separate items, similarly to a Unix shell &`"$@"`& construct.
24706
24707
24708 .option ignore_status pipe boolean false
24709 If this option is true, the status returned by the subprocess that is set up to
24710 run the command is ignored, and Exim behaves as if zero had been returned.
24711 Otherwise, a non-zero status or termination by signal causes an error return
24712 from the transport unless the status value is one of those listed in
24713 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24714
24715 &*Note*&: This option does not apply to timeouts, which do not return a status.
24716 See the &%timeout_defer%& option for how timeouts are handled.
24717
24718
24719 .option log_defer_output pipe boolean false
24720 .cindex "&(pipe)& transport" "logging output"
24721 If this option is set, and the status returned by the command is
24722 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24723 and any output was produced on stdout or stderr, the first line of it is
24724 written to the main log.
24725
24726
24727 .option log_fail_output pipe boolean false
24728 If this option is set, and the command returns any output on stdout or
24729 stderr, and also ends with a return code that is neither zero nor one of
24730 the return codes listed in &%temp_errors%& (that is, the delivery
24731 failed), the first line of output is written to the main log. This
24732 option and &%log_output%& are mutually exclusive.  Only one of them may
24733 be set.
24734
24735
24736 .option log_output pipe boolean false
24737 If this option is set and the command returns any output on stdout or
24738 stderr, the first line of output is written to the main log, whatever
24739 the return code. This option and &%log_fail_output%& are mutually
24740 exclusive. Only one of them may be set.
24741
24742
24743 .option max_output pipe integer 20K
24744 This specifies the maximum amount of output that the command may produce on its
24745 standard output and standard error file combined. If the limit is exceeded, the
24746 process running the command is killed. This is intended as a safety measure to
24747 catch runaway processes. The limit is applied independently of the settings of
24748 the options that control what is done with such output (for example,
24749 &%return_output%&). Because of buffering effects, the amount of output may
24750 exceed the limit by a small amount before Exim notices.
24751
24752
24753 .option message_prefix pipe string&!! "see below"
24754 The string specified here is expanded and output at the start of every message.
24755 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24756 .code
24757 message_prefix = \
24758   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24759   ${tod_bsdinbox}\n
24760 .endd
24761 .cindex "Cyrus"
24762 .cindex "&%tmail%&"
24763 .cindex "&""From""& line"
24764 This is required by the commonly used &_/usr/bin/vacation_& program.
24765 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24766 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24767 setting
24768 .code
24769 message_prefix =
24770 .endd
24771 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24772 &`\n`& to &`\r\n`& in &%message_prefix%&.
24773
24774
24775 .option message_suffix pipe string&!! "see below"
24776 The string specified here is expanded and output at the end of every message.
24777 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24778 The suffix can be suppressed by setting
24779 .code
24780 message_suffix =
24781 .endd
24782 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24783 &`\n`& to &`\r\n`& in &%message_suffix%&.
24784
24785
24786 .option path pipe string&!! "/bin:/usr/bin"
24787 This option is expanded and
24788 specifies the string that is set up in the PATH environment
24789 variable of the subprocess.
24790 If the &%command%& option does not yield an absolute path name, the command is
24791 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24792 apply to a command specified as a transport filter.
24793
24794
24795 .option permit_coredump pipe boolean false
24796 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24797 a core-dump of a pipe command, enable this command.  This enables core-dumps
24798 during delivery and affects both the Exim binary and the pipe command run.
24799 It is recommended that this option remain off unless and until you have a need
24800 for it and that this only be enabled when needed, as the risk of excessive
24801 resource consumption can be quite high.  Note also that Exim is typically
24802 installed as a setuid binary and most operating systems will inhibit coredumps
24803 of these by default, so further OS-specific action may be required.
24804
24805
24806 .option pipe_as_creator pipe boolean false
24807 .cindex "uid (user id)" "local delivery"
24808 If the generic &%user%& option is not set and this option is true, the delivery
24809 process is run under the uid that was in force when Exim was originally called
24810 to accept the message. If the group id is not otherwise set (via the generic
24811 &%group%& option), the gid that was in force when Exim was originally called to
24812 accept the message is used.
24813
24814
24815 .option restrict_to_path pipe boolean false
24816 When this option is set, any command name not listed in &%allow_commands%& must
24817 contain no slashes. The command is searched for only in the directories listed
24818 in the &%path%& option. This option is intended for use in the case when a pipe
24819 command has been generated from a user's &_.forward_& file. This is usually
24820 handled by a &(pipe)& transport called &%address_pipe%&.
24821
24822
24823 .option return_fail_output pipe boolean false
24824 If this option is true, and the command produced any output and ended with a
24825 return code other than zero or one of the codes listed in &%temp_errors%& (that
24826 is, the delivery failed), the output is returned in the bounce message.
24827 However, if the message has a null sender (that is, it is itself a bounce
24828 message), output from the command is discarded. This option and
24829 &%return_output%& are mutually exclusive. Only one of them may be set.
24830
24831
24832
24833 .option return_output pipe boolean false
24834 If this option is true, and the command produced any output, the delivery is
24835 deemed to have failed whatever the return code from the command, and the output
24836 is returned in the bounce message. Otherwise, the output is just discarded.
24837 However, if the message has a null sender (that is, it is a bounce message),
24838 output from the command is always discarded, whatever the setting of this
24839 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24840 of them may be set.
24841
24842
24843
24844 .option temp_errors pipe "string list" "see below"
24845 .cindex "&(pipe)& transport" "temporary failure"
24846 This option contains either a colon-separated list of numbers, or a single
24847 asterisk. If &%ignore_status%& is false
24848 and &%return_output%& is not set,
24849 and the command exits with a non-zero return code, the failure is treated as
24850 temporary and the delivery is deferred if the return code matches one of the
24851 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24852 codes are treated as permanent errors. The default setting contains the codes
24853 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24854 compiled on a system that does not define these macros, it assumes values of 75
24855 and 73, respectively.
24856
24857
24858 .option timeout pipe time 1h
24859 If the command fails to complete within this time, it is killed. This normally
24860 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24861 specifies no timeout. In order to ensure that any subprocesses created by the
24862 command are also killed, Exim makes the initial process a process group leader,
24863 and kills the whole process group on a timeout. However, this can be defeated
24864 if one of the processes starts a new process group.
24865
24866 .option timeout_defer pipe boolean false
24867 A timeout in a &(pipe)& transport, either in the command that the transport
24868 runs, or in a transport filter that is associated with it, is by default
24869 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24870 is set true, both kinds of timeout become temporary errors, causing the
24871 delivery to be deferred.
24872
24873 .option umask pipe "octal integer" 022
24874 This specifies the umask setting for the subprocess that runs the command.
24875
24876
24877 .option use_bsmtp pipe boolean false
24878 .cindex "envelope sender"
24879 If this option is set true, the &(pipe)& transport writes messages in &"batch
24880 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24881 commands. If you want to include a leading HELO command with such messages,
24882 you can do so by setting the &%message_prefix%& option. See section
24883 &<<SECTbatchSMTP>>& for details of batch SMTP.
24884
24885 .option use_classresources pipe boolean false
24886 .cindex "class resources (BSD)"
24887 This option is available only when Exim is running on FreeBSD, NetBSD, or
24888 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24889 resource limits when a &(pipe)& transport is run to perform a delivery. The
24890 limits for the uid under which the pipe is to run are obtained from the login
24891 class database.
24892
24893
24894 .option use_crlf pipe boolean false
24895 .cindex "carriage return"
24896 .cindex "linefeed"
24897 This option causes lines to be terminated with the two-character CRLF sequence
24898 (carriage return, linefeed) instead of just a linefeed character. In the case
24899 of batched SMTP, the byte sequence written to the pipe is then an exact image
24900 of what would be sent down a real SMTP connection.
24901
24902 The contents of the &%message_prefix%& and &%message_suffix%& options are
24903 written verbatim, so must contain their own carriage return characters if these
24904 are needed. When &%use_bsmtp%& is not set, the default values for both
24905 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24906 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24907
24908
24909 .option use_shell pipe boolean false
24910 .vindex "&$pipe_addresses$&"
24911 If this option is set, it causes the command to be passed to &_/bin/sh_&
24912 instead of being run directly from the transport, as described in section
24913 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24914 where the command is expected to be run under a shell and cannot easily be
24915 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24916 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24917 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24918 its &%-c%& option.
24919
24920
24921
24922 .section "Using an external local delivery agent" "SECID143"
24923 .cindex "local delivery" "using an external agent"
24924 .cindex "&'procmail'&"
24925 .cindex "external local delivery"
24926 .cindex "delivery" "&'procmail'&"
24927 .cindex "delivery" "by external agent"
24928 The &(pipe)& transport can be used to pass all messages that require local
24929 delivery to a separate local delivery agent such as &%procmail%&. When doing
24930 this, care must be taken to ensure that the pipe is run under an appropriate
24931 uid and gid. In some configurations one wants this to be a uid that is trusted
24932 by the delivery agent to supply the correct sender of the message. It may be
24933 necessary to recompile or reconfigure the delivery agent so that it trusts an
24934 appropriate user. The following is an example transport and router
24935 configuration for &%procmail%&:
24936 .code
24937 # transport
24938 procmail_pipe:
24939   driver = pipe
24940   command = /usr/local/bin/procmail -d $local_part_data
24941   return_path_add
24942   delivery_date_add
24943   envelope_to_add
24944   check_string = "From "
24945   escape_string = ">From "
24946   umask = 077
24947   user = $local_part_data
24948   group = mail
24949
24950 # router
24951 procmail:
24952   driver = accept
24953   check_local_user
24954   transport = procmail_pipe
24955 .endd
24956 In this example, the pipe is run as the local user, but with the group set to
24957 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24958 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24959 user to supply a correct sender address. If you do not specify either a
24960 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24961 home directory is the user's home directory by default.
24962
24963 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24964 .code
24965 IFS=" "
24966 .endd
24967 as shown in some &%procmail%& documentation, because Exim does not by default
24968 use a shell to run pipe commands.
24969
24970 .cindex "Cyrus"
24971 The next example shows a transport and a router for a system where local
24972 deliveries are handled by the Cyrus IMAP server.
24973 .code
24974 # transport
24975 local_delivery_cyrus:
24976   driver = pipe
24977   command = /usr/cyrus/bin/deliver \
24978             -m ${substr_1:$local_part_suffix} -- $local_part
24979   user = cyrus
24980   group = mail
24981   return_output
24982   log_output
24983   message_prefix =
24984   message_suffix =
24985
24986 # router
24987 local_user_cyrus:
24988   driver = accept
24989   check_local_user
24990   local_part_suffix = .*
24991   transport = local_delivery_cyrus
24992 .endd
24993 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24994 &%return_output%& to cause any text written by Cyrus to be returned to the
24995 sender.
24996 .ecindex IIDpiptra1
24997 .ecindex IIDpiptra2
24998
24999
25000 . ////////////////////////////////////////////////////////////////////////////
25001 . ////////////////////////////////////////////////////////////////////////////
25002
25003 .chapter "The smtp transport" "CHAPsmtptrans"
25004 .scindex IIDsmttra1 "transports" "&(smtp)&"
25005 .scindex IIDsmttra2 "&(smtp)& transport"
25006 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
25007 or LMTP protocol. The list of hosts to try can either be taken from the address
25008 that is being processed (having been set up by the router), or specified
25009 explicitly for the transport. Timeout and retry processing (see chapter
25010 &<<CHAPretry>>&) is applied to each IP address independently.
25011
25012
25013 .section "Multiple messages on a single connection" "SECID144"
25014 The sending of multiple messages over a single TCP/IP connection can arise in
25015 two ways:
25016
25017 .ilist
25018 If a message contains more than &%max_rcpt%& (see below) addresses that are
25019 routed to the same host, more than one copy of the message has to be sent to
25020 that host. In this situation, multiple copies may be sent in a single run of
25021 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
25022 does when it has too many addresses to send in one message also depends on the
25023 value of the global &%remote_max_parallel%& option. Details are given in
25024 section &<<SECToutSMTPTCP>>&.)
25025 .next
25026 .cindex "hints database" "remembering routing"
25027 When a message has been successfully delivered over a TCP/IP connection, Exim
25028 looks in its hints database to see if there are any other messages awaiting a
25029 connection to the same host. If there are, a new delivery process is started
25030 for one of them, and the current TCP/IP connection is passed on to it. The new
25031 process may in turn send multiple copies and possibly create yet another
25032 process.
25033 .endlist
25034
25035
25036 For each copy sent over the same TCP/IP connection, a sequence counter is
25037 incremented, and if it ever gets to the value of &%connection_max_messages%&,
25038 no further messages are sent over that connection.
25039
25040
25041
25042 .section "Use of the $host and $host_address variables" "SECID145"
25043 .vindex "&$host$&"
25044 .vindex "&$host_address$&"
25045 At the start of a run of the &(smtp)& transport, the values of &$host$& and
25046 &$host_address$& are the name and IP address of the first host on the host list
25047 passed by the router. However, when the transport is about to connect to a
25048 specific host, and while it is connected to that host, &$host$& and
25049 &$host_address$& are set to the values for that host. These are the values
25050 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
25051 &%serialize_hosts%&, and the various TLS options are expanded.
25052
25053
25054 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
25055 .vindex &$tls_bits$&
25056 .vindex &$tls_cipher$&
25057 .vindex &$tls_peerdn$&
25058 .vindex &$tls_sni$&
25059 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
25060 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
25061 are the values that were set when the message was received.
25062 These are the values that are used for options that are expanded before any
25063 SMTP connections are made. Just before each connection is made, these four
25064 variables are emptied. If TLS is subsequently started, they are set to the
25065 appropriate values for the outgoing connection, and these are the values that
25066 are in force when any authenticators are run and when the
25067 &%authenticated_sender%& option is expanded.
25068
25069 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
25070 and will be removed in a future release.
25071
25072
25073 .section "Private options for smtp" "SECID146"
25074 .cindex "options" "&(smtp)& transport"
25075 The private options of the &(smtp)& transport are as follows:
25076
25077
25078 .option address_retry_include_sender smtp boolean true
25079 .cindex "4&'xx'& responses" "retrying after"
25080 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
25081 is the combination of sender and recipient that is delayed in subsequent queue
25082 runs until the retry time is reached. You can delay the recipient without
25083 reference to the sender (which is what earlier versions of Exim did), by
25084 setting &%address_retry_include_sender%& false. However, this can lead to
25085 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
25086
25087 .option allow_localhost smtp boolean false
25088 .cindex "local host" "sending to"
25089 .cindex "fallback" "hosts specified on transport"
25090 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
25091 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
25092 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
25093 the delivery anyway. This should be used only in special cases when the
25094 configuration ensures that no looping will result (for example, a differently
25095 configured Exim is listening on the port to which the message is sent).
25096
25097
25098 .option authenticated_sender smtp string&!! unset
25099 .cindex "Cyrus"
25100 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
25101 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
25102 overriding any existing authenticated sender value. If the string expansion is
25103 forced to fail, the option is ignored. Other expansion failures cause delivery
25104 to be deferred. If the result of expansion is an empty string, that is also
25105 ignored.
25106
25107 The expansion happens after the outgoing connection has been made and TLS
25108 started, if required. This means that the &$host$&, &$host_address$&,
25109 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
25110 particular connection.
25111
25112 If the SMTP session is not authenticated, the expansion of
25113 &%authenticated_sender%& still happens (and can cause the delivery to be
25114 deferred if it fails), but no AUTH= item is added to MAIL commands
25115 unless &%authenticated_sender_force%& is true.
25116
25117 This option allows you to use the &(smtp)& transport in LMTP mode to
25118 deliver mail to Cyrus IMAP and provide the proper local part as the
25119 &"authenticated sender"&, via a setting such as:
25120 .code
25121 authenticated_sender = $local_part
25122 .endd
25123 This removes the need for IMAP subfolders to be assigned special ACLs to
25124 allow direct delivery to those subfolders.
25125
25126 Because of expected uses such as that just described for Cyrus (when no
25127 domain is involved), there is no checking on the syntax of the provided
25128 value.
25129
25130
25131 .option authenticated_sender_force smtp boolean false
25132 If this option is set true, the &%authenticated_sender%& option's value
25133 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
25134 authenticated as a client.
25135
25136
25137 .option command_timeout smtp time 5m
25138 .cindex timeout "smtp transport command"
25139 This sets a timeout for receiving a response to an SMTP command that has been
25140 sent out. It is also used when waiting for the initial banner line from the
25141 remote host. Its value must not be zero.
25142
25143
25144 .option connect_timeout smtp time 5m
25145 .cindex timeout "smtp transport connect"
25146 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
25147 to a remote host. A setting of zero allows the system timeout (typically
25148 several minutes) to act. To have any effect, the value of this option must be
25149 less than the system timeout. However, it has been observed that on some
25150 systems there is no system timeout, which is why the default value for this
25151 option is 5 minutes, a value recommended by RFC 1123.
25152
25153
25154 .option connection_max_messages smtp integer 500
25155 .cindex "SMTP" "passed connection"
25156 .cindex "SMTP" "multiple deliveries"
25157 .cindex "multiple SMTP deliveries"
25158 This controls the maximum number of separate message deliveries that are sent
25159 over a single TCP/IP connection. If the value is zero, there is no limit.
25160 For testing purposes, this value can be overridden by the &%-oB%& command line
25161 option.
25162
25163
25164 .option dane_require_tls_ciphers smtp string&!! unset
25165 .cindex "TLS" "requiring specific ciphers for DANE"
25166 .cindex "cipher" "requiring specific"
25167 .cindex DANE "TLS ciphers"
25168 This option may be used to override &%tls_require_ciphers%& for connections
25169 where DANE has been determined to be in effect.
25170 If not set, then &%tls_require_ciphers%& will be used.
25171 Normal SMTP delivery is not able to make strong demands of TLS cipher
25172 configuration, because delivery will fall back to plaintext.  Once DANE has
25173 been determined to be in effect, there is no plaintext fallback and making the
25174 TLS cipherlist configuration stronger will increase security, rather than
25175 counter-intuitively decreasing it.
25176 If the option expands to be empty or is forced to fail, then it will
25177 be treated as unset and &%tls_require_ciphers%& will be used instead.
25178
25179
25180 .option data_timeout smtp time 5m
25181 .cindex timeout "for transmitted SMTP data blocks"
25182 This sets a timeout for the transmission of each block in the data portion of
25183 the message. As a result, the overall timeout for a message depends on the size
25184 of the message. Its value must not be zero. See also &%final_timeout%&.
25185
25186
25187 .option dkim_canon smtp string&!! unset
25188 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25189 .option dkim_domain smtp string list&!! unset
25190 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25191 .option dkim_hash smtp string&!! sha256
25192 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25193 .option dkim_identity smtp string&!! unset
25194 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25195 .option dkim_private_key smtp string&!! unset
25196 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25197 .option dkim_selector smtp string&!! unset
25198 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25199 .option dkim_strict smtp string&!! unset
25200 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25201 .option dkim_sign_headers smtp string&!! "per RFC"
25202 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25203 .option dkim_timestamps smtp string&!! unset
25204 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25205
25206
25207 .option delay_after_cutoff smtp boolean true
25208 .cindex "final cutoff" "retries, controlling"
25209 .cindex retry "final cutoff"
25210 This option controls what happens when all remote IP addresses for a given
25211 domain have been inaccessible for so long that they have passed their retry
25212 cutoff times.
25213
25214 In the default state, if the next retry time has not been reached for any of
25215 them, the address is bounced without trying any deliveries. In other words,
25216 Exim delays retrying an IP address after the final cutoff time until a new
25217 retry time is reached, and can therefore bounce an address without ever trying
25218 a delivery, when machines have been down for a long time. Some people are
25219 unhappy at this prospect, so...
25220
25221 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25222 addresses are past their final cutoff time, Exim tries to deliver to those
25223 IP addresses that have not been tried since the message arrived. If there are
25224 none, of if they all fail, the address is bounced. In other words, it does not
25225 delay when a new message arrives, but immediately tries those expired IP
25226 addresses that haven't been tried since the message arrived. If there is a
25227 continuous stream of messages for the dead hosts, unsetting
25228 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25229 to them.
25230
25231
25232 .option dns_qualify_single smtp boolean true
25233 If the &%hosts%& or &%fallback_hosts%& option is being used,
25234 and the &%gethostbyname%& option is false,
25235 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25236 in chapter &<<CHAPdnslookup>>& for more details.
25237
25238
25239 .option dns_search_parents smtp boolean false
25240 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25241 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25242 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25243 details.
25244
25245
25246 .option dnssec_request_domains smtp "domain list&!!" *
25247 .cindex "MX record" "security"
25248 .cindex "DNSSEC" "MX lookup"
25249 .cindex "security" "MX lookup"
25250 .cindex "DNS" "DNSSEC"
25251 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25252 the DNSSEC request bit set. Setting this transport option is only useful if the
25253 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25254 router option.
25255
25256
25257
25258 .option dnssec_require_domains smtp "domain list&!!" unset
25259 .cindex "MX record" "security"
25260 .cindex "DNSSEC" "MX lookup"
25261 .cindex "security" "MX lookup"
25262 .cindex "DNS" "DNSSEC"
25263 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25264 the DNSSEC request bit set.  Setting this transport option is only
25265 useful if the transport overrides or sets the host names. See the
25266 &%dnssec_require_domains%& router option.
25267
25268
25269
25270 .option dscp smtp string&!! unset
25271 .cindex "DCSP" "outbound"
25272 This option causes the DSCP value associated with a socket to be set to one
25273 of a number of fixed strings or to numeric value.
25274 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25275 Common values include &`throughput`&, &`mincost`&, and on newer systems
25276 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25277
25278 The outbound packets from Exim will be marked with this value in the header
25279 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25280 that these values will have any effect, not be stripped by networking
25281 equipment, or do much of anything without cooperation with your Network
25282 Engineer and those of all network operators between the source and destination.
25283
25284
25285 .option fallback_hosts smtp "string list" unset
25286 .cindex "fallback" "hosts specified on transport"
25287 String expansion is not applied to this option. The argument must be a
25288 colon-separated list of host names or IP addresses, optionally also including
25289 port numbers, though the separator can be changed, as described in section
25290 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25291 item in a &%route_list%& setting for the &(manualroute)& router, as described
25292 in section &<<SECTformatonehostitem>>&.
25293
25294 Fallback hosts can also be specified on routers, which associate them with the
25295 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25296 &%fallback_hosts%& specified on the transport is used only if the address does
25297 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25298 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25299 However, &%hosts_randomize%& does apply to fallback host lists.
25300
25301 If Exim is unable to deliver to any of the hosts for a particular address, and
25302 the errors are not permanent rejections, the address is put on a separate
25303 transport queue with its host list replaced by the fallback hosts, unless the
25304 address was routed via MX records and the current host was in the original MX
25305 list. In that situation, the fallback host list is not used.
25306
25307 Once normal deliveries are complete, the fallback queue is delivered by
25308 re-running the same transports with the new host lists. If several failing
25309 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25310 copy of the message is sent.
25311
25312 The resolution of the host names on the fallback list is controlled by the
25313 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25314 both to cases when the host list comes with the address and when it is taken
25315 from &%hosts%&. This option provides a &"use a smart host only if delivery
25316 fails"& facility.
25317
25318
25319 .option final_timeout smtp time 10m
25320 .cindex timeout "for transmitted SMTP data accept"
25321 This is the timeout that applies while waiting for the response to the final
25322 line containing just &"."& that terminates a message. Its value must not be
25323 zero.
25324
25325 .option gethostbyname smtp boolean false
25326 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25327 being used, names are looked up using &[gethostbyname()]&
25328 (or &[getipnodebyname()]& when available)
25329 instead of using the DNS. Of course, that function may in fact use the DNS, but
25330 it may also consult other sources of information such as &_/etc/hosts_&.
25331
25332 .option gnutls_compat_mode smtp boolean unset
25333 This option controls whether GnuTLS is used in compatibility mode in an Exim
25334 server. This reduces security slightly, but improves interworking with older
25335 implementations of TLS.
25336
25337 .option helo_data smtp string&!! "see below"
25338 .cindex "HELO" "argument, setting"
25339 .cindex "EHLO" "argument, setting"
25340 .cindex "LHLO argument setting"
25341 The value of this option is expanded after a connection to a another host has
25342 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25343 command that starts the outgoing SMTP or LMTP session. The default value of the
25344 option is:
25345 .code
25346 $primary_hostname
25347 .endd
25348 During the expansion, the variables &$host$& and &$host_address$& are set to
25349 the identity of the remote host, and the variables &$sending_ip_address$& and
25350 &$sending_port$& are set to the local IP address and port number that are being
25351 used. These variables can be used to generate different values for different
25352 servers or different local IP addresses. For example, if you want the string
25353 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25354 interface address, you could use this:
25355 .code
25356 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25357   {$primary_hostname}}
25358 .endd
25359 The use of &%helo_data%& applies both to sending messages and when doing
25360 callouts.
25361
25362 .option hosts smtp "string list&!!" unset
25363 Hosts are associated with an address by a router such as &(dnslookup)&, which
25364 finds the hosts by looking up the address domain in the DNS, or by
25365 &(manualroute)&, which has lists of hosts in its configuration. However,
25366 email addresses can be passed to the &(smtp)& transport by any router, and not
25367 all of them can provide an associated list of hosts.
25368
25369 The &%hosts%& option specifies a list of hosts to be used if the address being
25370 processed does not have any hosts associated with it. The hosts specified by
25371 &%hosts%& are also used, whether or not the address has its own hosts, if
25372 &%hosts_override%& is set.
25373
25374 The string is first expanded, before being interpreted as a colon-separated
25375 list of host names or IP addresses, possibly including port numbers. The
25376 separator may be changed to something other than colon, as described in section
25377 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25378 item in a &%route_list%& setting for the &(manualroute)& router, as described
25379 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25380 of the &(manualroute)& router is not available here.
25381
25382 If the expansion fails, delivery is deferred. Unless the failure was caused by
25383 the inability to complete a lookup, the error is logged to the panic log as
25384 well as the main log. Host names are looked up either by searching directly for
25385 address records in the DNS or by calling &[gethostbyname()]& (or
25386 &[getipnodebyname()]& when available), depending on the setting of the
25387 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25388 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25389 address are used.
25390
25391 During delivery, the hosts are tried in order, subject to their retry status,
25392 unless &%hosts_randomize%& is set.
25393
25394
25395 .option hosts_avoid_esmtp smtp "host list&!!" unset
25396 .cindex "ESMTP, avoiding use of"
25397 .cindex "HELO" "forcing use of"
25398 .cindex "EHLO" "avoiding use of"
25399 .cindex "PIPELINING" "avoiding the use of"
25400 This option is for use with broken hosts that announce ESMTP facilities (for
25401 example, PIPELINING) and then fail to implement them properly. When a host
25402 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25403 start of the SMTP session. This means that it cannot use any of the ESMTP
25404 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25405
25406
25407 .option hosts_avoid_pipelining smtp "host list&!!" unset
25408 .cindex "PIPELINING" "avoiding the use of"
25409 .cindex "ESMTP extensions" PIPELINING
25410 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25411 that matches this list, even if the server host advertises PIPELINING support.
25412
25413 .option hosts_pipe_connect smtp "host list&!!" unset
25414 .cindex "pipelining" "early connection"
25415 .cindex "pipelining" PIPE_CONNECT
25416 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25417 this option controls which to hosts the facility watched for
25418 and recorded, and used for subsequent connections.
25419
25420 The retry hints database is used for the record,
25421 and records are subject to the &%retry_data_expire%& option.
25422 When used, the pipelining saves on roundtrip times.
25423 It also turns SMTP into a client-first protocol
25424 so combines well with TCP Fast Open.
25425
25426 See also the &%pipelining_connect_advertise_hosts%& main option.
25427
25428 Note:
25429 When the facility is used, the transport &%helo_data%& option
25430 will be expanded before the &$sending_ip_address$& variable
25431 is filled in.
25432 A check is made for the use of that variable, without the
25433 presence of a &"def:"& test on it, but suitably complex coding
25434 can avoid the check and produce unexpected results.
25435 You have been warned.
25436
25437
25438 .option hosts_avoid_tls smtp "host list&!!" unset
25439 .cindex "TLS" "avoiding for certain hosts"
25440 Exim will not try to start a TLS session when delivering to any host that
25441 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25442
25443 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25444 .cindex "TLS" "avoiding for certain hosts"
25445 Exim will not try to start a TLS session for a verify callout,
25446 or when delivering in cutthrough mode,
25447 to any host that matches this list.
25448
25449
25450 .option hosts_max_try smtp integer 5
25451 .cindex "host" "maximum number to try"
25452 .cindex "limit" "number of hosts tried"
25453 .cindex "limit" "number of MX tried"
25454 .cindex "MX record" "maximum tried"
25455 This option limits the number of IP addresses that are tried for any one
25456 delivery in cases where there are temporary delivery errors. Section
25457 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25458
25459
25460 .option hosts_max_try_hardlimit smtp integer 50
25461 This is an additional check on the maximum number of IP addresses that Exim
25462 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25463 why it exists.
25464
25465
25466
25467 .option hosts_nopass_tls smtp "host list&!!" unset
25468 .cindex "TLS" "passing connection"
25469 .cindex "multiple SMTP deliveries"
25470 .cindex "TLS" "multiple message deliveries"
25471 For any host that matches this list, a connection on which a TLS session has
25472 been started will not be passed to a new delivery process for sending another
25473 message on the same connection. See section &<<SECTmulmessam>>& for an
25474 explanation of when this might be needed.
25475
25476 .option hosts_noproxy_tls smtp "host list&!!" unset
25477 .cindex "TLS" "passing connection"
25478 .cindex "multiple SMTP deliveries"
25479 .cindex "TLS" "multiple message deliveries"
25480 For any host that matches this list, a TLS session which has
25481 been started will not be passed to a new delivery process for sending another
25482 message on the same session.
25483
25484 The traditional implementation closes down TLS and re-starts it in the new
25485 process, on the same open TCP connection, for each successive message
25486 sent.  If permitted by this option a pipe to to the new process is set up
25487 instead, and the original process maintains the TLS connection and proxies
25488 the SMTP connection from and to the new process and any subsequents.
25489 The new process has no access to TLS information, so cannot include it in
25490 logging.
25491
25492
25493
25494 .option hosts_override smtp boolean false
25495 If this option is set and the &%hosts%& option is also set, any hosts that are
25496 attached to the address are ignored, and instead the hosts specified by the
25497 &%hosts%& option are always used. This option does not apply to
25498 &%fallback_hosts%&.
25499
25500
25501 .option hosts_randomize smtp boolean false
25502 .cindex "randomized host list"
25503 .cindex "host" "list of; randomized"
25504 .cindex "fallback" "randomized hosts"
25505 If this option is set, and either the list of hosts is taken from the
25506 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25507 were not obtained from MX records (this includes fallback hosts from the
25508 router), and were not randomized by the router, the order of trying the hosts
25509 is randomized each time the transport runs. Randomizing the order of a host
25510 list can be used to do crude load sharing.
25511
25512 When &%hosts_randomize%& is true, a host list may be split into groups whose
25513 order is separately randomized. This makes it possible to set up MX-like
25514 behaviour. The boundaries between groups are indicated by an item that is just
25515 &`+`& in the host list. For example:
25516 .code
25517 hosts = host1:host2:host3:+:host4:host5
25518 .endd
25519 The order of the first three hosts and the order of the last two hosts is
25520 randomized for each use, but the first three always end up before the last two.
25521 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25522
25523 .option hosts_require_auth smtp "host list&!!" unset
25524 .cindex "authentication" "required by client"
25525 This option provides a list of servers for which authentication must succeed
25526 before Exim will try to transfer a message. If authentication fails for
25527 servers which are not in this list, Exim tries to send unauthenticated. If
25528 authentication fails for one of these servers, delivery is deferred. This
25529 temporary error is detectable in the retry rules, so it can be turned into a
25530 hard failure if required. See also &%hosts_try_auth%&, and chapter
25531 &<<CHAPSMTPAUTH>>& for details of authentication.
25532
25533
25534 .option hosts_request_ocsp smtp "host list&!!" *
25535 .cindex "TLS" "requiring for certain servers"
25536 Exim will request a Certificate Status on a
25537 TLS session for any host that matches this list.
25538 &%tls_verify_certificates%& should also be set for the transport.
25539
25540 .option hosts_require_dane smtp "host list&!!" unset
25541 .cindex DANE "transport options"
25542 .cindex DANE "requiring for certain servers"
25543 If built with DANE support, Exim  will require that a DNSSEC-validated
25544 TLSA record is present for any host matching the list,
25545 and that a DANE-verified TLS connection is made.
25546 There will be no fallback to in-clear communication.
25547 See the &%dnssec_request_domains%& router and transport options.
25548 See section &<<SECDANE>>&.
25549
25550 .option hosts_require_ocsp smtp "host list&!!" unset
25551 .cindex "TLS" "requiring for certain servers"
25552 Exim will request, and check for a valid Certificate Status being given, on a
25553 TLS session for any host that matches this list.
25554 &%tls_verify_certificates%& should also be set for the transport.
25555
25556 .option hosts_require_tls smtp "host list&!!" unset
25557 .cindex "TLS" "requiring for certain servers"
25558 Exim will insist on using a TLS session when delivering to any host that
25559 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25560 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25561 incoming messages, use an appropriate ACL.
25562
25563 .option hosts_try_auth smtp "host list&!!" unset
25564 .cindex "authentication" "optional in client"
25565 This option provides a list of servers to which, provided they announce
25566 authentication support, Exim will attempt to authenticate as a client when it
25567 connects. If authentication fails
25568 .new
25569 and &%hosts_require_auth%& permits,
25570 .wen
25571 Exim will try to transfer the message unauthenticated.
25572 See also chapter &<<CHAPSMTPAUTH>>& for details of authentication.
25573
25574 .option hosts_try_chunking smtp "host list&!!" *
25575 .cindex CHUNKING "enabling, in client"
25576 .cindex BDAT "SMTP command"
25577 .cindex "RFC 3030" "CHUNKING"
25578 This option provides a list of servers to which, provided they announce
25579 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25580 Unless DKIM signing is being done,
25581 BDAT will not be used in conjunction with a transport filter.
25582
25583 .option hosts_try_dane smtp "host list&!!" *
25584 .cindex DANE "transport options"
25585 .cindex DANE "attempting for certain servers"
25586 .new
25587 If built with DANE support, Exim  will look up a
25588 TLSA record for any host matching the list,
25589 If one is found and that lookup was DNSSEC-validated,
25590 then Exim requires that a DANE-verified TLS connection is made for that host;
25591 there will be no fallback to in-clear communication.
25592 .wen
25593 See the &%dnssec_request_domains%& router and transport options.
25594 See section &<<SECDANE>>&.
25595
25596 .option hosts_try_fastopen smtp "host list&!!" *
25597 .cindex "fast open, TCP" "enabling, in client"
25598 .cindex "TCP Fast Open" "enabling, in client"
25599 .cindex "RFC 7413" "TCP Fast Open"
25600 This option provides a list of servers to which, provided
25601 the facility is supported by this system, Exim will attempt to
25602 perform a TCP Fast Open.
25603 No data is sent on the SYN segment but, if the remote server also
25604 supports the facility, it can send its SMTP banner immediately after
25605 the SYN,ACK segment.  This can save up to one round-trip time.
25606
25607 The facility is only active for previously-contacted servers,
25608 as the initiator must present a cookie in the SYN segment.
25609
25610 On (at least some) current Linux distributions the facility must be enabled
25611 in the kernel by the sysadmin before the support is usable.
25612 There is no option for control of the server side; if the system supports
25613 it it is always enabled.  Note that lengthy operations in the connect ACL,
25614 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25615
25616 .option hosts_try_prdr smtp "host list&!!" *
25617 .cindex "PRDR" "enabling, optional in client"
25618 .cindex "ESMTP extensions" PRDR
25619 This option provides a list of servers to which, provided they announce
25620 PRDR support, Exim will attempt to negotiate PRDR
25621 for multi-recipient messages.
25622 The option can usually be left as default.
25623
25624 .option interface smtp "string list&!!" unset
25625 .cindex "bind IP address"
25626 .cindex "IP address" "binding"
25627 .vindex "&$host$&"
25628 .vindex "&$host_address$&"
25629 This option specifies which interface to bind to when making an outgoing SMTP
25630 call. The value is an IP address, not an interface name such as
25631 &`eth0`&. Do not confuse this with the interface address that was used when a
25632 message was received, which is in &$received_ip_address$&, formerly known as
25633 &$interface_address$&. The name was changed to minimize confusion with the
25634 outgoing interface address. There is no variable that contains an outgoing
25635 interface address because, unless it is set by this option, its value is
25636 unknown.
25637
25638 During the expansion of the &%interface%& option the variables &$host$& and
25639 &$host_address$& refer to the host to which a connection is about to be made
25640 during the expansion of the string. Forced expansion failure, or an empty
25641 string result causes the option to be ignored. Otherwise, after expansion, the
25642 string must be a list of IP addresses, colon-separated by default, but the
25643 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25644 For example:
25645 .code
25646 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25647 .endd
25648 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25649 connection. If none of them are the correct type, the option is ignored. If
25650 &%interface%& is not set, or is ignored, the system's IP functions choose which
25651 interface to use if the host has more than one.
25652
25653
25654 .option keepalive smtp boolean true
25655 .cindex "keepalive" "on outgoing connection"
25656 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25657 connections. When set, it causes the kernel to probe idle connections
25658 periodically, by sending packets with &"old"& sequence numbers. The other end
25659 of the connection should send a acknowledgment if the connection is still okay
25660 or a reset if the connection has been aborted. The reason for doing this is
25661 that it has the beneficial effect of freeing up certain types of connection
25662 that can get stuck when the remote host is disconnected without tidying up the
25663 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25664 unreachable hosts.
25665
25666
25667 .option lmtp_ignore_quota smtp boolean false
25668 .cindex "LMTP" "ignoring quota errors"
25669 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25670 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25671 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25672
25673 .option max_rcpt smtp integer 100
25674 .cindex "RCPT" "maximum number of outgoing"
25675 This option limits the number of RCPT commands that are sent in a single
25676 SMTP message transaction. Each set of addresses is treated independently, and
25677 so can cause parallel connections to the same host if &%remote_max_parallel%&
25678 permits this.
25679
25680
25681 .new
25682 .option message_linelength_limit smtp integer 998
25683 .cindex "line length" limit
25684 This option sets the maximum line length, in bytes, that the transport
25685 will send.  Any messages with lines exceeding the given value
25686 will fail and a failure-DSN ("bounce") message will if possible be returned
25687 to the sender.
25688 The default value is that defined by the SMTP standards.
25689
25690 It is generally wise to also check in the data ACL so that messages
25691 received via SMTP can be refused without producing a bounce.
25692 .wen
25693
25694
25695 .option multi_domain smtp boolean&!! true
25696 .vindex "&$domain$&"
25697 When this option is set, the &(smtp)& transport can handle a number of
25698 addresses containing a mixture of different domains provided they all resolve
25699 to the same list of hosts. Turning the option off restricts the transport to
25700 handling only one domain at a time. This is useful if you want to use
25701 &$domain$& in an expansion for the transport, because it is set only when there
25702 is a single domain involved in a remote delivery.
25703
25704 It is expanded per-address and can depend on any of
25705 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25706 &$host$&, &$host_address$& and &$host_port$&.
25707
25708 .new
25709 If the connection is DANE-enabled then this option is ignored;
25710 only messages having the domain used for the DANE TLSA lookup are
25711 sent on the connection.
25712 .wen
25713
25714 .option port smtp string&!! "see below"
25715 .cindex "port" "sending TCP/IP"
25716 .cindex "TCP/IP" "setting outgoing port"
25717 This option specifies the TCP/IP port on the server to which Exim connects.
25718 &*Note:*& Do not confuse this with the port that was used when a message was
25719 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25720 The name was changed to minimize confusion with the outgoing port. There is no
25721 variable that contains an outgoing port.
25722
25723 If the value of this option begins with a digit it is taken as a port number;
25724 otherwise it is looked up using &[getservbyname()]&. The default value is
25725 normally &"smtp"&,
25726 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25727 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25728 If the expansion fails, or if a port number cannot be found, delivery
25729 is deferred.
25730
25731 Note that at least one Linux distribution has been seen failing
25732 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25733
25734
25735
25736 .option protocol smtp string smtp
25737 .cindex "LMTP" "over TCP/IP"
25738 .cindex "ssmtp protocol" "outbound"
25739 .cindex "TLS" "SSL-on-connect outbound"
25740 .vindex "&$port$&"
25741 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25742 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25743 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25744 deliveries into closed message stores. Exim also has support for running LMTP
25745 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25746
25747 If this option is set to &"smtps"&, the default value for the &%port%& option
25748 changes to &"smtps"&, and the transport initiates TLS immediately after
25749 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25750 The Internet standards bodies used to strongly discourage use of this mode,
25751 but as of RFC 8314 it is preferred over STARTTLS for message submission
25752 (as distinct from MTA-MTA communication).
25753
25754
25755 .option retry_include_ip_address smtp boolean&!! true
25756 Exim normally includes both the host name and the IP address in the key it
25757 constructs for indexing retry data after a temporary delivery failure. This
25758 means that when one of several IP addresses for a host is failing, it gets
25759 tried periodically (controlled by the retry rules), but use of the other IP
25760 addresses is not affected.
25761
25762 However, in some dialup environments hosts are assigned a different IP address
25763 each time they connect. In this situation the use of the IP address as part of
25764 the retry key leads to undesirable behaviour. Setting this option false causes
25765 Exim to use only the host name.
25766 Since it is expanded it can be made to depend on the host or domain.
25767
25768
25769 .option serialize_hosts smtp "host list&!!" unset
25770 .cindex "serializing connections"
25771 .cindex "host" "serializing connections"
25772 Because Exim operates in a distributed manner, if several messages for the same
25773 host arrive at around the same time, more than one simultaneous connection to
25774 the remote host can occur. This is not usually a problem except when there is a
25775 slow link between the hosts. In that situation it may be helpful to restrict
25776 Exim to one connection at a time. This can be done by setting
25777 &%serialize_hosts%& to match the relevant hosts.
25778
25779 .cindex "hints database" "serializing deliveries to a host"
25780 Exim implements serialization by means of a hints database in which a record is
25781 written whenever a process connects to one of the restricted hosts. The record
25782 is deleted when the connection is completed. Obviously there is scope for
25783 records to get left lying around if there is a system or program crash. To
25784 guard against this, Exim ignores any records that are more than six hours old.
25785
25786 If you set up this kind of serialization, you should also arrange to delete the
25787 relevant hints database whenever your system reboots. The names of the files
25788 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25789 may be one or two files, depending on the type of DBM in use. The same files
25790 are used for ETRN serialization.
25791
25792 See also the &%max_parallel%& generic transport option.
25793
25794
25795 .option size_addition smtp integer 1024
25796 .cindex "SIZE" "ESMTP extension"
25797 .cindex "message" "size issue for transport filter"
25798 .cindex "size" "of message"
25799 .cindex "transport" "filter"
25800 .cindex "filter" "transport filter"
25801 If a remote SMTP server indicates that it supports the SIZE option of the
25802 MAIL command, Exim uses this to pass over the message size at the start of
25803 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25804 sends, to allow for headers and other text that may be added during delivery by
25805 configuration options or in a transport filter. It may be necessary to increase
25806 this if a lot of text is added to messages.
25807
25808 Alternatively, if the value of &%size_addition%& is set negative, it disables
25809 the use of the SIZE option altogether.
25810
25811
25812 .option socks_proxy smtp string&!! unset
25813 .cindex proxy SOCKS
25814 This option enables use of SOCKS proxies for connections made by the
25815 transport.  For details see section &<<SECTproxySOCKS>>&.
25816
25817
25818 .option tls_certificate smtp string&!! unset
25819 .cindex "TLS" "client certificate, location of"
25820 .cindex "certificate" "client, location of"
25821 .vindex "&$host$&"
25822 .vindex "&$host_address$&"
25823 The value of this option must be the absolute path to a file which contains the
25824 client's certificate, for possible use when sending a message over an encrypted
25825 connection. The values of &$host$& and &$host_address$& are set to the name and
25826 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25827 details of TLS.
25828
25829 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25830 certificate when sending messages as a client. The global option of the same
25831 name specifies the certificate for Exim as a server; it is not automatically
25832 assumed that the same certificate should be used when Exim is operating as a
25833 client.
25834
25835
25836 .option tls_crl smtp string&!! unset
25837 .cindex "TLS" "client certificate revocation list"
25838 .cindex "certificate" "revocation list for client"
25839 This option specifies a certificate revocation list. The expanded value must
25840 be the name of a file that contains a CRL in PEM format.
25841
25842
25843 .option tls_dh_min_bits smtp integer 1024
25844 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25845 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25846 key agreement is negotiated, the server will provide a large prime number
25847 for use.  This option establishes the minimum acceptable size of that number.
25848 If the parameter offered by the server is too small, then the TLS handshake
25849 will fail.
25850
25851 Only supported when using GnuTLS.
25852
25853
25854 .option tls_privatekey smtp string&!! unset
25855 .cindex "TLS" "client private key, location of"
25856 .vindex "&$host$&"
25857 .vindex "&$host_address$&"
25858 The value of this option must be the absolute path to a file which contains the
25859 client's private key. This is used when sending a message over an encrypted
25860 connection using a client certificate. The values of &$host$& and
25861 &$host_address$& are set to the name and address of the server during the
25862 expansion. If this option is unset, or the expansion is forced to fail, or the
25863 result is an empty string, the private key is assumed to be in the same file as
25864 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25865
25866
25867 .option tls_require_ciphers smtp string&!! unset
25868 .cindex "TLS" "requiring specific ciphers"
25869 .cindex "cipher" "requiring specific"
25870 .vindex "&$host$&"
25871 .vindex "&$host_address$&"
25872 The value of this option must be a list of permitted cipher suites, for use
25873 when setting up an outgoing encrypted connection. (There is a global option of
25874 the same name for controlling incoming connections.) The values of &$host$& and
25875 &$host_address$& are set to the name and address of the server during the
25876 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25877 is used in different ways by OpenSSL and GnuTLS (see sections
25878 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25879 ciphers is a preference order.
25880
25881
25882 .new
25883 .option tls_resumption_hosts smtp "host list&!!" unset
25884 .cindex TLS resumption
25885 This option controls which connections to use the TLS resumption feature.
25886 See &<<SECTresumption>>& for details.
25887 .wen
25888
25889
25890
25891 .option tls_sni smtp string&!! unset
25892 .cindex "TLS" "Server Name Indication"
25893 .cindex "TLS" SNI
25894 .cindex SNI "setting in client"
25895 .vindex "&$tls_sni$&"
25896 If this option is set
25897 .new
25898 and the connection is not DANE-validated
25899 .wen
25900 then it sets the $tls_out_sni variable and causes any
25901 TLS session to pass this value as the Server Name Indication extension to
25902 the remote side, which can be used by the remote side to select an appropriate
25903 certificate and private key for the session.
25904
25905 See &<<SECTtlssni>>& for more information.
25906
25907 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25908 TLS extensions.
25909
25910
25911
25912
25913 .option tls_tempfail_tryclear smtp boolean true
25914 .cindex "4&'xx'& responses" "to STARTTLS"
25915 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25916 setting up a TLS session, this option determines whether or not Exim should try
25917 to deliver the message unencrypted. If it is set false, delivery to the
25918 current host is deferred; if there are other hosts, they are tried. If this
25919 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25920 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25921 TLS negotiation fails, Exim closes the current connection (because it is in an
25922 unknown state), opens a new one to the same host, and then tries the delivery
25923 in clear.
25924
25925
25926 .option tls_try_verify_hosts smtp "host list&!!" *
25927 .cindex "TLS" "server certificate verification"
25928 .cindex "certificate" "verification of server"
25929 This option gives a list of hosts for which, on encrypted connections,
25930 certificate verification will be tried but need not succeed.
25931 The &%tls_verify_certificates%& option must also be set.
25932 Note that unless the host is in this list
25933 TLS connections will be denied to hosts using self-signed certificates
25934 when &%tls_verify_certificates%& is matched.
25935 The &$tls_out_certificate_verified$& variable is set when
25936 certificate verification succeeds.
25937
25938
25939 .option tls_verify_cert_hostnames smtp "host list&!!" *
25940 .cindex "TLS" "server certificate hostname verification"
25941 .cindex "certificate" "verification of server"
25942 This option give a list of hosts for which,
25943 while verifying the server certificate,
25944 checks will be included on the host name
25945 (note that this will generally be the result of a DNS MX lookup)
25946 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25947 limited to being the initial component of a 3-or-more component FQDN.
25948
25949 There is no equivalent checking on client certificates.
25950
25951
25952 .option tls_verify_certificates smtp string&!! system
25953 .cindex "TLS" "server certificate verification"
25954 .cindex "certificate" "verification of server"
25955 .vindex "&$host$&"
25956 .vindex "&$host_address$&"
25957 The value of this option must be either the
25958 word "system"
25959 or the absolute path to
25960 a file or directory containing permitted certificates for servers,
25961 for use when setting up an encrypted connection.
25962
25963 The "system" value for the option will use a location compiled into the SSL library.
25964 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25965 is taken as empty and an explicit location
25966 must be specified.
25967
25968 The use of a directory for the option value is not available for GnuTLS versions
25969 preceding 3.3.6 and a single file must be used.
25970
25971 With OpenSSL the certificates specified
25972 explicitly
25973 either by file or directory
25974 are added to those given by the system default location.
25975
25976 The values of &$host$& and
25977 &$host_address$& are set to the name and address of the server during the
25978 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25979
25980 For back-compatibility,
25981 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25982 (a single-colon empty list counts as being set)
25983 and certificate verification fails the TLS connection is closed.
25984
25985
25986 .option tls_verify_hosts smtp "host list&!!" unset
25987 .cindex "TLS" "server certificate verification"
25988 .cindex "certificate" "verification of server"
25989 This option gives a list of hosts for which, on encrypted connections,
25990 certificate verification must succeed.
25991 The &%tls_verify_certificates%& option must also be set.
25992 If both this option and &%tls_try_verify_hosts%& are unset
25993 operation is as if this option selected all hosts.
25994
25995 .option utf8_downconvert smtp integer&!! -1
25996 .cindex utf8 "address downconversion"
25997 .cindex i18n "utf8 address downconversion"
25998 If built with internationalization support,
25999 this option controls conversion of UTF-8 in message envelope addresses
26000 to a-label form.
26001 If, after expansion, the value is 1, 0, or -1 then this value overrides
26002 any value previously set for the message.  Otherwise, any previously
26003 set value is used.  To permit use of a previous value,
26004 set this option to an empty string.
26005 For details on the values see section &<<SECTi18nMTA>>&.
26006
26007
26008
26009
26010 .section "How the limits for the number of hosts to try are used" &&&
26011          "SECTvalhosmax"
26012 .cindex "host" "maximum number to try"
26013 .cindex "limit" "hosts; maximum number tried"
26014 There are two options that are concerned with the number of hosts that are
26015 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
26016 &%hosts_max_try_hardlimit%&.
26017
26018
26019 The &%hosts_max_try%& option limits the number of hosts that are tried
26020 for a single delivery. However, despite the term &"host"& in its name, the
26021 option actually applies to each IP address independently. In other words, a
26022 multihomed host is treated as several independent hosts, just as it is for
26023 retrying.
26024
26025 Many of the larger ISPs have multiple MX records which often point to
26026 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
26027 created as a result of routing one of these domains.
26028
26029 Trying every single IP address on such a long list does not seem sensible; if
26030 several at the top of the list fail, it is reasonable to assume there is some
26031 problem that is likely to affect all of them. Roughly speaking, the value of
26032 &%hosts_max_try%& is the maximum number that are tried before deferring the
26033 delivery. However, the logic cannot be quite that simple.
26034
26035 Firstly, IP addresses that are skipped because their retry times have not
26036 arrived do not count, and in addition, addresses that are past their retry
26037 limits are also not counted, even when they are tried. This means that when
26038 some IP addresses are past their retry limits, more than the value of
26039 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
26040 that all IP addresses are considered before timing out an email address (but
26041 see below for an exception).
26042
26043 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
26044 list to see if there is a subsequent host with a different (higher valued) MX.
26045 If there is, that host is considered next, and the current IP address is used
26046 but not counted. This behaviour helps in the case of a domain with a retry rule
26047 that hardly ever delays any hosts, as is now explained:
26048
26049 Consider the case of a long list of hosts with one MX value, and a few with a
26050 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
26051 hosts at the top of the list are tried at first. With the default retry rule,
26052 which specifies increasing retry times, the higher MX hosts are eventually
26053 tried when those at the top of the list are skipped because they have not
26054 reached their retry times.
26055
26056 However, it is common practice to put a fixed short retry time on domains for
26057 large ISPs, on the grounds that their servers are rarely down for very long.
26058 Unfortunately, these are exactly the domains that tend to resolve to long lists
26059 of hosts. The short retry time means that the lowest MX hosts are tried every
26060 time. The attempts may be in a different order because of random sorting, but
26061 without the special MX check, the higher MX hosts would never be tried until
26062 all the lower MX hosts had timed out (which might be several days), because
26063 there are always some lower MX hosts that have reached their retry times. With
26064 the special check, Exim considers at least one IP address from each MX value at
26065 every delivery attempt, even if the &%hosts_max_try%& limit has already been
26066 reached.
26067
26068 The above logic means that &%hosts_max_try%& is not a hard limit, and in
26069 particular, Exim normally eventually tries all the IP addresses before timing
26070 out an email address. When &%hosts_max_try%& was implemented, this seemed a
26071 reasonable thing to do. Recently, however, some lunatic DNS configurations have
26072 been set up with hundreds of IP addresses for some domains. It can
26073 take a very long time indeed for an address to time out in these cases.
26074
26075 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
26076 Exim never tries more than this number of IP addresses; if it hits this limit
26077 and they are all timed out, the email address is bounced, even though not all
26078 possible IP addresses have been tried.
26079 .ecindex IIDsmttra1
26080 .ecindex IIDsmttra2
26081
26082
26083
26084
26085
26086 . ////////////////////////////////////////////////////////////////////////////
26087 . ////////////////////////////////////////////////////////////////////////////
26088
26089 .chapter "Address rewriting" "CHAPrewrite"
26090 .scindex IIDaddrew "rewriting" "addresses"
26091 There are some circumstances in which Exim automatically rewrites domains in
26092 addresses. The two most common are when an address is given without a domain
26093 (referred to as an &"unqualified address"&) or when an address contains an
26094 abbreviated domain that is expanded by DNS lookup.
26095
26096 Unqualified envelope addresses are accepted only for locally submitted
26097 messages, or for messages that are received from hosts matching
26098 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
26099 appropriate. Unqualified addresses in header lines are qualified if they are in
26100 locally submitted messages, or messages from hosts that are permitted to send
26101 unqualified envelope addresses. Otherwise, unqualified addresses in header
26102 lines are neither qualified nor rewritten.
26103
26104 One situation in which Exim does &'not'& automatically rewrite a domain is
26105 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
26106 such a domain should be rewritten using the &"canonical"& name, and some MTAs
26107 do this. The new RFCs do not contain this suggestion.
26108
26109
26110 .section "Explicitly configured address rewriting" "SECID147"
26111 This chapter describes the rewriting rules that can be used in the
26112 main rewrite section of the configuration file, and also in the generic
26113 &%headers_rewrite%& option that can be set on any transport.
26114
26115 Some people believe that configured address rewriting is a Mortal Sin.
26116 Others believe that life is not possible without it. Exim provides the
26117 facility; you do not have to use it.
26118
26119 The main rewriting rules that appear in the &"rewrite"& section of the
26120 configuration file are applied to addresses in incoming messages, both envelope
26121 addresses and addresses in header lines. Each rule specifies the types of
26122 address to which it applies.
26123
26124 Whether or not addresses in header lines are rewritten depends on the origin of
26125 the headers and the type of rewriting. Global rewriting, that is, rewriting
26126 rules from the rewrite section of the configuration file, is applied only to
26127 those headers that were received with the message. Header lines that are added
26128 by ACLs or by a system filter or by individual routers or transports (which
26129 are specific to individual recipient addresses) are not rewritten by the global
26130 rules.
26131
26132 Rewriting at transport time, by means of the &%headers_rewrite%& option,
26133 applies all headers except those added by routers and transports. That is, as
26134 well as the headers that were received with the message, it also applies to
26135 headers that were added by an ACL or a system filter.
26136
26137
26138 In general, rewriting addresses from your own system or domain has some
26139 legitimacy. Rewriting other addresses should be done only with great care and
26140 in special circumstances. The author of Exim believes that rewriting should be
26141 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
26142 Although it can sometimes be used as a routing tool, this is very strongly
26143 discouraged.
26144
26145 There are two commonly encountered circumstances where rewriting is used, as
26146 illustrated by these examples:
26147
26148 .ilist
26149 The company whose domain is &'hitch.fict.example'& has a number of hosts that
26150 exchange mail with each other behind a firewall, but there is only a single
26151 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
26152 &'hitch.fict.example'& when sending mail off-site.
26153 .next
26154 A host rewrites the local parts of its own users so that, for example,
26155 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
26156 .endlist
26157
26158
26159
26160 .section "When does rewriting happen?" "SECID148"
26161 .cindex "rewriting" "timing of"
26162 .cindex "&ACL;" "rewriting addresses in"
26163 Configured address rewriting can take place at several different stages of a
26164 message's processing.
26165
26166 .vindex "&$sender_address$&"
26167 At the start of an ACL for MAIL, the sender address may have been rewritten
26168 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
26169 ordinary rewrite rules have yet been applied. If, however, the sender address
26170 is verified in the ACL, it is rewritten before verification, and remains
26171 rewritten thereafter. The subsequent value of &$sender_address$& is the
26172 rewritten address. This also applies if sender verification happens in a
26173 RCPT ACL. Otherwise, when the sender address is not verified, it is
26174 rewritten as soon as a message's header lines have been received.
26175
26176 .vindex "&$domain$&"
26177 .vindex "&$local_part$&"
26178 Similarly, at the start of an ACL for RCPT, the current recipient's address
26179 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
26180 rewrite rules have yet been applied to it. However, the behaviour is different
26181 from the sender address when a recipient is verified. The address is rewritten
26182 for the verification, but the rewriting is not remembered at this stage. The
26183 value of &$local_part$& and &$domain$& after verification are always the same
26184 as they were before (that is, they contain the unrewritten &-- except for
26185 SMTP-time rewriting &-- address).
26186
26187 As soon as a message's header lines have been received, all the envelope
26188 recipient addresses are permanently rewritten, and rewriting is also applied to
26189 the addresses in the header lines (if configured). This happens before adding
26190 any header lines that were specified in MAIL or RCPT ACLs, and
26191 .cindex "&[local_scan()]& function" "address rewriting; timing of"
26192 before the DATA ACL and &[local_scan()]& functions are run.
26193
26194 When an address is being routed, either for delivery or for verification,
26195 rewriting is applied immediately to child addresses that are generated by
26196 redirection, unless &%no_rewrite%& is set on the router.
26197
26198 .cindex "envelope from"
26199 .cindex "envelope sender" "rewriting at transport time"
26200 .cindex "rewriting" "at transport time"
26201 .cindex "header lines" "rewriting at transport time"
26202 At transport time, additional rewriting of addresses in header lines can be
26203 specified by setting the generic &%headers_rewrite%& option on a transport.
26204 This option contains rules that are identical in form to those in the rewrite
26205 section of the configuration file. They are applied to the original message
26206 header lines and any that were added by ACLs or a system filter. They are not
26207 applied to header lines that are added by routers or the transport.
26208
26209 The outgoing envelope sender can be rewritten by means of the &%return_path%&
26210 transport option. However, it is not possible to rewrite envelope recipients at
26211 transport time.
26212
26213
26214
26215
26216 .section "Testing the rewriting rules that apply on input" "SECID149"
26217 .cindex "rewriting" "testing"
26218 .cindex "testing" "rewriting"
26219 Exim's input rewriting configuration appears in a part of the runtime
26220 configuration file headed by &"begin rewrite"&. It can be tested by the
26221 &%-brw%& command line option. This takes an address (which can be a full RFC
26222 2822 address) as its argument. The output is a list of how the address would be
26223 transformed by the rewriting rules for each of the different places it might
26224 appear in an incoming message, that is, for each different header and for the
26225 envelope sender and recipient fields. For example,
26226 .code
26227 exim -brw ph10@exim.workshop.example
26228 .endd
26229 might produce the output
26230 .code
26231 sender: Philip.Hazel@exim.workshop.example
26232 from: Philip.Hazel@exim.workshop.example
26233 to: ph10@exim.workshop.example
26234 cc: ph10@exim.workshop.example
26235 bcc: ph10@exim.workshop.example
26236 reply-to: Philip.Hazel@exim.workshop.example
26237 env-from: Philip.Hazel@exim.workshop.example
26238 env-to: ph10@exim.workshop.example
26239 .endd
26240 which shows that rewriting has been set up for that address when used in any of
26241 the source fields, but not when it appears as a recipient address. At the
26242 present time, there is no equivalent way of testing rewriting rules that are
26243 set for a particular transport.
26244
26245
26246 .section "Rewriting rules" "SECID150"
26247 .cindex "rewriting" "rules"
26248 The rewrite section of the configuration file consists of lines of rewriting
26249 rules in the form
26250 .display
26251 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26252 .endd
26253 Rewriting rules that are specified for the &%headers_rewrite%& generic
26254 transport option are given as a colon-separated list. Each item in the list
26255 takes the same form as a line in the main rewriting configuration (except that
26256 any colons must be doubled, of course).
26257
26258 The formats of source patterns and replacement strings are described below.
26259 Each is terminated by white space, unless enclosed in double quotes, in which
26260 case normal quoting conventions apply inside the quotes. The flags are single
26261 characters which may appear in any order. Spaces and tabs between them are
26262 ignored.
26263
26264 For each address that could potentially be rewritten, the rules are scanned in
26265 order, and replacements for the address from earlier rules can themselves be
26266 replaced by later rules (but see the &"q"& and &"R"& flags).
26267
26268 The order in which addresses are rewritten is undefined, may change between
26269 releases, and must not be relied on, with one exception: when a message is
26270 received, the envelope sender is always rewritten first, before any header
26271 lines are rewritten. For example, the replacement string for a rewrite of an
26272 address in &'To:'& must not assume that the message's address in &'From:'& has
26273 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26274 that the envelope sender has already been rewritten.
26275
26276 .vindex "&$domain$&"
26277 .vindex "&$local_part$&"
26278 The variables &$local_part$& and &$domain$& can be used in the replacement
26279 string to refer to the address that is being rewritten. Note that lookup-driven
26280 rewriting can be done by a rule of the form
26281 .code
26282 *@*   ${lookup ...
26283 .endd
26284 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26285 refer to the address that is being rewritten.
26286
26287
26288 .section "Rewriting patterns" "SECID151"
26289 .cindex "rewriting" "patterns"
26290 .cindex "address list" "in a rewriting pattern"
26291 The source pattern in a rewriting rule is any item which may appear in an
26292 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26293 single-item address list, which means that it is expanded before being tested
26294 against the address. As always, if you use a regular expression as a pattern,
26295 you must take care to escape dollar and backslash characters, or use the &`\N`&
26296 facility to suppress string expansion within the regular expression.
26297
26298 Domains in patterns should be given in lower case. Local parts in patterns are
26299 case-sensitive. If you want to do case-insensitive matching of local parts, you
26300 can use a regular expression that starts with &`^(?i)`&.
26301
26302 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26303 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26304 depending on the type of match which occurred. These can be used in the
26305 replacement string to insert portions of the incoming address. &$0$& always
26306 refers to the complete incoming address. When a regular expression is used, the
26307 numerical variables are set from its capturing subexpressions. For other types
26308 of pattern they are set as follows:
26309
26310 .ilist
26311 If a local part or domain starts with an asterisk, the numerical variables
26312 refer to the character strings matched by asterisks, with &$1$& associated with
26313 the first asterisk, and &$2$& with the second, if present. For example, if the
26314 pattern
26315 .code
26316 *queen@*.fict.example
26317 .endd
26318 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26319 .code
26320 $0 = hearts-queen@wonderland.fict.example
26321 $1 = hearts-
26322 $2 = wonderland
26323 .endd
26324 Note that if the local part does not start with an asterisk, but the domain
26325 does, it is &$1$& that contains the wild part of the domain.
26326
26327 .next
26328 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26329 of the domain are placed in the next available numerical variables. Suppose,
26330 for example, that the address &'foo@bar.baz.example'& is processed by a
26331 rewriting rule of the form
26332 .display
26333 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26334 .endd
26335 and the key in the file that matches the domain is &`*.baz.example`&. Then
26336 .code
26337 $1 = foo
26338 $2 = bar
26339 $3 = baz.example
26340 .endd
26341 If the address &'foo@baz.example'& is looked up, this matches the same
26342 wildcard file entry, and in this case &$2$& is set to the empty string, but
26343 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26344 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26345 whole domain. For non-partial domain lookups, no numerical variables are set.
26346 .endlist
26347
26348
26349 .section "Rewriting replacements" "SECID152"
26350 .cindex "rewriting" "replacements"
26351 If the replacement string for a rule is a single asterisk, addresses that
26352 match the pattern and the flags are &'not'& rewritten, and no subsequent
26353 rewriting rules are scanned. For example,
26354 .code
26355 hatta@lookingglass.fict.example  *  f
26356 .endd
26357 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26358 &'From:'& headers.
26359
26360 .vindex "&$domain$&"
26361 .vindex "&$local_part$&"
26362 If the replacement string is not a single asterisk, it is expanded, and must
26363 yield a fully qualified address. Within the expansion, the variables
26364 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26365 Any letters they contain retain their original case &-- they are not lower
26366 cased. The numerical variables are set up according to the type of pattern that
26367 matched the address, as described above. If the expansion is forced to fail by
26368 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26369 current rule is abandoned, but subsequent rules may take effect. Any other
26370 expansion failure causes the entire rewriting operation to be abandoned, and an
26371 entry written to the panic log.
26372
26373
26374
26375 .section "Rewriting flags" "SECID153"
26376 There are three different kinds of flag that may appear on rewriting rules:
26377
26378 .ilist
26379 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26380 c, f, h, r, s, t.
26381 .next
26382 A flag that specifies rewriting at SMTP time: S.
26383 .next
26384 Flags that control the rewriting process: Q, q, R, w.
26385 .endlist
26386
26387 For rules that are part of the &%headers_rewrite%& generic transport option,
26388 E, F, T, and S are not permitted.
26389
26390
26391
26392 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26393          "SECID154"
26394 .cindex "rewriting" "flags"
26395 If none of the following flag letters, nor the &"S"& flag (see section
26396 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26397 and to both the sender and recipient fields of the envelope, whereas a
26398 transport-time rewriting rule just applies to all headers. Otherwise, the
26399 rewriting rule is skipped unless the relevant addresses are being processed.
26400 .display
26401 &`E`&       rewrite all envelope fields
26402 &`F`&       rewrite the envelope From field
26403 &`T`&       rewrite the envelope To field
26404 &`b`&       rewrite the &'Bcc:'& header
26405 &`c`&       rewrite the &'Cc:'& header
26406 &`f`&       rewrite the &'From:'& header
26407 &`h`&       rewrite all headers
26408 &`r`&       rewrite the &'Reply-To:'& header
26409 &`s`&       rewrite the &'Sender:'& header
26410 &`t`&       rewrite the &'To:'& header
26411 .endd
26412 "All headers" means all of the headers listed above that can be selected
26413 individually, plus their &'Resent-'& versions. It does not include
26414 other headers such as &'Subject:'& etc.
26415
26416 You should be particularly careful about rewriting &'Sender:'& headers, and
26417 restrict this to special known cases in your own domains.
26418
26419
26420 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26421 .cindex "SMTP" "rewriting malformed addresses"
26422 .cindex "RCPT" "rewriting argument of"
26423 .cindex "MAIL" "rewriting argument of"
26424 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26425 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26426 before any other processing; even before syntax checking. The pattern is
26427 required to be a regular expression, and it is matched against the whole of the
26428 data for the command, including any surrounding angle brackets.
26429
26430 .vindex "&$domain$&"
26431 .vindex "&$local_part$&"
26432 This form of rewrite rule allows for the handling of addresses that are not
26433 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26434 input). Because the input is not required to be a syntactically valid address,
26435 the variables &$local_part$& and &$domain$& are not available during the
26436 expansion of the replacement string. The result of rewriting replaces the
26437 original address in the MAIL or RCPT command.
26438
26439
26440 .section "Flags controlling the rewriting process" "SECID155"
26441 There are four flags which control the way the rewriting process works. These
26442 take effect only when a rule is invoked, that is, when the address is of the
26443 correct type (matches the flags) and matches the pattern:
26444
26445 .ilist
26446 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26447 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26448 absence of &"Q"& the rewritten address must always include a domain.
26449 .next
26450 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26451 even if no rewriting actually takes place because of a &"fail"& in the
26452 expansion. The &"q"& flag is not effective if the address is of the wrong type
26453 (does not match the flags) or does not match the pattern.
26454 .next
26455 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26456 address, up to ten times. It can be combined with the &"q"& flag, to stop
26457 rewriting once it fails to match (after at least one successful rewrite).
26458 .next
26459 .cindex "rewriting" "whole addresses"
26460 When an address in a header is rewritten, the rewriting normally applies only
26461 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26462 left unchanged. For example, rewriting might change
26463 .code
26464 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26465 .endd
26466 into
26467 .code
26468 From: Ford Prefect <prefectf@hitch.fict.example>
26469 .endd
26470 .cindex "RFC 2047"
26471 Sometimes there is a need to replace the whole address item, and this can be
26472 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26473 causes an address in a header line to be rewritten, the entire address is
26474 replaced, not just the working part. The replacement must be a complete RFC
26475 2822 address, including the angle brackets if necessary. If text outside angle
26476 brackets contains a character whose value is greater than 126 or less than 32
26477 (except for tab), the text is encoded according to RFC 2047. The character set
26478 is taken from &%headers_charset%&, which gets its default at build time.
26479
26480 When the &"w"& flag is set on a rule that causes an envelope address to be
26481 rewritten, all but the working part of the replacement address is discarded.
26482 .endlist
26483
26484
26485 .section "Rewriting examples" "SECID156"
26486 Here is an example of the two common rewriting paradigms:
26487 .code
26488 *@*.hitch.fict.example  $1@hitch.fict.example
26489 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26490                      {$value}fail}@hitch.fict.example bctfrF
26491 .endd
26492 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26493 the string expansion to fail if the lookup does not succeed. In this context it
26494 has the effect of leaving the original address unchanged, but Exim goes on to
26495 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26496 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26497 explicitly, which would cause the rewritten address to be the same as before,
26498 at the cost of a small bit of processing. Not supplying either of these is an
26499 error, since the rewritten address would then contain no local part.
26500
26501 The first example above replaces the domain with a superior, more general
26502 domain. This may not be desirable for certain local parts. If the rule
26503 .code
26504 root@*.hitch.fict.example  *
26505 .endd
26506 were inserted before the first rule, rewriting would be suppressed for the
26507 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26508
26509 Rewriting can be made conditional on a number of tests, by making use of
26510 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26511 messages that originate outside the local host:
26512 .code
26513 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26514                          {$1@hitch.fict.example}fail}"
26515 .endd
26516 The replacement string is quoted in this example because it contains white
26517 space.
26518
26519 .cindex "rewriting" "bang paths"
26520 .cindex "bang paths" "rewriting"
26521 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26522 an address it treats it as an unqualified local part which it qualifies with
26523 the local qualification domain (if the source of the message is local or if the
26524 remote host is permitted to send unqualified addresses). Rewriting can
26525 sometimes be used to handle simple bang paths with a fixed number of
26526 components. For example, the rule
26527 .code
26528 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26529 .endd
26530 rewrites a two-component bang path &'host.name!user'& as the domain address
26531 &'user@host.name'&. However, there is a security implication in using this as
26532 a global rewriting rule for envelope addresses. It can provide a backdoor
26533 method for using your system as a relay, because the incoming addresses appear
26534 to be local. If the bang path addresses are received via SMTP, it is safer to
26535 use the &"S"& flag to rewrite them as they are received, so that relay checking
26536 can be done on the rewritten addresses.
26537 .ecindex IIDaddrew
26538
26539
26540
26541
26542
26543 . ////////////////////////////////////////////////////////////////////////////
26544 . ////////////////////////////////////////////////////////////////////////////
26545
26546 .chapter "Retry configuration" "CHAPretry"
26547 .scindex IIDretconf1 "retry" "configuration, description of"
26548 .scindex IIDregconf2 "configuration file" "retry section"
26549 The &"retry"& section of the runtime configuration file contains a list of
26550 retry rules that control how often Exim tries to deliver messages that cannot
26551 be delivered at the first attempt. If there are no retry rules (the section is
26552 empty or not present), there are no retries. In this situation, temporary
26553 errors are treated as permanent. The default configuration contains a single,
26554 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26555 line option can be used to test which retry rule will be used for a given
26556 address, domain and error.
26557
26558 The most common cause of retries is temporary failure to deliver to a remote
26559 host because the host is down, or inaccessible because of a network problem.
26560 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26561 address) basis, not on a per-message basis. Thus, if one message has recently
26562 been delayed, delivery of a new message to the same host is not immediately
26563 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26564 log selector is set, the message
26565 .cindex "retry" "time not reached"
26566 &"retry time not reached"& is written to the main log whenever a delivery is
26567 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26568 the handling of errors during remote deliveries.
26569
26570 Retry processing applies to routing as well as to delivering, except as covered
26571 in the next paragraph. The retry rules do not distinguish between these
26572 actions. It is not possible, for example, to specify different behaviour for
26573 failures to route the domain &'snark.fict.example'& and failures to deliver to
26574 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26575 added complication, so did not implement it. However, although they share the
26576 same retry rule, the actual retry times for routing and transporting a given
26577 domain are maintained independently.
26578
26579 When a delivery is not part of a queue run (typically an immediate delivery on
26580 receipt of a message), the routers are always run, and local deliveries are
26581 always attempted, even if retry times are set for them. This makes for better
26582 behaviour if one particular message is causing problems (for example, causing
26583 quota overflow, or provoking an error in a filter file). If such a delivery
26584 suffers a temporary failure, the retry data is updated as normal, and
26585 subsequent delivery attempts from queue runs occur only when the retry time for
26586 the local address is reached.
26587
26588 .section "Changing retry rules" "SECID157"
26589 If you change the retry rules in your configuration, you should consider
26590 whether or not to delete the retry data that is stored in Exim's spool area in
26591 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26592 always safe; that is why they are called &"hints"&.
26593
26594 The hints retry data contains suggested retry times based on the previous
26595 rules. In the case of a long-running problem with a remote host, it might
26596 record the fact that the host has timed out. If your new rules increase the
26597 timeout time for such a host, you should definitely remove the old retry data
26598 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26599 messages that it should now be retaining.
26600
26601
26602
26603 .section "Format of retry rules" "SECID158"
26604 .cindex "retry" "rules"
26605 Each retry rule occupies one line and consists of three or four parts,
26606 separated by white space: a pattern, an error name, an optional list of sender
26607 addresses, and a list of retry parameters. The pattern and sender lists must be
26608 enclosed in double quotes if they contain white space. The rules are searched
26609 in order until one is found where the pattern, error name, and sender list (if
26610 present) match the failing host or address, the error that occurred, and the
26611 message's sender, respectively.
26612
26613
26614 The pattern is any single item that may appear in an address list (see section
26615 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26616 which means that it is expanded before being tested against the address that
26617 has been delayed. A negated address list item is permitted. Address
26618 list processing treats a plain domain name as if it were preceded by &"*@"&,
26619 which makes it possible for many retry rules to start with just a domain. For
26620 example,
26621 .code
26622 lookingglass.fict.example        *  F,24h,30m;
26623 .endd
26624 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26625 whereas
26626 .code
26627 alice@lookingglass.fict.example  *  F,24h,30m;
26628 .endd
26629 applies only to temporary failures involving the local part &%alice%&.
26630 In practice, almost all rules start with a domain name pattern without a local
26631 part.
26632
26633 .cindex "regular expressions" "in retry rules"
26634 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26635 must match a complete address, not just a domain, because that is how regular
26636 expressions work in address lists.
26637 .display
26638 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26639 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26640 .endd
26641
26642
26643 .section "Choosing which retry rule to use for address errors" "SECID159"
26644 When Exim is looking for a retry rule after a routing attempt has failed (for
26645 example, after a DNS timeout), each line in the retry configuration is tested
26646 against the complete address only if &%retry_use_local_part%& is set for the
26647 router. Otherwise, only the domain is used, except when matching against a
26648 regular expression, when the local part of the address is replaced with &"*"&.
26649 A domain on its own can match a domain pattern, or a pattern that starts with
26650 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26651 &%check_local_user%& is true, and false for other routers.
26652
26653 Similarly, when Exim is looking for a retry rule after a local delivery has
26654 failed (for example, after a mailbox full error), each line in the retry
26655 configuration is tested against the complete address only if
26656 &%retry_use_local_part%& is set for the transport (it defaults true for all
26657 local transports).
26658
26659 .cindex "4&'xx'& responses" "retry rules for"
26660 However, when Exim is looking for a retry rule after a remote delivery attempt
26661 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26662 whole address is always used as the key when searching the retry rules. The
26663 rule that is found is used to create a retry time for the combination of the
26664 failing address and the message's sender. It is the combination of sender and
26665 recipient that is delayed in subsequent queue runs until its retry time is
26666 reached. You can delay the recipient without regard to the sender by setting
26667 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26668 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26669 commands.
26670
26671
26672
26673 .section "Choosing which retry rule to use for host and message errors" &&&
26674          "SECID160"
26675 For a temporary error that is not related to an individual address (for
26676 example, a connection timeout), each line in the retry configuration is checked
26677 twice. First, the name of the remote host is used as a domain name (preceded by
26678 &"*@"& when matching a regular expression). If this does not match the line,
26679 the domain from the email address is tried in a similar fashion. For example,
26680 suppose the MX records for &'a.b.c.example'& are
26681 .code
26682 a.b.c.example  MX  5  x.y.z.example
26683                MX  6  p.q.r.example
26684                MX  7  m.n.o.example
26685 .endd
26686 and the retry rules are
26687 .code
26688 p.q.r.example    *      F,24h,30m;
26689 a.b.c.example    *      F,4d,45m;
26690 .endd
26691 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26692 first rule matches neither the host nor the domain, so Exim looks at the second
26693 rule. This does not match the host, but it does match the domain, so it is used
26694 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26695 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26696 first retry rule is used, because it matches the host.
26697
26698 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26699 first rule to determine retry times, but for all the other hosts for the domain
26700 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26701 routing to &'a.b.c.example'& suffers a temporary failure.
26702
26703 &*Note*&: The host name is used when matching the patterns, not its IP address.
26704 However, if a message is routed directly to an IP address without the use of a
26705 host name, for example, if a &(manualroute)& router contains a setting such as:
26706 .code
26707 route_list = *.a.example  192.168.34.23
26708 .endd
26709 then the &"host name"& that is used when searching for a retry rule is the
26710 textual form of the IP address.
26711
26712 .section "Retry rules for specific errors" "SECID161"
26713 .cindex "retry" "specific errors; specifying"
26714 The second field in a retry rule is the name of a particular error, or an
26715 asterisk, which matches any error. The errors that can be tested for are:
26716
26717 .vlist
26718 .vitem &%auth_failed%&
26719 Authentication failed when trying to send to a host in the
26720 &%hosts_require_auth%& list in an &(smtp)& transport.
26721
26722 .vitem &%data_4xx%&
26723 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26724 after the command, or after sending the message's data.
26725
26726 .vitem &%mail_4xx%&
26727 A 4&'xx'& error was received for an outgoing MAIL command.
26728
26729 .vitem &%rcpt_4xx%&
26730 A 4&'xx'& error was received for an outgoing RCPT command.
26731 .endlist
26732
26733 For the three 4&'xx'& errors, either the first or both of the x's can be given
26734 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26735 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26736 and have retries every ten minutes with a one-hour timeout, you could set up a
26737 retry rule of this form:
26738 .code
26739 the.domain.name  rcpt_452   F,1h,10m
26740 .endd
26741 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26742 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26743
26744 .vlist
26745 .vitem &%lost_connection%&
26746 A server unexpectedly closed the SMTP connection. There may, of course,
26747 legitimate reasons for this (host died, network died), but if it repeats a lot
26748 for the same host, it indicates something odd.
26749
26750 .vitem &%lookup%&
26751 A DNS lookup for a host failed.
26752 Note that a &%dnslookup%& router will need to have matched
26753 its &%fail_defer_domains%& option for this retry type to be usable.
26754 Also note that a &%manualroute%& router will probably need
26755 its &%host_find_failed%& option set to &%defer%&.
26756
26757 .vitem &%refused_MX%&
26758 A connection to a host obtained from an MX record was refused.
26759
26760 .vitem &%refused_A%&
26761 A connection to a host not obtained from an MX record was refused.
26762
26763 .vitem &%refused%&
26764 A connection was refused.
26765
26766 .vitem &%timeout_connect_MX%&
26767 A connection attempt to a host obtained from an MX record timed out.
26768
26769 .vitem &%timeout_connect_A%&
26770 A connection attempt to a host not obtained from an MX record timed out.
26771
26772 .vitem &%timeout_connect%&
26773 A connection attempt timed out.
26774
26775 .vitem &%timeout_MX%&
26776 There was a timeout while connecting or during an SMTP session with a host
26777 obtained from an MX record.
26778
26779 .vitem &%timeout_A%&
26780 There was a timeout while connecting or during an SMTP session with a host not
26781 obtained from an MX record.
26782
26783 .vitem &%timeout%&
26784 There was a timeout while connecting or during an SMTP session.
26785
26786 .vitem &%tls_required%&
26787 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26788 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26789 to STARTTLS, or there was a problem setting up the TLS connection.
26790
26791 .vitem &%quota%&
26792 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26793 transport.
26794
26795 .vitem &%quota_%&<&'time'&>
26796 .cindex "quota" "error testing in retry rule"
26797 .cindex "retry" "quota error testing"
26798 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26799 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26800 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26801 for four days.
26802 .endlist
26803
26804 .cindex "mailbox" "time of last read"
26805 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26806 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26807 it should be based on the last time that the user accessed the mailbox.
26808 However, it is not always possible to determine this. Exim uses the following
26809 heuristic rules:
26810
26811 .ilist
26812 If the mailbox is a single file, the time of last access (the &"atime"&) is
26813 used. As no new messages are being delivered (because the mailbox is over
26814 quota), Exim does not access the file, so this is the time of last user access.
26815 .next
26816 .cindex "maildir format" "time of last read"
26817 For a maildir delivery, the time of last modification of the &_new_&
26818 subdirectory is used. As the mailbox is over quota, no new files are created in
26819 the &_new_& subdirectory, because no new messages are being delivered. Any
26820 change to the &_new_& subdirectory is therefore assumed to be the result of an
26821 MUA moving a new message to the &_cur_& directory when it is first read. The
26822 time that is used is therefore the last time that the user read a new message.
26823 .next
26824 For other kinds of multi-file mailbox, the time of last access cannot be
26825 obtained, so a retry rule that uses this type of error field is never matched.
26826 .endlist
26827
26828 The quota errors apply both to system-enforced quotas and to Exim's own quota
26829 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26830 when a local delivery is deferred because a partition is full (the ENOSPC
26831 error).
26832
26833
26834
26835 .section "Retry rules for specified senders" "SECID162"
26836 .cindex "retry" "rules; sender-specific"
26837 You can specify retry rules that apply only when the failing message has a
26838 specific sender. In particular, this can be used to define retry rules that
26839 apply only to bounce messages. The third item in a retry rule can be of this
26840 form:
26841 .display
26842 &`senders=`&<&'address list'&>
26843 .endd
26844 The retry timings themselves are then the fourth item. For example:
26845 .code
26846 *   rcpt_4xx   senders=:   F,1h,30m
26847 .endd
26848 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26849 host. If the address list contains white space, it must be enclosed in quotes.
26850 For example:
26851 .code
26852 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26853 .endd
26854 &*Warning*&: This facility can be unhelpful if it is used for host errors
26855 (which do not depend on the recipient). The reason is that the sender is used
26856 only to match the retry rule. Once the rule has been found for a host error,
26857 its contents are used to set a retry time for the host, and this will apply to
26858 all messages, not just those with specific senders.
26859
26860 When testing retry rules using &%-brt%&, you can supply a sender using the
26861 &%-f%& command line option, like this:
26862 .code
26863 exim -f "" -brt user@dom.ain
26864 .endd
26865 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26866 list is never matched.
26867
26868
26869
26870
26871
26872 .section "Retry parameters" "SECID163"
26873 .cindex "retry" "parameters in rules"
26874 The third (or fourth, if a senders list is present) field in a retry rule is a
26875 sequence of retry parameter sets, separated by semicolons. Each set consists of
26876 .display
26877 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26878 .endd
26879 The letter identifies the algorithm for computing a new retry time; the cutoff
26880 time is the time beyond which this algorithm no longer applies, and the
26881 arguments vary the algorithm's action. The cutoff time is measured from the
26882 time that the first failure for the domain (combined with the local part if
26883 relevant) was detected, not from the time the message was received.
26884
26885 .cindex "retry" "algorithms"
26886 .cindex "retry" "fixed intervals"
26887 .cindex "retry" "increasing intervals"
26888 .cindex "retry" "random intervals"
26889 The available algorithms are:
26890
26891 .ilist
26892 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26893 the interval.
26894 .next
26895 &'G'&: retry at geometrically increasing intervals. The first argument
26896 specifies a starting value for the interval, and the second a multiplier, which
26897 is used to increase the size of the interval at each retry.
26898 .next
26899 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26900 retry, the previous interval is multiplied by the factor in order to get a
26901 maximum for the next interval. The minimum interval is the first argument of
26902 the parameter, and an actual interval is chosen randomly between them. Such a
26903 rule has been found to be helpful in cluster configurations when all the
26904 members of the cluster restart at once, and may therefore synchronize their
26905 queue processing times.
26906 .endlist
26907
26908 When computing the next retry time, the algorithm definitions are scanned in
26909 order until one whose cutoff time has not yet passed is reached. This is then
26910 used to compute a new retry time that is later than the current time. In the
26911 case of fixed interval retries, this simply means adding the interval to the
26912 current time. For geometrically increasing intervals, retry intervals are
26913 computed from the rule's parameters until one that is greater than the previous
26914 interval is found. The main configuration variable
26915 .cindex "limit" "retry interval"
26916 .cindex "retry" "interval, maximum"
26917 .oindex "&%retry_interval_max%&"
26918 &%retry_interval_max%& limits the maximum interval between retries. It
26919 cannot be set greater than &`24h`&, which is its default value.
26920
26921 A single remote domain may have a number of hosts associated with it, and each
26922 host may have more than one IP address. Retry algorithms are selected on the
26923 basis of the domain name, but are applied to each IP address independently. If,
26924 for example, a host has two IP addresses and one is unusable, Exim will
26925 generate retry times for it and will not try to use it until its next retry
26926 time comes. Thus the good IP address is likely to be tried first most of the
26927 time.
26928
26929 .cindex "hints database" "use for retrying"
26930 Retry times are hints rather than promises. Exim does not make any attempt to
26931 run deliveries exactly at the computed times. Instead, a queue runner process
26932 starts delivery processes for delayed messages periodically, and these attempt
26933 new deliveries only for those addresses that have passed their next retry time.
26934 If a new message arrives for a deferred address, an immediate delivery attempt
26935 occurs only if the address has passed its retry time. In the absence of new
26936 messages, the minimum time between retries is the interval between queue runner
26937 processes. There is not much point in setting retry times of five minutes if
26938 your queue runners happen only once an hour, unless there are a significant
26939 number of incoming messages (which might be the case on a system that is
26940 sending everything to a smart host, for example).
26941
26942 The data in the retry hints database can be inspected by using the
26943 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26944 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26945 &'exinext'& utility script can be used to find out what the next retry times
26946 are for the hosts associated with a particular mail domain, and also for local
26947 deliveries that have been deferred.
26948
26949
26950 .section "Retry rule examples" "SECID164"
26951 Here are some example retry rules:
26952 .code
26953 alice@wonderland.fict.example quota_5d  F,7d,3h
26954 wonderland.fict.example       quota_5d
26955 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26956 lookingglass.fict.example     *         F,24h,30m;
26957 *                 refused_A   F,2h,20m;
26958 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26959 .endd
26960 The first rule sets up special handling for mail to
26961 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26962 mailbox has not been read for at least 5 days. Retries continue every three
26963 hours for 7 days. The second rule handles over-quota errors for all other local
26964 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26965 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26966 fail are bounced immediately if the mailbox has not been read for at least 5
26967 days.
26968
26969 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26970 happen every 15 minutes for an hour, then with geometrically increasing
26971 intervals until two days have passed since a delivery first failed. After the
26972 first hour there is a delay of one hour, then two hours, then four hours, and
26973 so on (this is a rather extreme example).
26974
26975 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26976 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26977 all other domains, with special action for connection refusal from hosts that
26978 were not obtained from an MX record.
26979
26980 The final rule in a retry configuration should always have asterisks in the
26981 first two fields so as to provide a general catch-all for any addresses that do
26982 not have their own special handling. This example tries every 15 minutes for 2
26983 hours, then with intervals starting at one hour and increasing by a factor of
26984 1.5 up to 16 hours, then every 8 hours up to 5 days.
26985
26986
26987
26988 .section "Timeout of retry data" "SECID165"
26989 .cindex "timeout" "of retry data"
26990 .oindex "&%retry_data_expire%&"
26991 .cindex "hints database" "data expiry"
26992 .cindex "retry" "timeout of data"
26993 Exim timestamps the data that it writes to its retry hints database. When it
26994 consults the data during a delivery it ignores any that is older than the value
26995 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26996 been tried for 7 days, Exim will try to deliver to it immediately a message
26997 arrives, and if that fails, it will calculate a retry time as if it were
26998 failing for the first time.
26999
27000 This improves the behaviour for messages routed to rarely-used hosts such as MX
27001 backups. If such a host was down at one time, and happens to be down again when
27002 Exim tries a month later, using the old retry data would imply that it had been
27003 down all the time, which is not a justified assumption.
27004
27005 If a host really is permanently dead, this behaviour causes a burst of retries
27006 every now and again, but only if messages routed to it are rare. If there is a
27007 message at least once every 7 days the retry data never expires.
27008
27009
27010
27011
27012 .section "Long-term failures" "SECID166"
27013 .cindex "delivery failure, long-term"
27014 .cindex "retry" "after long-term failure"
27015 Special processing happens when an email address has been failing for so long
27016 that the cutoff time for the last algorithm is reached. For example, using the
27017 default retry rule:
27018 .code
27019 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
27020 .endd
27021 the cutoff time is four days. Reaching the retry cutoff is independent of how
27022 long any specific message has been failing; it is the length of continuous
27023 failure for the recipient address that counts.
27024
27025 When the cutoff time is reached for a local delivery, or for all the IP
27026 addresses associated with a remote delivery, a subsequent delivery failure
27027 causes Exim to give up on the address, and a bounce message is generated.
27028 In order to cater for new messages that use the failing address, a next retry
27029 time is still computed from the final algorithm, and is used as follows:
27030
27031 For local deliveries, one delivery attempt is always made for any subsequent
27032 messages. If this delivery fails, the address fails immediately. The
27033 post-cutoff retry time is not used.
27034
27035 .cindex "final cutoff" "retries, controlling"
27036 .cindex retry "final cutoff"
27037 If the delivery is remote, there are two possibilities, controlled by the
27038 .oindex "&%delay_after_cutoff%&"
27039 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
27040 default. Until the post-cutoff retry time for one of the IP addresses,
27041 as set by the &%retry_data_expire%& option, is
27042 reached, the failing email address is bounced immediately, without a delivery
27043 attempt taking place. After that time, one new delivery attempt is made to
27044 those IP addresses that are past their retry times, and if that still fails,
27045 the address is bounced and new retry times are computed.
27046
27047 In other words, when all the hosts for a given email address have been failing
27048 for a long time, Exim bounces rather then defers until one of the hosts' retry
27049 times is reached. Then it tries once, and bounces if that attempt fails. This
27050 behaviour ensures that few resources are wasted in repeatedly trying to deliver
27051 to a broken destination, but if the host does recover, Exim will eventually
27052 notice.
27053
27054 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
27055 addresses are past their final cutoff time, Exim tries to deliver to those IP
27056 addresses that have not been tried since the message arrived. If there are
27057 no suitable IP addresses, or if they all fail, the address is bounced. In other
27058 words, it does not delay when a new message arrives, but tries the expired
27059 addresses immediately, unless they have been tried since the message arrived.
27060 If there is a continuous stream of messages for the failing domains, setting
27061 &%delay_after_cutoff%& false means that there will be many more attempts to
27062 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
27063 true.
27064
27065 .section "Deliveries that work intermittently" "SECID167"
27066 .cindex "retry" "intermittently working deliveries"
27067 Some additional logic is needed to cope with cases where a host is
27068 intermittently available, or when a message has some attribute that prevents
27069 its delivery when others to the same address get through. In this situation,
27070 because some messages are successfully delivered, the &"retry clock"& for the
27071 host or address keeps getting reset by the successful deliveries, and so
27072 failing messages remain in the queue for ever because the cutoff time is never
27073 reached.
27074
27075 Two exceptional actions are applied to prevent this happening. The first
27076 applies to errors that are related to a message rather than a remote host.
27077 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
27078 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
27079 commands, and quota failures. For this type of error, if a message's arrival
27080 time is earlier than the &"first failed"& time for the error, the earlier time
27081 is used when scanning the retry rules to decide when to try next and when to
27082 time out the address.
27083
27084 The exceptional second action applies in all cases. If a message has been on
27085 the queue for longer than the cutoff time of any applicable retry rule for a
27086 given address, a delivery is attempted for that address, even if it is not yet
27087 time, and if this delivery fails, the address is timed out. A new retry time is
27088 not computed in this case, so that other messages for the same address are
27089 considered immediately.
27090 .ecindex IIDretconf1
27091 .ecindex IIDregconf2
27092
27093
27094
27095
27096
27097
27098 . ////////////////////////////////////////////////////////////////////////////
27099 . ////////////////////////////////////////////////////////////////////////////
27100
27101 .chapter "SMTP authentication" "CHAPSMTPAUTH"
27102 .scindex IIDauthconf1 "SMTP" "authentication configuration"
27103 .scindex IIDauthconf2 "authentication"
27104 The &"authenticators"& section of Exim's runtime configuration is concerned
27105 with SMTP authentication. This facility is an extension to the SMTP protocol,
27106 described in RFC 2554, which allows a client SMTP host to authenticate itself
27107 to a server. This is a common way for a server to recognize clients that are
27108 permitted to use it as a relay. SMTP authentication is not of relevance to the
27109 transfer of mail between servers that have no managerial connection with each
27110 other.
27111
27112 .cindex "AUTH" "description of"
27113 .cindex "ESMTP extensions" AUTH
27114 Very briefly, the way SMTP authentication works is as follows:
27115
27116 .ilist
27117 The server advertises a number of authentication &'mechanisms'& in response to
27118 the client's EHLO command.
27119 .next
27120 The client issues an AUTH command, naming a specific mechanism. The command
27121 may, optionally, contain some authentication data.
27122 .next
27123 The server may issue one or more &'challenges'&, to which the client must send
27124 appropriate responses. In simple authentication mechanisms, the challenges are
27125 just prompts for user names and passwords. The server does not have to issue
27126 any challenges &-- in some mechanisms the relevant data may all be transmitted
27127 with the AUTH command.
27128 .next
27129 The server either accepts or denies authentication.
27130 .next
27131 If authentication succeeds, the client may optionally make use of the AUTH
27132 option on the MAIL command to pass an authenticated sender in subsequent
27133 mail transactions. Authentication lasts for the remainder of the SMTP
27134 connection.
27135 .next
27136 If authentication fails, the client may give up, or it may try a different
27137 authentication mechanism, or it may try transferring mail over the
27138 unauthenticated connection.
27139 .endlist
27140
27141 If you are setting up a client, and want to know which authentication
27142 mechanisms the server supports, you can use Telnet to connect to port 25 (the
27143 SMTP port) on the server, and issue an EHLO command. The response to this
27144 includes the list of supported mechanisms. For example:
27145 .display
27146 &`$ `&&*&`telnet server.example 25`&*&
27147 &`Trying 192.168.34.25...`&
27148 &`Connected to server.example.`&
27149 &`Escape character is &#x0027;^]&#x0027;.`&
27150 &`220 server.example ESMTP Exim 4.20 ...`&
27151 &*&`ehlo client.example`&*&
27152 &`250-server.example Hello client.example [10.8.4.5]`&
27153 &`250-SIZE 52428800`&
27154 &`250-PIPELINING`&
27155 &`250-AUTH PLAIN`&
27156 &`250 HELP`&
27157 .endd
27158 The second-last line of this example output shows that the server supports
27159 authentication using the PLAIN mechanism. In Exim, the different authentication
27160 mechanisms are configured by specifying &'authenticator'& drivers. Like the
27161 routers and transports, which authenticators are included in the binary is
27162 controlled by build-time definitions. The following are currently available,
27163 included by setting
27164 .code
27165 AUTH_CRAM_MD5=yes
27166 AUTH_CYRUS_SASL=yes
27167 AUTH_DOVECOT=yes
27168 AUTH_EXTERNAL=yes
27169 AUTH_GSASL=yes
27170 AUTH_HEIMDAL_GSSAPI=yes
27171 AUTH_PLAINTEXT=yes
27172 AUTH_SPA=yes
27173 AUTH_TLS=yes
27174 .endd
27175 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
27176 authentication mechanism (RFC 2195), and the second provides an interface to
27177 the Cyrus SASL authentication library.
27178 The third is an interface to Dovecot's authentication system, delegating the
27179 work via a socket interface.
27180 The fourth provides for negotiation of authentication done via non-SMTP means,
27181 as defined by RFC 4422 Appendix A.
27182 The fifth provides an interface to the GNU SASL authentication library, which
27183 provides mechanisms but typically not data sources.
27184 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
27185 supporting setting a server keytab.
27186 The seventh can be configured to support
27187 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
27188 not formally documented, but used by several MUAs.
27189 The eighth authenticator
27190 supports Microsoft's &'Secure Password Authentication'& mechanism.
27191 The last is an Exim authenticator but not an SMTP one;
27192 instead it can use information from a TLS negotiation.
27193
27194 The authenticators are configured using the same syntax as other drivers (see
27195 section &<<SECTfordricon>>&). If no authenticators are required, no
27196 authentication section need be present in the configuration file. Each
27197 authenticator can in principle have both server and client functions. When Exim
27198 is receiving SMTP mail, it is acting as a server; when it is sending out
27199 messages over SMTP, it is acting as a client. Authenticator configuration
27200 options are provided for use in both these circumstances.
27201
27202 To make it clear which options apply to which situation, the prefixes
27203 &%server_%& and &%client_%& are used on option names that are specific to
27204 either the server or the client function, respectively. Server and client
27205 functions are disabled if none of their options are set. If an authenticator is
27206 to be used for both server and client functions, a single definition, using
27207 both sets of options, is required. For example:
27208 .code
27209 cram:
27210   driver = cram_md5
27211   public_name = CRAM-MD5
27212   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
27213   client_name = ph10
27214   client_secret = secret2
27215 .endd
27216 The &%server_%& option is used when Exim is acting as a server, and the
27217 &%client_%& options when it is acting as a client.
27218
27219 Descriptions of the individual authenticators are given in subsequent chapters.
27220 The remainder of this chapter covers the generic options for the
27221 authenticators, followed by general discussion of the way authentication works
27222 in Exim.
27223
27224 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27225 per-mechanism basis.  Please read carefully to determine which variables hold
27226 account labels such as usercodes and which hold passwords or other
27227 authenticating data.
27228
27229 Note that some mechanisms support two different identifiers for accounts: the
27230 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27231 and &'authz'& are commonly encountered.  The American spelling is standard here.
27232 Conceptually, authentication data such as passwords are tied to the identifier
27233 used to authenticate; servers may have rules to permit one user to act as a
27234 second user, so that after login the session is treated as though that second
27235 user had logged in.  That second user is the &'authorization id'&.  A robust
27236 configuration might confirm that the &'authz'& field is empty or matches the
27237 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27238 as verified data, the &'authz'& as an unverified request which the server might
27239 choose to honour.
27240
27241 A &'realm'& is a text string, typically a domain name, presented by a server
27242 to a client to help it select an account and credentials to use.  In some
27243 mechanisms, the client and server provably agree on the realm, but clients
27244 typically can not treat the realm as secure data to be blindly trusted.
27245
27246
27247
27248 .section "Generic options for authenticators" "SECID168"
27249 .cindex "authentication" "generic options"
27250 .cindex "options" "generic; for authenticators"
27251
27252 .option client_condition authenticators string&!! unset
27253 When Exim is authenticating as a client, it skips any authenticator whose
27254 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27255 used, for example, to skip plain text authenticators when the connection is not
27256 encrypted by a setting such as:
27257 .code
27258 client_condition = ${if !eq{$tls_out_cipher}{}}
27259 .endd
27260
27261
27262 .option client_set_id authenticators string&!! unset
27263 When client authentication succeeds, this condition is expanded; the
27264 result is used in the log lines for outbound messages.
27265 Typically it will be the user name used for authentication.
27266
27267
27268 .option driver authenticators string unset
27269 This option must always be set. It specifies which of the available
27270 authenticators is to be used.
27271
27272
27273 .option public_name authenticators string unset
27274 This option specifies the name of the authentication mechanism that the driver
27275 implements, and by which it is known to the outside world. These names should
27276 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27277 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27278 defaults to the driver's instance name.
27279
27280
27281 .option server_advertise_condition authenticators string&!! unset
27282 When a server is about to advertise an authentication mechanism, the condition
27283 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27284 mechanism is not advertised.
27285 If the expansion fails, the mechanism is not advertised. If the failure was not
27286 forced, and was not caused by a lookup defer, the incident is logged.
27287 See section &<<SECTauthexiser>>& below for further discussion.
27288
27289
27290 .option server_condition authenticators string&!! unset
27291 This option must be set for a &%plaintext%& server authenticator, where it
27292 is used directly to control authentication. See section &<<SECTplainserver>>&
27293 for details.
27294
27295 For the &(gsasl)& authenticator, this option is required for various
27296 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27297
27298 For the other authenticators, &%server_condition%& can be used as an additional
27299 authentication or authorization mechanism that is applied after the other
27300 authenticator conditions succeed. If it is set, it is expanded when the
27301 authenticator would otherwise return a success code. If the expansion is forced
27302 to fail, authentication fails. Any other expansion failure causes a temporary
27303 error code to be returned. If the result of a successful expansion is an empty
27304 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27305 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27306 other result, a temporary error code is returned, with the expanded string as
27307 the error text.
27308
27309
27310 .option server_debug_print authenticators string&!! unset
27311 If this option is set and authentication debugging is enabled (see the &%-d%&
27312 command line option), the string is expanded and included in the debugging
27313 output when the authenticator is run as a server. This can help with checking
27314 out the values of variables.
27315 If expansion of the string fails, the error message is written to the debugging
27316 output, and Exim carries on processing.
27317
27318
27319 .option server_set_id authenticators string&!! unset
27320 .vindex "&$authenticated_id$&"
27321 .vindex "&$authenticated_fail_id$&"
27322 When an Exim server successfully authenticates a client, this string is
27323 expanded using data from the authentication, and preserved for any incoming
27324 messages in the variable &$authenticated_id$&. It is also included in the log
27325 lines for incoming messages. For example, a user/password authenticator
27326 configuration might preserve the user name that was used to authenticate, and
27327 refer to it subsequently during delivery of the message.
27328 On a failing authentication the expansion result is instead saved in
27329 the &$authenticated_fail_id$& variable.
27330 If expansion fails, the option is ignored.
27331
27332
27333 .option server_mail_auth_condition authenticators string&!! unset
27334 This option allows a server to discard authenticated sender addresses supplied
27335 as part of MAIL commands in SMTP connections that are authenticated by the
27336 driver on which &%server_mail_auth_condition%& is set. The option is not used
27337 as part of the authentication process; instead its (unexpanded) value is
27338 remembered for later use.
27339 How it is used is described in the following section.
27340
27341
27342
27343
27344
27345 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27346 .cindex "authentication" "sender; authenticated"
27347 .cindex "AUTH" "on MAIL command"
27348 When a client supplied an AUTH= item on a MAIL command, Exim applies
27349 the following checks before accepting it as the authenticated sender of the
27350 message:
27351
27352 .ilist
27353 If the connection is not using extended SMTP (that is, HELO was used rather
27354 than EHLO), the use of AUTH= is a syntax error.
27355 .next
27356 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27357 .next
27358 .vindex "&$authenticated_sender$&"
27359 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27360 running, the value of &$authenticated_sender$& is set to the value obtained
27361 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27362 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27363 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27364 given for the MAIL command.
27365 .next
27366 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27367 is accepted and placed in &$authenticated_sender$& only if the client has
27368 authenticated.
27369 .next
27370 If the AUTH= value was accepted by either of the two previous rules, and
27371 the client has authenticated, and the authenticator has a setting for the
27372 &%server_mail_auth_condition%&, the condition is checked at this point. The
27373 valued that was saved from the authenticator is expanded. If the expansion
27374 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27375 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27376 the value of &$authenticated_sender$& is retained and passed on with the
27377 message.
27378 .endlist
27379
27380
27381 When &$authenticated_sender$& is set for a message, it is passed on to other
27382 hosts to which Exim authenticates as a client. Do not confuse this value with
27383 &$authenticated_id$&, which is a string obtained from the authentication
27384 process, and which is not usually a complete email address.
27385
27386 .vindex "&$sender_address$&"
27387 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27388 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27389 therefore make use of &$authenticated_sender$&. The converse is not true: the
27390 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27391 ACL is run.
27392
27393
27394
27395 .section "Authentication on an Exim server" "SECTauthexiser"
27396 .cindex "authentication" "on an Exim server"
27397 When Exim receives an EHLO command, it advertises the public names of those
27398 authenticators that are configured as servers, subject to the following
27399 conditions:
27400
27401 .ilist
27402 The client host must match &%auth_advertise_hosts%& (default *).
27403 .next
27404 If the &%server_advertise_condition%& option is set, its expansion must not
27405 yield the empty string, &"0"&, &"no"&, or &"false"&.
27406 .endlist
27407
27408 The order in which the authenticators are defined controls the order in which
27409 the mechanisms are advertised.
27410
27411 Some mail clients (for example, some versions of Netscape) require the user to
27412 provide a name and password for authentication whenever AUTH is advertised,
27413 even though authentication may not in fact be needed (for example, Exim may be
27414 set up to allow unconditional relaying from the client by an IP address check).
27415 You can make such clients more friendly by not advertising AUTH to them.
27416 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27417 that runs for RCPT) to relay without authentication, you should set
27418 .code
27419 auth_advertise_hosts = ! 10.9.8.0/24
27420 .endd
27421 so that no authentication mechanisms are advertised to them.
27422
27423 The &%server_advertise_condition%& controls the advertisement of individual
27424 authentication mechanisms. For example, it can be used to restrict the
27425 advertisement of a particular mechanism to encrypted connections, by a setting
27426 such as:
27427 .code
27428 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27429 .endd
27430 .vindex "&$tls_in_cipher$&"
27431 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27432 yields &"yes"&, which allows the advertisement to happen.
27433
27434 When an Exim server receives an AUTH command from a client, it rejects it
27435 immediately if AUTH was not advertised in response to an earlier EHLO
27436 command. This is the case if
27437
27438 .ilist
27439 The client host does not match &%auth_advertise_hosts%&; or
27440 .next
27441 No authenticators are configured with server options; or
27442 .next
27443 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27444 server authenticators.
27445 .endlist
27446
27447
27448 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27449 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27450 AUTH is accepted from any client host.
27451
27452 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27453 server authentication mechanism that was advertised in response to EHLO and
27454 that matches the one named in the AUTH command. If it finds one, it runs
27455 the appropriate authentication protocol, and authentication either succeeds or
27456 fails. If there is no matching advertised mechanism, the AUTH command is
27457 rejected with a 504 error.
27458
27459 .vindex "&$received_protocol$&"
27460 .vindex "&$sender_host_authenticated$&"
27461 When a message is received from an authenticated host, the value of
27462 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27463 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27464 public name) of the authenticator driver that successfully authenticated the
27465 client from which the message was received. This variable is empty if there was
27466 no successful authentication.
27467
27468 .cindex authentication "expansion item"
27469 Successful authentication sets up information used by the
27470 &%authresults%& expansion item.
27471
27472
27473
27474
27475 .section "Testing server authentication" "SECID169"
27476 .cindex "authentication" "testing a server"
27477 .cindex "AUTH" "testing a server"
27478 .cindex "base64 encoding" "creating authentication test data"
27479 Exim's &%-bh%& option can be useful for testing server authentication
27480 configurations. The data for the AUTH command has to be sent using base64
27481 encoding. A quick way to produce such data for testing is the following Perl
27482 script:
27483 .code
27484 use MIME::Base64;
27485 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27486 .endd
27487 .cindex "binary zero" "in authentication data"
27488 This interprets its argument as a Perl string, and then encodes it. The
27489 interpretation as a Perl string allows binary zeros, which are required for
27490 some kinds of authentication, to be included in the data. For example, a
27491 command line to run this script on such data might be
27492 .code
27493 encode '\0user\0password'
27494 .endd
27495 Note the use of single quotes to prevent the shell interpreting the
27496 backslashes, so that they can be interpreted by Perl to specify characters
27497 whose code value is zero.
27498
27499 &*Warning 1*&: If either of the user or password strings starts with an octal
27500 digit, you must use three zeros instead of one after the leading backslash. If
27501 you do not, the octal digit that starts your string will be incorrectly
27502 interpreted as part of the code for the first character.
27503
27504 &*Warning 2*&: If there are characters in the strings that Perl interprets
27505 specially, you must use a Perl escape to prevent them being misinterpreted. For
27506 example, a command such as
27507 .code
27508 encode '\0user@domain.com\0pas$$word'
27509 .endd
27510 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27511
27512 If you have the &%mimencode%& command installed, another way to produce
27513 base64-encoded strings is to run the command
27514 .code
27515 echo -e -n `\0user\0password' | mimencode
27516 .endd
27517 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27518 in the argument, and the &%-n%& option specifies no newline at the end of its
27519 output. However, not all versions of &%echo%& recognize these options, so you
27520 should check your version before relying on this suggestion.
27521
27522
27523
27524 .section "Authentication by an Exim client" "SECID170"
27525 .cindex "authentication" "on an Exim client"
27526 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27527 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27528 announces support for authentication, and the host matches an entry in either
27529 of these options, Exim (as a client) tries to authenticate as follows:
27530
27531 .ilist
27532 For each authenticator that is configured as a client, in the order in which
27533 they are defined in the configuration, it searches the authentication
27534 mechanisms announced by the server for one whose name matches the public name
27535 of the authenticator.
27536 .next
27537 .vindex "&$host$&"
27538 .vindex "&$host_address$&"
27539 When it finds one that matches, it runs the authenticator's client code. The
27540 variables &$host$& and &$host_address$& are available for any string expansions
27541 that the client might do. They are set to the server's name and IP address. If
27542 any expansion is forced to fail, the authentication attempt is abandoned, and
27543 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27544 delivery to be deferred.
27545 .next
27546 If the result of the authentication attempt is a temporary error or a timeout,
27547 Exim abandons trying to send the message to the host for the moment. It will
27548 try again later. If there are any backup hosts available, they are tried in the
27549 usual way.
27550 .next
27551 If the response to authentication is a permanent error (5&'xx'& code), Exim
27552 carries on searching the list of authenticators and tries another one if
27553 possible. If all authentication attempts give permanent errors, or if there are
27554 no attempts because no mechanisms match (or option expansions force failure),
27555 what happens depends on whether the host matches &%hosts_require_auth%& or
27556 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27557 delivery is deferred. The error can be detected in the retry rules, and thereby
27558 turned into a permanent error if you wish. In the second case, Exim tries to
27559 deliver the message unauthenticated.
27560 .endlist
27561
27562 Note that the hostlist test for whether to do authentication can be
27563 confused if name-IP lookups change between the time the peer is decided
27564 upon and the time that the transport runs.  For example, with a manualroute
27565 router given a host name, and with DNS "round-robin" used by that name: if
27566 the local resolver cache times out between the router and the transport
27567 running, the transport may get an IP for the name for its authentication
27568 check which does not match the connection peer IP.
27569 No authentication will then be done, despite the names being identical.
27570
27571 For such cases use a separate transport which always authenticates.
27572
27573 .cindex "AUTH" "on MAIL command"
27574 When Exim has authenticated itself to a remote server, it adds the AUTH
27575 parameter to the MAIL commands it sends, if it has an authenticated sender for
27576 the message. If the message came from a remote host, the authenticated sender
27577 is the one that was receiving on an incoming MAIL command, provided that the
27578 incoming connection was authenticated and the &%server_mail_auth%& condition
27579 allowed the authenticated sender to be retained. If a local process calls Exim
27580 to send a message, the sender address that is built from the login name and
27581 &%qualify_domain%& is treated as authenticated. However, if the
27582 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27583 the authenticated sender that was received with the message.
27584 .ecindex IIDauthconf1
27585 .ecindex IIDauthconf2
27586
27587
27588
27589
27590
27591
27592 . ////////////////////////////////////////////////////////////////////////////
27593 . ////////////////////////////////////////////////////////////////////////////
27594
27595 .chapter "The plaintext authenticator" "CHAPplaintext"
27596 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27597 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27598 The &(plaintext)& authenticator can be configured to support the PLAIN and
27599 LOGIN authentication mechanisms, both of which transfer authentication data as
27600 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27601 security risk; you are strongly advised to insist on the use of SMTP encryption
27602 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27603 use unencrypted plain text, you should not use the same passwords for SMTP
27604 connections as you do for login accounts.
27605
27606 .section "Avoiding cleartext use" "SECTplain_TLS"
27607 The following generic option settings will disable &(plaintext)& authenticators when
27608 TLS is not being used:
27609 .code
27610   server_advertise_condition = ${if def:tls_in_cipher }
27611   client_condition =           ${if def:tls_out_cipher}
27612 .endd
27613
27614 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27615 but is still vulnerable to a Man In The Middle attack unless certificates
27616 (including their names) have been properly verified.
27617
27618 .section "Plaintext server options" "SECID171"
27619 .cindex "options" "&(plaintext)& authenticator (server)"
27620 When configured as a server, &(plaintext)& uses the following options:
27621
27622 .option server_condition authenticators string&!! unset
27623 This is actually a global authentication option, but it must be set in order to
27624 configure the &(plaintext)& driver as a server. Its use is described below.
27625
27626 .option server_prompts plaintext "string list&!!" unset
27627 The contents of this option, after expansion, must be a colon-separated list of
27628 prompt strings. If expansion fails, a temporary authentication rejection is
27629 given.
27630
27631 .section "Using plaintext in a server" "SECTplainserver"
27632 .cindex "AUTH" "in &(plaintext)& authenticator"
27633 .cindex "binary zero" "in &(plaintext)& authenticator"
27634 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27635         "in &(plaintext)& authenticator"
27636 .vindex "&$auth1$&, &$auth2$&, etc"
27637 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27638
27639 When running as a server, &(plaintext)& performs the authentication test by
27640 expanding a string. The data sent by the client with the AUTH command, or in
27641 response to subsequent prompts, is base64 encoded, and so may contain any byte
27642 values when decoded. If any data is supplied with the command, it is treated as
27643 a list of strings, separated by NULs (binary zeros), the first three of which
27644 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27645 (neither LOGIN nor PLAIN uses more than three strings).
27646
27647 For compatibility with previous releases of Exim, the values are also placed in
27648 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27649 variables for this purpose is now deprecated, as it can lead to confusion in
27650 string expansions that also use them for other things.
27651
27652 If there are more strings in &%server_prompts%& than the number of strings
27653 supplied with the AUTH command, the remaining prompts are used to obtain more
27654 data. Each response from the client may be a list of NUL-separated strings.
27655
27656 .vindex "&$authenticated_id$&"
27657 Once a sufficient number of data strings have been received,
27658 &%server_condition%& is expanded. If the expansion is forced to fail,
27659 authentication fails. Any other expansion failure causes a temporary error code
27660 to be returned. If the result of a successful expansion is an empty string,
27661 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27662 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27663 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27664 For any other result, a temporary error code is returned, with the expanded
27665 string as the error text.
27666
27667 &*Warning*&: If you use a lookup in the expansion to find the user's
27668 password, be sure to make the authentication fail if the user is unknown.
27669 There are good and bad examples at the end of the next section.
27670
27671
27672
27673 .section "The PLAIN authentication mechanism" "SECID172"
27674 .cindex "PLAIN authentication mechanism"
27675 .cindex authentication PLAIN
27676 .cindex "binary zero" "in &(plaintext)& authenticator"
27677 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27678 sent as one item of data (that is, one combined string containing two NUL
27679 separators). The data is sent either as part of the AUTH command, or
27680 subsequently in response to an empty prompt from the server.
27681
27682 The second and third strings are a user name and a corresponding password.
27683 Using a single fixed user name and password as an example, this could be
27684 configured as follows:
27685 .code
27686 fixed_plain:
27687   driver = plaintext
27688   public_name = PLAIN
27689   server_prompts = :
27690   server_condition = \
27691     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27692   server_set_id = $auth2
27693 .endd
27694 Note that the default result strings from &%if%& (&"true"& or an empty string)
27695 are exactly what we want here, so they need not be specified. Obviously, if the
27696 password contains expansion-significant characters such as dollar, backslash,
27697 or closing brace, they have to be escaped.
27698
27699 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27700 the end of a string list are ignored). If all the data comes as part of the
27701 AUTH command, as is commonly the case, the prompt is not used. This
27702 authenticator is advertised in the response to EHLO as
27703 .code
27704 250-AUTH PLAIN
27705 .endd
27706 and a client host can authenticate itself by sending the command
27707 .code
27708 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27709 .endd
27710 As this contains three strings (more than the number of prompts), no further
27711 data is required from the client. Alternatively, the client may just send
27712 .code
27713 AUTH PLAIN
27714 .endd
27715 to initiate authentication, in which case the server replies with an empty
27716 prompt. The client must respond with the combined data string.
27717
27718 The data string is base64 encoded, as required by the RFC. This example,
27719 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27720 represents a zero byte. This is split up into three strings, the first of which
27721 is empty. The &%server_condition%& option in the authenticator checks that the
27722 second two are &`username`& and &`mysecret`& respectively.
27723
27724 Having just one fixed user name and password, as in this example, is not very
27725 realistic, though for a small organization with only a handful of
27726 authenticating clients it could make sense.
27727
27728 A more sophisticated instance of this authenticator could use the user name in
27729 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27730 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27731 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27732 This is an incorrect example:
27733 .code
27734 server_condition = \
27735   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27736 .endd
27737 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27738 which it then compares to the supplied password (&$auth3$&). Why is this example
27739 incorrect? It works fine for existing users, but consider what happens if a
27740 non-existent user name is given. The lookup fails, but as no success/failure
27741 strings are given for the lookup, it yields an empty string. Thus, to defeat
27742 the authentication, all a client has to do is to supply a non-existent user
27743 name and an empty password. The correct way of writing this test is:
27744 .code
27745 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27746   {${if eq{$value}{$auth3}}} {false}}
27747 .endd
27748 In this case, if the lookup succeeds, the result is checked; if the lookup
27749 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27750 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27751 always fails if its second argument is empty. However, the second way of
27752 writing the test makes the logic clearer.
27753
27754
27755 .section "The LOGIN authentication mechanism" "SECID173"
27756 .cindex "LOGIN authentication mechanism"
27757 .cindex authentication LOGIN
27758 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27759 in a number of programs. No data is sent with the AUTH command. Instead, a
27760 user name and password are supplied separately, in response to prompts. The
27761 plaintext authenticator can be configured to support this as in this example:
27762 .code
27763 fixed_login:
27764   driver = plaintext
27765   public_name = LOGIN
27766   server_prompts = User Name : Password
27767   server_condition = \
27768     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27769   server_set_id = $auth1
27770 .endd
27771 Because of the way plaintext operates, this authenticator accepts data supplied
27772 with the AUTH command (in contravention of the specification of LOGIN), but
27773 if the client does not supply it (as is the case for LOGIN clients), the prompt
27774 strings are used to obtain two data items.
27775
27776 Some clients are very particular about the precise text of the prompts. For
27777 example, Outlook Express is reported to recognize only &"Username:"& and
27778 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27779 strings. It uses the &%ldapauth%& expansion condition to check the user
27780 name and password by binding to an LDAP server:
27781 .code
27782 login:
27783   driver = plaintext
27784   public_name = LOGIN
27785   server_prompts = Username:: : Password::
27786   server_condition = ${if and{{ \
27787     !eq{}{$auth1} }{ \
27788     ldapauth{\
27789       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27790       pass=${quote:$auth2} \
27791       ldap://ldap.example.org/} }} }
27792   server_set_id = uid=$auth1,ou=people,o=example.org
27793 .endd
27794 We have to check that the username is not empty before using it, because LDAP
27795 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27796 operator to correctly quote the DN for authentication. However, the basic
27797 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27798 correct one to use for the password, because quoting is needed only to make
27799 the password conform to the Exim syntax. At the LDAP level, the password is an
27800 uninterpreted string.
27801
27802
27803 .section "Support for different kinds of authentication" "SECID174"
27804 A number of string expansion features are provided for the purpose of
27805 interfacing to different ways of user authentication. These include checking
27806 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27807 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27808 &<<SECTexpcond>>&.
27809
27810
27811
27812
27813 .section "Using plaintext in a client" "SECID175"
27814 .cindex "options" "&(plaintext)& authenticator (client)"
27815 The &(plaintext)& authenticator has two client options:
27816
27817 .option client_ignore_invalid_base64 plaintext boolean false
27818 If the client receives a server prompt that is not a valid base64 string,
27819 authentication is abandoned by default. However, if this option is set true,
27820 the error in the challenge is ignored and the client sends the response as
27821 usual.
27822
27823 .option client_send plaintext string&!! unset
27824 The string is a colon-separated list of authentication data strings. Each
27825 string is independently expanded before being sent to the server. The first
27826 string is sent with the AUTH command; any more strings are sent in response
27827 to prompts from the server. Before each string is expanded, the value of the
27828 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27829 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27830 way. Thus, the prompt that is received in response to sending the first string
27831 (with the AUTH command) can be used in the expansion of the second string, and
27832 so on. If an invalid base64 string is received when
27833 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27834 &$auth$&<&'n'&> variable.
27835
27836 &*Note*&: You cannot use expansion to create multiple strings, because
27837 splitting takes priority and happens first.
27838
27839 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27840 the data, further processing is applied to each string before it is sent. If
27841 there are any single circumflex characters in the string, they are converted to
27842 NULs. Should an actual circumflex be required as data, it must be doubled in
27843 the string.
27844
27845 This is an example of a client configuration that implements the PLAIN
27846 authentication mechanism with a fixed user name and password:
27847 .code
27848 fixed_plain:
27849   driver = plaintext
27850   public_name = PLAIN
27851   client_send = ^username^mysecret
27852 .endd
27853 The lack of colons means that the entire text is sent with the AUTH
27854 command, with the circumflex characters converted to NULs.
27855 .new
27856 Note that due to the ambiguity of parsing three consectutive circumflex characters
27857 there is no way to provide a password having a leading circumflex.
27858 .wen
27859
27860
27861 A similar example
27862 that uses the LOGIN mechanism is:
27863 .code
27864 fixed_login:
27865   driver = plaintext
27866   public_name = LOGIN
27867   client_send = : username : mysecret
27868 .endd
27869 The initial colon means that the first string is empty, so no data is sent with
27870 the AUTH command itself. The remaining strings are sent in response to
27871 prompts.
27872 .ecindex IIDplaiauth1
27873 .ecindex IIDplaiauth2
27874
27875
27876
27877
27878 . ////////////////////////////////////////////////////////////////////////////
27879 . ////////////////////////////////////////////////////////////////////////////
27880
27881 .chapter "The cram_md5 authenticator" "CHID9"
27882 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27883 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27884 .cindex "CRAM-MD5 authentication mechanism"
27885 .cindex authentication CRAM-MD5
27886 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27887 sends a challenge string to the client, and the response consists of a user
27888 name and the CRAM-MD5 digest of the challenge string combined with a secret
27889 string (password) which is known to both server and client. Thus, the secret
27890 is not sent over the network as plain text, which makes this authenticator more
27891 secure than &(plaintext)&. However, the downside is that the secret has to be
27892 available in plain text at either end.
27893
27894
27895 .section "Using cram_md5 as a server" "SECID176"
27896 .cindex "options" "&(cram_md5)& authenticator (server)"
27897 This authenticator has one server option, which must be set to configure the
27898 authenticator as a server:
27899
27900 .option server_secret cram_md5 string&!! unset
27901 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27902 When the server receives the client's response, the user name is placed in
27903 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27904 obtain the password for that user. The server then computes the CRAM-MD5 digest
27905 that the client should have sent, and checks that it received the correct
27906 string. If the expansion of &%server_secret%& is forced to fail, authentication
27907 fails. If the expansion fails for some other reason, a temporary error code is
27908 returned to the client.
27909
27910 For compatibility with previous releases of Exim, the user name is also placed
27911 in &$1$&. However, the use of this variables for this purpose is now
27912 deprecated, as it can lead to confusion in string expansions that also use
27913 numeric variables for other things.
27914
27915 For example, the following authenticator checks that the user name given by the
27916 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27917 user name, authentication fails.
27918 .code
27919 fixed_cram:
27920   driver = cram_md5
27921   public_name = CRAM-MD5
27922   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27923   server_set_id = $auth1
27924 .endd
27925 .vindex "&$authenticated_id$&"
27926 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27927 name in &$authenticated_id$&. A more typical configuration might look up the
27928 secret string in a file, using the user name as the key. For example:
27929 .code
27930 lookup_cram:
27931   driver = cram_md5
27932   public_name = CRAM-MD5
27933   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27934                   {$value}fail}
27935   server_set_id = $auth1
27936 .endd
27937 Note that this expansion explicitly forces failure if the lookup fails
27938 because &$auth1$& contains an unknown user name.
27939
27940 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27941 using the relevant libraries, you need to know the realm to specify in the
27942 lookup and then ask for the &"userPassword"& attribute for that user in that
27943 realm, with:
27944 .code
27945 cyrusless_crammd5:
27946   driver = cram_md5
27947   public_name = CRAM-MD5
27948   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27949                   dbmjz{/etc/sasldb2}{$value}fail}
27950   server_set_id = $auth1
27951 .endd
27952
27953 .section "Using cram_md5 as a client" "SECID177"
27954 .cindex "options" "&(cram_md5)& authenticator (client)"
27955 When used as a client, the &(cram_md5)& authenticator has two options:
27956
27957
27958
27959 .option client_name cram_md5 string&!! "the primary host name"
27960 This string is expanded, and the result used as the user name data when
27961 computing the response to the server's challenge.
27962
27963
27964 .option client_secret cram_md5 string&!! unset
27965 This option must be set for the authenticator to work as a client. Its value is
27966 expanded and the result used as the secret string when computing the response.
27967
27968
27969 .vindex "&$host$&"
27970 .vindex "&$host_address$&"
27971 Different user names and secrets can be used for different servers by referring
27972 to &$host$& or &$host_address$& in the options. Forced failure of either
27973 expansion string is treated as an indication that this authenticator is not
27974 prepared to handle this case. Exim moves on to the next configured client
27975 authenticator. Any other expansion failure causes Exim to give up trying to
27976 send the message to the current server.
27977
27978 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27979 strings, is:
27980 .code
27981 fixed_cram:
27982   driver = cram_md5
27983   public_name = CRAM-MD5
27984   client_name = ph10
27985   client_secret = secret
27986 .endd
27987 .ecindex IIDcramauth1
27988 .ecindex IIDcramauth2
27989
27990
27991
27992 . ////////////////////////////////////////////////////////////////////////////
27993 . ////////////////////////////////////////////////////////////////////////////
27994
27995 .chapter "The cyrus_sasl authenticator" "CHID10"
27996 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27997 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27998 .cindex "Cyrus" "SASL library"
27999 .cindex "Kerberos"
28000 The code for this authenticator was provided by Matthew Byng-Maddick while
28001 at A L Digital Ltd.
28002
28003 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
28004 library implementation of the RFC 2222 (&"Simple Authentication and Security
28005 Layer"&). This library supports a number of authentication mechanisms,
28006 including PLAIN and LOGIN, but also several others that Exim does not support
28007 directly. In particular, there is support for Kerberos authentication.
28008
28009 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
28010 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
28011 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
28012 name of the driver to determine which mechanism to support.
28013
28014 Where access to some kind of secret file is required, for example, in GSSAPI
28015 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
28016 user, and that the Cyrus SASL library has no way of escalating privileges
28017 by default. You may also find you need to set environment variables,
28018 depending on the driver you are using.
28019
28020 The application name provided by Exim is &"exim"&, so various SASL options may
28021 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
28022 Kerberos, note that because of limitations in the GSSAPI interface,
28023 changing the server keytab might need to be communicated down to the Kerberos
28024 layer independently. The mechanism for doing so is dependent upon the Kerberos
28025 implementation.
28026
28027 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
28028 may be set to point to an alternative keytab file. Exim will pass this
28029 variable through from its own inherited environment when started as root or the
28030 Exim user. The keytab file needs to be readable by the Exim user.
28031 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
28032 environment variable.  In practice, for those releases, the Cyrus authenticator
28033 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
28034 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
28035
28036
28037 .section "Using cyrus_sasl as a server" "SECID178"
28038 The &(cyrus_sasl)& authenticator has four private options. It puts the username
28039 (on a successful authentication) into &$auth1$&. For compatibility with
28040 previous releases of Exim, the username is also placed in &$1$&. However, the
28041 use of this variable for this purpose is now deprecated, as it can lead to
28042 confusion in string expansions that also use numeric variables for other
28043 things.
28044
28045
28046 .option server_hostname cyrus_sasl string&!! "see below"
28047 This option selects the hostname that is used when communicating with the
28048 library. The default value is &`$primary_hostname`&. It is up to the underlying
28049 SASL plug-in what it does with this data.
28050
28051
28052 .option server_mech cyrus_sasl string "see below"
28053 This option selects the authentication mechanism this driver should use. The
28054 default is the value of the generic &%public_name%& option. This option allows
28055 you to use a different underlying mechanism from the advertised name. For
28056 example:
28057 .code
28058 sasl:
28059   driver = cyrus_sasl
28060   public_name = X-ANYTHING
28061   server_mech = CRAM-MD5
28062   server_set_id = $auth1
28063 .endd
28064
28065 .option server_realm cyrus_sasl string&!! unset
28066 This specifies the SASL realm that the server claims to be in.
28067
28068
28069 .option server_service cyrus_sasl string &`smtp`&
28070 This is the SASL service that the server claims to implement.
28071
28072
28073 For straightforward cases, you do not need to set any of the authenticator's
28074 private options. All you need to do is to specify an appropriate mechanism as
28075 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
28076 PLAIN, you could have two authenticators as follows:
28077 .code
28078 sasl_cram_md5:
28079   driver = cyrus_sasl
28080   public_name = CRAM-MD5
28081   server_set_id = $auth1
28082
28083 sasl_plain:
28084   driver = cyrus_sasl
28085   public_name = PLAIN
28086   server_set_id = $auth2
28087 .endd
28088 Cyrus SASL does implement the LOGIN authentication method, even though it is
28089 not a standard method. It is disabled by default in the source distribution,
28090 but it is present in many binary distributions.
28091 .ecindex IIDcyrauth1
28092 .ecindex IIDcyrauth2
28093
28094
28095
28096
28097 . ////////////////////////////////////////////////////////////////////////////
28098 . ////////////////////////////////////////////////////////////////////////////
28099 .chapter "The dovecot authenticator" "CHAPdovecot"
28100 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
28101 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
28102 This authenticator is an interface to the authentication facility of the
28103 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
28104 Note that Dovecot must be configured to use auth-client not auth-userdb.
28105 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
28106 to use the same mechanisms for SMTP authentication. This is a server
28107 authenticator only. There is only one option:
28108
28109 .option server_socket dovecot string unset
28110
28111 This option must specify the UNIX socket that is the interface to Dovecot
28112 authentication. The &%public_name%& option must specify an authentication
28113 mechanism that Dovecot is configured to support. You can have several
28114 authenticators for different mechanisms. For example:
28115 .code
28116 dovecot_plain:
28117   driver = dovecot
28118   public_name = PLAIN
28119   server_socket = /var/run/dovecot/auth-client
28120   server_set_id = $auth1
28121
28122 dovecot_ntlm:
28123   driver = dovecot
28124   public_name = NTLM
28125   server_socket = /var/run/dovecot/auth-client
28126   server_set_id = $auth1
28127 .endd
28128 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
28129 &$received_ip_address$& (that is, the connection is local), the &"secured"&
28130 option is passed in the Dovecot authentication command. If, for a TLS
28131 connection, a client certificate has been verified, the &"valid-client-cert"&
28132 option is passed. When authentication succeeds, the identity of the user
28133 who authenticated is placed in &$auth1$&.
28134
28135 The Dovecot configuration to match the above will look
28136 something like:
28137 .code
28138 conf.d/10-master.conf :-
28139
28140 service auth {
28141 ...
28142 #SASL
28143   unix_listener auth-client {
28144     mode = 0660
28145     user = mail
28146   }
28147 ...
28148 }
28149
28150 conf.d/10-auth.conf :-
28151
28152 auth_mechanisms = plain login ntlm
28153 .endd
28154
28155 .ecindex IIDdcotauth1
28156 .ecindex IIDdcotauth2
28157
28158
28159 . ////////////////////////////////////////////////////////////////////////////
28160 . ////////////////////////////////////////////////////////////////////////////
28161 .chapter "The gsasl authenticator" "CHAPgsasl"
28162 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
28163 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
28164 .cindex "authentication" "GNU SASL"
28165 .cindex "authentication" "SASL"
28166 .cindex "authentication" "EXTERNAL"
28167 .cindex "authentication" "ANONYMOUS"
28168 .cindex "authentication" "PLAIN"
28169 .cindex "authentication" "LOGIN"
28170 .cindex "authentication" "DIGEST-MD5"
28171 .cindex "authentication" "CRAM-MD5"
28172 .cindex "authentication" "SCRAM family"
28173 The &(gsasl)& authenticator provides integration for the GNU SASL
28174 library and the mechanisms it provides.  This is new as of the 4.80 release
28175 and there are a few areas where the library does not let Exim smoothly
28176 scale to handle future authentication mechanisms, so no guarantee can be
28177 made that any particular new authentication mechanism will be supported
28178 without code changes in Exim.
28179
28180 The library is expected to add support in an upcoming
28181 realease for the SCRAM-SHA-256 method.
28182 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
28183 when this happens.
28184
28185 .new
28186 To see the list of mechanisms supported by the library run Exim with "auth" debug
28187 enabled and look for a line containing "GNU SASL supports".
28188 Note however that some may not have been tested from Exim.
28189 .wen
28190
28191
28192 .option client_authz gsasl string&!! unset
28193 This option can be used to supply an &'authorization id'&
28194 which is different to the &'authentication_id'& provided
28195 by &%client_username%& option.
28196 If unset or (after expansion) empty it is not used,
28197 which is the common case.
28198
28199 .option client_channelbinding gsasl boolean false
28200 See &%server_channelbinding%& below.
28201
28202 .option client_password gsasl string&!! unset
28203 This option is exapanded before use, and should result in
28204 the password to be used, in clear.
28205
28206 .option client_username gsasl string&!! unset
28207 This option is exapanded before use, and should result in
28208 the account name to be used.
28209
28210
28211 .option client_spassword gsasl string&!! unset
28212 .new
28213 This option is only supported for library versions 1.9.1 and greater.
28214 The macro _HAVE_AUTH_GSASL_SCRAM_S_KEY will be defined when this is so.
28215 .wen
28216
28217 If a SCRAM mechanism is being used and this option is set
28218 and correctly sized
28219 it is used in preference to &%client_password%&.
28220 The value after expansion should be
28221 a 40 (for SHA-1) or 64 (for SHA-256) character string
28222 with the PBKDF2-prepared password, hex-encoded.
28223
28224 Note that this value will depend on the salt and iteration-count
28225 supplied by the server.
28226 The option is expanded before use.
28227 .new
28228 During the expansion &$auth1$& is set with the client username,
28229 &$auth2$& with the iteration count, and
28230 &$auth3$& with the salt.
28231
28232 The intent of this option
28233 is to support clients that can cache thes salted password
28234 to save on recalculation costs.
28235 The cache lookup should return an unusable value
28236 (eg. an empty string)
28237 if the salt or iteration count has changed
28238
28239 If the authentication succeeds then the above variables are set,
28240 .vindex "&$auth4$&"
28241 plus the calculated salted password value value in &$auth4$&,
28242 during the expansion of the &%client_set_id%& option.
28243 A side-effect of this expansion can be used to prime the cache.
28244 .wen
28245
28246
28247 .option server_channelbinding gsasl boolean false
28248 Some authentication mechanisms are able to use external context at both ends
28249 of the session to bind the authentication to that context, and fail the
28250 authentication process if that context differs.  Specifically, some TLS
28251 ciphersuites can provide identifying information about the cryptographic
28252 context.
28253
28254 This should have meant that certificate identity and verification becomes a
28255 non-issue, as a man-in-the-middle attack will cause the correct client and
28256 server to see different identifiers and authentication will fail.
28257
28258 This is
28259 only usable by mechanisms which support "channel binding"; at time of
28260 writing, that's the SCRAM family.
28261 When using this feature the "-PLUS" variants of the method names need to be used.
28262
28263 This defaults off to ensure smooth upgrade across Exim releases, in case
28264 this option causes some clients to start failing.  Some future release
28265 of Exim might have switched the default to be true.
28266
28267 . However, Channel Binding in TLS has proven to be vulnerable in current versions.
28268 . Do not plan to rely upon this feature for security, ever, without consulting
28269 . with a subject matter expert (a cryptographic engineer).
28270
28271 .new
28272 This option was deprecated in previous releases due to doubts over
28273 the "Triple Handshake" vulnerability.
28274 Exim takes suitable precausions (requiring Extended Master Secret if TLS
28275 Session Resumption was used) for safety.
28276 .wen
28277
28278
28279 .option server_hostname gsasl string&!! "see below"
28280 This option selects the hostname that is used when communicating with the
28281 library. The default value is &`$primary_hostname`&.
28282 Some mechanisms will use this data.
28283
28284
28285 .option server_mech gsasl string "see below"
28286 This option selects the authentication mechanism this driver should use. The
28287 default is the value of the generic &%public_name%& option. This option allows
28288 you to use a different underlying mechanism from the advertised name. For
28289 example:
28290 .code
28291 sasl:
28292   driver = gsasl
28293   public_name = X-ANYTHING
28294   server_mech = CRAM-MD5
28295   server_set_id = $auth1
28296 .endd
28297
28298
28299 .option server_password gsasl string&!! unset
28300 Various mechanisms need access to the cleartext password on the server, so
28301 that proof-of-possession can be demonstrated on the wire, without sending
28302 the password itself.
28303
28304 The data available for lookup varies per mechanism.
28305 In all cases, &$auth1$& is set to the &'authentication id'&.
28306 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28307 if available, else the empty string.
28308 The &$auth3$& variable will always be the &'realm'& if available,
28309 else the empty string.
28310
28311 A forced failure will cause authentication to defer.
28312
28313 If using this option, it may make sense to set the &%server_condition%&
28314 option to be simply "true".
28315
28316
28317 .option server_realm gsasl string&!! unset
28318 This specifies the SASL realm that the server claims to be in.
28319 Some mechanisms will use this data.
28320
28321
28322 .option server_scram_iter gsasl string&!! 4096
28323 This option provides data for the SCRAM family of mechanisms.
28324 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28325 when this option is expanded.
28326
28327 The result of expansion should be a decimal number,
28328 and represents both a lower-bound on the security, and
28329 a compute cost factor imposed on the client
28330 (if it does not cache results, or the server changes
28331 either the iteration count or the salt).
28332 A minimum value of 4096 is required by the standards
28333 for all current SCRAM mechanism variants.
28334
28335 .option server_scram_salt gsasl string&!! unset
28336 This option provides data for the SCRAM family of mechanisms.
28337 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28338 when this option is expanded.
28339 The value should be a base64-encoded string,
28340 of random data typically 4-to-16 bytes long.
28341 If unset or empty after expansion the library will provides a value for the
28342 protocol conversation.
28343
28344
28345 .option server_key gsasl string&!! unset
28346 .option server_skey gsasl string&!! unset
28347 These options can be used for the SCRAM family of mechanisms
28348 to provide stored information related to a password,
28349 the storage of which is preferable to plaintext.
28350
28351 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28352 &%server_skey%& is StoredKey.
28353
28354 They are only available for version 1.9.0 (or later) of the gsasl library.
28355 When this is so, the macros
28356 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28357 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28358 will be defined.
28359
28360 The &$authN$& variables are available when these options are expanded.
28361
28362 If set, the results of expansion should for each
28363 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28364 of base64-coded data, and will be used in preference to the
28365 &%server_password%& option.
28366 If unset or not of the right length, &%server_password%& will be used.
28367
28368 The libgsasl library release includes a utility &'gsasl'& which can be used
28369 to generate these values.
28370
28371
28372 .option server_service gsasl string &`smtp`&
28373 This is the SASL service that the server claims to implement.
28374 Some mechanisms will use this data.
28375
28376
28377 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28378 .vindex "&$auth1$&, &$auth2$&, etc"
28379 These may be set when evaluating specific options, as detailed above.
28380 They will also be set when evaluating &%server_condition%&.
28381
28382 Unless otherwise stated below, the &(gsasl)& integration will use the following
28383 meanings for these variables:
28384
28385 .ilist
28386 .vindex "&$auth1$&"
28387 &$auth1$&: the &'authentication id'&
28388 .next
28389 .vindex "&$auth2$&"
28390 &$auth2$&: the &'authorization id'&
28391 .next
28392 .vindex "&$auth3$&"
28393 &$auth3$&: the &'realm'&
28394 .endlist
28395
28396 On a per-mechanism basis:
28397
28398 .ilist
28399 .cindex "authentication" "EXTERNAL"
28400 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28401 the &%server_condition%& option must be present.
28402 .next
28403 .cindex "authentication" "ANONYMOUS"
28404 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28405 the &%server_condition%& option must be present.
28406 .next
28407 .cindex "authentication" "GSSAPI"
28408 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28409 &$auth2$& will be set to the &'authorization id'&,
28410 the &%server_condition%& option must be present.
28411 .endlist
28412
28413 An &'anonymous token'& is something passed along as an unauthenticated
28414 identifier; this is analogous to FTP anonymous authentication passing an
28415 email address, or software-identifier@, as the "password".
28416
28417
28418 An example showing the password having the realm specified in the callback
28419 and demonstrating a Cyrus SASL to GSASL migration approach is:
28420 .code
28421 gsasl_cyrusless_crammd5:
28422   driver = gsasl
28423   public_name = CRAM-MD5
28424   server_realm = imap.example.org
28425   server_password = ${lookup{$auth1:$auth3:userPassword}\
28426                     dbmjz{/etc/sasldb2}{$value}fail}
28427   server_set_id = ${quote:$auth1}
28428   server_condition = yes
28429 .endd
28430
28431
28432 . ////////////////////////////////////////////////////////////////////////////
28433 . ////////////////////////////////////////////////////////////////////////////
28434
28435 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28436 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28437 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28438 .cindex "authentication" "GSSAPI"
28439 .cindex "authentication" "Kerberos"
28440 The &(heimdal_gssapi)& authenticator provides server integration for the
28441 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28442 reliably.
28443
28444 .option server_hostname heimdal_gssapi string&!! "see below"
28445 This option selects the hostname that is used, with &%server_service%&,
28446 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28447 identifier.  The default value is &`$primary_hostname`&.
28448
28449 .option server_keytab heimdal_gssapi string&!! unset
28450 If set, then Heimdal will not use the system default keytab (typically
28451 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28452 The value should be a pathname, with no &"file:"& prefix.
28453
28454 .option server_service heimdal_gssapi string&!! "smtp"
28455 This option specifies the service identifier used, in conjunction with
28456 &%server_hostname%&, for building the identifier for finding credentials
28457 from the keytab.
28458
28459
28460 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28461 Beware that these variables will typically include a realm, thus will appear
28462 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28463 not verified, so a malicious client can set it to anything.
28464
28465 The &$auth1$& field should be safely trustable as a value from the Key
28466 Distribution Center.  Note that these are not quite email addresses.
28467 Each identifier is for a role, and so the left-hand-side may include a
28468 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28469
28470 .vindex "&$auth1$&, &$auth2$&, etc"
28471 .ilist
28472 .vindex "&$auth1$&"
28473 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28474 .next
28475 .vindex "&$auth2$&"
28476 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28477 authentication.  If that was empty, this will also be set to the
28478 GSS Display Name.
28479 .endlist
28480
28481
28482 . ////////////////////////////////////////////////////////////////////////////
28483 . ////////////////////////////////////////////////////////////////////////////
28484
28485 .chapter "The spa authenticator" "CHAPspa"
28486 .scindex IIDspaauth1 "&(spa)& authenticator"
28487 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28488 .cindex "authentication" "Microsoft Secure Password"
28489 .cindex "authentication" "NTLM"
28490 .cindex "Microsoft Secure Password Authentication"
28491 .cindex "NTLM authentication"
28492 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28493 Password Authentication'& mechanism,
28494 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28495 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28496 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28497 server side was subsequently contributed by Tom Kistner. The mechanism works as
28498 follows:
28499
28500 .ilist
28501 After the AUTH command has been accepted, the client sends an SPA
28502 authentication request based on the user name and optional domain.
28503 .next
28504 The server sends back a challenge.
28505 .next
28506 The client builds a challenge response which makes use of the user's password
28507 and sends it to the server, which then accepts or rejects it.
28508 .endlist
28509
28510 Encryption is used to protect the password in transit.
28511
28512
28513
28514 .section "Using spa as a server" "SECID179"
28515 .cindex "options" "&(spa)& authenticator (server)"
28516 The &(spa)& authenticator has just one server option:
28517
28518 .option server_password spa string&!! unset
28519 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28520 This option is expanded, and the result must be the cleartext password for the
28521 authenticating user, whose name is at this point in &$auth1$&. For
28522 compatibility with previous releases of Exim, the user name is also placed in
28523 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28524 it can lead to confusion in string expansions that also use numeric variables
28525 for other things. For example:
28526 .code
28527 spa:
28528   driver = spa
28529   public_name = NTLM
28530   server_password = \
28531     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28532 .endd
28533 If the expansion is forced to fail, authentication fails. Any other expansion
28534 failure causes a temporary error code to be returned.
28535
28536
28537
28538
28539
28540 .section "Using spa as a client" "SECID180"
28541 .cindex "options" "&(spa)& authenticator (client)"
28542 The &(spa)& authenticator has the following client options:
28543
28544
28545
28546 .option client_domain spa string&!! unset
28547 This option specifies an optional domain for the authentication.
28548
28549
28550 .option client_password spa string&!! unset
28551 This option specifies the user's password, and must be set.
28552
28553
28554 .option client_username spa string&!! unset
28555 This option specifies the user name, and must be set. Here is an example of a
28556 configuration of this authenticator for use with the mail servers at
28557 &'msn.com'&:
28558 .code
28559 msn:
28560   driver = spa
28561   public_name = MSN
28562   client_username = msn/msn_username
28563   client_password = msn_plaintext_password
28564   client_domain = DOMAIN_OR_UNSET
28565 .endd
28566 .ecindex IIDspaauth1
28567 .ecindex IIDspaauth2
28568
28569
28570
28571
28572
28573 . ////////////////////////////////////////////////////////////////////////////
28574 . ////////////////////////////////////////////////////////////////////////////
28575
28576 .chapter "The external authenticator" "CHAPexternauth"
28577 .scindex IIDexternauth1 "&(external)& authenticator"
28578 .scindex IIDexternauth2 "authenticators" "&(external)&"
28579 .cindex "authentication" "Client Certificate"
28580 .cindex "authentication" "X509"
28581 .cindex "Certificate-based authentication"
28582 The &(external)& authenticator provides support for
28583 authentication based on non-SMTP information.
28584 The specification is in RFC 4422 Appendix A
28585 (&url(https://tools.ietf.org/html/rfc4422)).
28586 It is only a transport and negotiation mechanism;
28587 the process of authentication is entirely controlled
28588 by the server configuration.
28589
28590 The client presents an identity in-clear.
28591 It is probably wise for a server to only advertise,
28592 and for clients to only attempt,
28593 this authentication method on a secure (eg. under TLS) connection.
28594
28595 One possible use, compatible with the
28596 K-9 Mail Android client (&url(https://k9mail.github.io/)),
28597 is for using X509 client certificates.
28598
28599 It thus overlaps in function with the TLS authenticator
28600 (see &<<CHAPtlsauth>>&)
28601 but is a full SMTP SASL authenticator
28602 rather than being implicit for TLS-connection carried
28603 client certificates only.
28604
28605 The examples and discussion in this chapter assume that
28606 client-certificate authentication is being done.
28607
28608 The client must present a certificate,
28609 for which it must have been requested via the
28610 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28611 (see &<<CHAPTLS>>&).
28612 For authentication to be effective the certificate should be
28613 verifiable against a trust-anchor certificate known to the server.
28614
28615 .section "External options" "SECTexternsoptions"
28616 .cindex "options" "&(external)& authenticator (server)"
28617 The &(external)& authenticator has two server options:
28618
28619 .option server_param2 external string&!! unset
28620 .option server_param3 external string&!! unset
28621 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28622 These options are expanded before the &%server_condition%& option
28623 and the result are placed in &$auth2$& and &$auth3$& resectively.
28624 If the expansion is forced to fail, authentication fails. Any other expansion
28625 failure causes a temporary error code to be returned.
28626
28627 They can be used to clarify the coding of a complex &%server_condition%&.
28628
28629 .section "Using external in a server" "SECTexternserver"
28630 .cindex "AUTH" "in &(external)& authenticator"
28631 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28632         "in &(external)& authenticator"
28633 .vindex "&$auth1$&, &$auth2$&, etc"
28634 .cindex "base64 encoding" "in &(external)& authenticator"
28635
28636 When running as a server, &(external)& performs the authentication test by
28637 expanding a string. The data sent by the client with the AUTH command, or in
28638 response to subsequent prompts, is base64 encoded, and so may contain any byte
28639 values when decoded. The decoded value is treated as
28640 an identity for authentication and
28641 placed in the expansion variable &$auth1$&.
28642
28643 For compatibility with previous releases of Exim, the value is also placed in
28644 the expansion variable &$1$&. However, the use of this
28645 variable for this purpose is now deprecated, as it can lead to confusion in
28646 string expansions that also use them for other things.
28647
28648 .vindex "&$authenticated_id$&"
28649 Once an identity has been received,
28650 &%server_condition%& is expanded. If the expansion is forced to fail,
28651 authentication fails. Any other expansion failure causes a temporary error code
28652 to be returned. If the result of a successful expansion is an empty string,
28653 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28654 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28655 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28656 For any other result, a temporary error code is returned, with the expanded
28657 string as the error text.
28658
28659 Example:
28660 .code
28661 ext_ccert_san_mail:
28662   driver =            external
28663   public_name =       EXTERNAL
28664
28665   server_advertise_condition = $tls_in_certificate_verified
28666   server_param2 =     ${certextract {subj_altname,mail,>:} \
28667                                     {$tls_in_peercert}}
28668   server_condition =  ${if forany {$auth2} \
28669                             {eq {$item}{$auth1}}}
28670   server_set_id =     $auth1
28671 .endd
28672 This accepts a client certificate that is verifiable against any
28673 of your configured trust-anchors
28674 (which usually means the full set of public CAs)
28675 and which has a mail-SAN matching the claimed identity sent by the client.
28676
28677 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28678 The account name is therefore guessable by an opponent.
28679 TLS 1.3 protects both server and client certificates, and is not vulnerable
28680 in this way.
28681
28682
28683 .section "Using external in a client" "SECTexternclient"
28684 .cindex "options" "&(external)& authenticator (client)"
28685 The &(external)& authenticator has one client option:
28686
28687 .option client_send external string&!! unset
28688 This option is expanded and sent with the AUTH command as the
28689 identity being asserted.
28690
28691 Example:
28692 .code
28693 ext_ccert:
28694   driver =      external
28695   public_name = EXTERNAL
28696
28697   client_condition = ${if !eq{$tls_out_cipher}{}}
28698   client_send = myaccount@smarthost.example.net
28699 .endd
28700
28701
28702 .ecindex IIDexternauth1
28703 .ecindex IIDexternauth2
28704
28705
28706
28707
28708
28709 . ////////////////////////////////////////////////////////////////////////////
28710 . ////////////////////////////////////////////////////////////////////////////
28711
28712 .chapter "The tls authenticator" "CHAPtlsauth"
28713 .scindex IIDtlsauth1 "&(tls)& authenticator"
28714 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28715 .cindex "authentication" "Client Certificate"
28716 .cindex "authentication" "X509"
28717 .cindex "Certificate-based authentication"
28718 The &(tls)& authenticator provides server support for
28719 authentication based on client certificates.
28720
28721 It is not an SMTP authentication mechanism and is not
28722 advertised by the server as part of the SMTP EHLO response.
28723 It is an Exim authenticator in the sense that it affects
28724 the protocol element of the log line, can be tested for
28725 by the &%authenticated%& ACL condition, and can set
28726 the &$authenticated_id$& variable.
28727
28728 The client must present a verifiable certificate,
28729 for which it must have been requested via the
28730 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28731 (see &<<CHAPTLS>>&).
28732
28733 If an authenticator of this type is configured it is
28734 run before any SMTP-level communication is done,
28735 and can authenticate the connection.
28736 If it does, SMTP authentication is not offered.
28737
28738 A maximum of one authenticator of this type may be present.
28739
28740
28741 .cindex "options" "&(tls)& authenticator (server)"
28742 The &(tls)& authenticator has three server options:
28743
28744 .option server_param1 tls string&!! unset
28745 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28746 This option is expanded after the TLS negotiation and
28747 the result is placed in &$auth1$&.
28748 If the expansion is forced to fail, authentication fails. Any other expansion
28749 failure causes a temporary error code to be returned.
28750
28751 .option server_param2 tls string&!! unset
28752 .option server_param3 tls string&!! unset
28753 As above, for &$auth2$& and &$auth3$&.
28754
28755 &%server_param1%& may also be spelled &%server_param%&.
28756
28757
28758 Example:
28759 .code
28760 tls:
28761   driver = tls
28762   server_param1 =     ${certextract {subj_altname,mail,>:} \
28763                                     {$tls_in_peercert}}
28764   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28765                                  {forany {$auth1} \
28766                             {!= {0} \
28767                                 {${lookup ldap{ldap:///\
28768                          mailname=${quote_ldap_dn:${lc:$item}},\
28769                          ou=users,LDAP_DC?mailid} {$value}{0} \
28770                        }    }  } }}}
28771   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28772 .endd
28773 This accepts a client certificate that is verifiable against any
28774 of your configured trust-anchors
28775 (which usually means the full set of public CAs)
28776 and which has a SAN with a good account name.
28777
28778 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28779 The account name is therefore guessable by an opponent.
28780 TLS 1.3 protects both server and client certificates, and is not vulnerable
28781 in this way.
28782 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28783
28784 . An alternative might use
28785 . .code
28786 .   server_param1 = ${sha256:$tls_in_peercert}
28787 . .endd
28788 . to require one of a set of specific certs that define a given account
28789 . (the verification is still required, but mostly irrelevant).
28790 . This would help for per-device use.
28791 .
28792 . However, for the future we really need support for checking a
28793 . user cert in LDAP - which probably wants a base-64 DER.
28794
28795 .ecindex IIDtlsauth1
28796 .ecindex IIDtlsauth2
28797
28798
28799 Note that because authentication is traditionally an SMTP operation,
28800 the &%authenticated%& ACL condition cannot be used in
28801 a connect- or helo-ACL.
28802
28803
28804
28805 . ////////////////////////////////////////////////////////////////////////////
28806 . ////////////////////////////////////////////////////////////////////////////
28807
28808 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28809          "Encrypted SMTP connections"
28810 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28811 .scindex IIDencsmtp2 "SMTP" "encryption"
28812 .cindex "TLS" "on SMTP connection"
28813 .cindex "OpenSSL"
28814 .cindex "GnuTLS"
28815 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28816 Sockets Layer), is implemented by making use of the OpenSSL library or the
28817 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28818 cryptographic code in the Exim distribution itself for implementing TLS. In
28819 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28820 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28821 You also need to understand the basic concepts of encryption at a managerial
28822 level, and in particular, the way that public keys, private keys, and
28823 certificates are used.
28824
28825 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28826 connection is established, the client issues a STARTTLS command. If the
28827 server accepts this, the client and the server negotiate an encryption
28828 mechanism. If the negotiation succeeds, the data that subsequently passes
28829 between them is encrypted.
28830
28831 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28832 and if so, what cipher suite is in use, whether the client supplied a
28833 certificate, and whether or not that certificate was verified. This makes it
28834 possible for an Exim server to deny or accept certain commands based on the
28835 encryption state.
28836
28837 &*Warning*&: Certain types of firewall and certain anti-virus products can
28838 disrupt TLS connections. You need to turn off SMTP scanning for these products
28839 in order to get TLS to work.
28840
28841
28842
28843 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28844          "SECID284"
28845 .cindex "submissions protocol"
28846 .cindex "ssmtp protocol"
28847 .cindex "smtps protocol"
28848 .cindex "SMTP" "submissions protocol"
28849 .cindex "SMTP" "ssmtp protocol"
28850 .cindex "SMTP" "smtps protocol"
28851 The history of port numbers for TLS in SMTP is a little messy and has been
28852 contentious.  As of RFC 8314, the common practice of using the historically
28853 allocated port 465 for "email submission but with TLS immediately upon connect
28854 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28855 by them in preference to STARTTLS.
28856
28857 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28858 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28859 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28860
28861 This approach was, for a while, officially abandoned when encrypted SMTP was
28862 standardized, but many clients kept using it, even as the TCP port number was
28863 reassigned for other use.
28864 Thus you may encounter guidance claiming that you shouldn't enable use of
28865 this port.
28866 In practice, a number of mail-clients have only ever supported submissions,
28867 not submission with STARTTLS upgrade.
28868 Ideally, offer both submission (587) and submissions (465) service.
28869
28870 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28871 global option. Its value must be a list of port numbers;
28872 the most common use is expected to be:
28873 .code
28874 tls_on_connect_ports = 465
28875 .endd
28876 The port numbers specified by this option apply to all SMTP connections, both
28877 via the daemon and via &'inetd'&. You still need to specify all the ports that
28878 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28879 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28880 an extra port &-- rather, it specifies different behaviour on a port that is
28881 defined elsewhere.
28882
28883 There is also a &%-tls-on-connect%& command line option. This overrides
28884 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28885
28886
28887
28888
28889
28890
28891 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28892 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28893 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28894 To build Exim to use OpenSSL you need to set
28895 .code
28896 USE_OPENSSL=yes
28897 .endd
28898 in Local/Makefile.
28899
28900 To build Exim to use GnuTLS, you need to set
28901 .code
28902 USE_GNUTLS=yes
28903 .endd
28904 in Local/Makefile.
28905
28906 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28907 include files and libraries for GnuTLS can be found.
28908
28909 There are some differences in usage when using GnuTLS instead of OpenSSL:
28910
28911 .ilist
28912 The &%tls_verify_certificates%& option
28913 cannot be the path of a directory
28914 for GnuTLS versions before 3.3.6
28915 (for later versions, or OpenSSL, it can be either).
28916 .next
28917 The default value for &%tls_dhparam%& differs for historical reasons.
28918 .next
28919 .vindex "&$tls_in_peerdn$&"
28920 .vindex "&$tls_out_peerdn$&"
28921 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28922 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28923 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28924 .next
28925 OpenSSL identifies cipher suites using hyphens as separators, for example:
28926 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28927 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28928 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28929 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28930 to handle its own older variants) when processing lists of cipher suites in the
28931 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28932 option).
28933 .next
28934 The &%tls_require_ciphers%& options operate differently, as described in the
28935 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28936 .next
28937 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28938 When using OpenSSL, this option is ignored.
28939 (If an API is found to let OpenSSL be configured in this way,
28940 let the Exim Maintainers know and we'll likely use it).
28941 .next
28942 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28943 main option, it must be ordered to match the &%tls_certificate%& list.
28944 .next
28945 Some other recently added features may only be available in one or the other.
28946 This should be documented with the feature.  If the documentation does not
28947 explicitly state that the feature is infeasible in the other TLS
28948 implementation, then patches are welcome.
28949 .new
28950 .next
28951 The output from "exim -bV" will show which (if any) support was included
28952 in the build.
28953 Also, the macro "_HAVE_OPENSSL" or "_HAVE_GNUTLS" will be defined.
28954 .wen
28955 .endlist
28956
28957
28958 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28959 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28960 an explicit path; if the latter, then the text about generation still applies,
28961 but not the chosen filename.
28962 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28963 See the documentation of &%tls_dhparam%& for more information.
28964
28965 GnuTLS uses D-H parameters that may take a substantial amount of time
28966 to compute. It is unreasonable to re-compute them for every TLS session.
28967 Therefore, Exim keeps this data in a file in its spool directory, called
28968 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28969 of bits requested.
28970 The file is owned by the Exim user and is readable only by
28971 its owner. Every Exim process that start up GnuTLS reads the D-H
28972 parameters from this file. If the file does not exist, the first Exim process
28973 that needs it computes the data and writes it to a temporary file which is
28974 renamed once it is complete. It does not matter if several Exim processes do
28975 this simultaneously (apart from wasting a few resources). Once a file is in
28976 place, new Exim processes immediately start using it.
28977
28978 For maximum security, the parameters that are stored in this file should be
28979 recalculated periodically, the frequency depending on your paranoia level.
28980 If you are avoiding using the fixed D-H primes published in RFCs, then you
28981 are concerned about some advanced attacks and will wish to do this; if you do
28982 not regenerate then you might as well stick to the standard primes.
28983
28984 Arranging this is easy in principle; just delete the file when you want new
28985 values to be computed. However, there may be a problem. The calculation of new
28986 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28987 If the system is not very active, &_/dev/random_& may delay returning data
28988 until enough randomness (entropy) is available. This may cause Exim to hang for
28989 a substantial amount of time, causing timeouts on incoming connections.
28990
28991 The solution is to generate the parameters externally to Exim. They are stored
28992 in &_gnutls-params-N_& in PEM format, which means that they can be
28993 generated externally using the &(certtool)& command that is part of GnuTLS.
28994
28995 To replace the parameters with new ones, instead of deleting the file
28996 and letting Exim re-create it, you can generate new parameters using
28997 &(certtool)& and, when this has been done, replace Exim's cache file by
28998 renaming. The relevant commands are something like this:
28999 .code
29000 # ls
29001 [ look for file; assume gnutls-params-2236 is the most recent ]
29002 # rm -f new-params
29003 # touch new-params
29004 # chown exim:exim new-params
29005 # chmod 0600 new-params
29006 # certtool --generate-dh-params --bits 2236 >>new-params
29007 # openssl dhparam -noout -text -in new-params | head
29008 [ check the first line, make sure it's not more than 2236;
29009   if it is, then go back to the start ("rm") and repeat
29010   until the size generated is at most the size requested ]
29011 # chmod 0400 new-params
29012 # mv new-params gnutls-params-2236
29013 .endd
29014 If Exim never has to generate the parameters itself, the possibility of
29015 stalling is removed.
29016
29017 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
29018 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
29019 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
29020 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
29021 and Exim does so.  This attempt to remove Exim from TLS policy decisions
29022 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
29023 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
29024 which applies to all D-H usage, client or server.  If the value returned by
29025 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
29026 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
29027 limit, which is still much higher than Exim historically used.
29028
29029 The filename and bits used will change as the GnuTLS maintainers change the
29030 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
29031 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
29032 2432 bits, while NSS is limited to 2236 bits.
29033
29034 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
29035 increase the chance of the generated prime actually being within acceptable
29036 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
29037 procedure above.  There is no sane procedure available to Exim to double-check
29038 the size of the generated prime, so it might still be too large.
29039
29040
29041 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
29042 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
29043 .oindex "&%tls_require_ciphers%&" "OpenSSL"
29044 There is a function in the OpenSSL library that can be passed a list of cipher
29045 suites before the cipher negotiation takes place. This specifies which ciphers
29046 are acceptable for TLS versions prior to 1.3.
29047 The list is colon separated and may contain names like
29048 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
29049 directly to this function call.
29050 Many systems will install the OpenSSL manual-pages, so you may have
29051 &'ciphers(1)'& available to you.
29052 The following quotation from the OpenSSL
29053 documentation specifies what forms of item are allowed in the cipher string:
29054
29055 .ilist
29056 It can consist of a single cipher suite such as RC4-SHA.
29057 .next
29058 It can represent a list of cipher suites containing a certain algorithm,
29059 or cipher suites of a certain type. For example SHA1 represents all
29060 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
29061 SSL v3 algorithms.
29062 .next
29063 Lists of cipher suites can be combined in a single cipher string using
29064 the + character. This is used as a logical and operation. For example
29065 SHA1+DES represents all cipher suites containing the SHA1 and the DES
29066 algorithms.
29067 .endlist
29068
29069 Each cipher string can be optionally preceded by one of the characters &`!`&,
29070 &`-`& or &`+`&.
29071 .ilist
29072 If &`!`& is used, the ciphers are permanently deleted from the list. The
29073 ciphers deleted can never reappear in the list even if they are explicitly
29074 stated.
29075 .next
29076 If &`-`& is used, the ciphers are deleted from the list, but some or all
29077 of the ciphers can be added again by later options.
29078 .next
29079 If &`+`& is used, the ciphers are moved to the end of the list. This
29080 option does not add any new ciphers; it just moves matching existing ones.
29081 .endlist
29082
29083 If none of these characters is present, the string is interpreted as
29084 a list of ciphers to be appended to the current preference list. If the list
29085 includes any ciphers already present they will be ignored: that is, they will
29086 not be moved to the end of the list.
29087 .endlist
29088
29089 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
29090 string:
29091 .code
29092 # note single-quotes to get ! past any shell history expansion
29093 $ openssl ciphers 'HIGH:!MD5:!SHA1'
29094 .endd
29095
29096 This example will let the library defaults be permitted on the MX port, where
29097 there's probably no identity verification anyway, but ups the ante on the
29098 submission ports where the administrator might have some influence on the
29099 choice of clients used:
29100 .code
29101 # OpenSSL variant; see man ciphers(1)
29102 tls_require_ciphers = ${if =={$received_port}{25}\
29103                            {DEFAULT}\
29104                            {HIGH:!MD5:!SHA1}}
29105 .endd
29106
29107 This example will prefer ECDSA-authenticated ciphers over RSA ones:
29108 .code
29109 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
29110 .endd
29111
29112 For TLS version 1.3 the control available is less fine-grained
29113 and Exim does not provide access to it at present.
29114 The value of the &%tls_require_ciphers%& option is ignored when
29115 TLS version 1.3 is negotiated.
29116
29117 As of writing the library default cipher suite list for TLSv1.3 is
29118 .code
29119 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
29120 .endd
29121
29122
29123 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
29124          "SECTreqciphgnu"
29125 .cindex "GnuTLS" "specifying parameters for"
29126 .cindex "TLS" "specifying ciphers (GnuTLS)"
29127 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
29128 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
29129 .cindex "TLS" "specifying protocols (GnuTLS)"
29130 .cindex "TLS" "specifying priority string (GnuTLS)"
29131 .oindex "&%tls_require_ciphers%&" "GnuTLS"
29132 The GnuTLS library allows the caller to provide a "priority string", documented
29133 as part of the &[gnutls_priority_init]& function.  This is very similar to the
29134 ciphersuite specification in OpenSSL.
29135
29136 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
29137 and controls both protocols and ciphers.
29138
29139 The &%tls_require_ciphers%& option is available both as an global option,
29140 controlling how Exim behaves as a server, and also as an option of the
29141 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
29142 the value is string expanded.  The resulting string is not an Exim list and
29143 the string is given to the GnuTLS library, so that Exim does not need to be
29144 aware of future feature enhancements of GnuTLS.
29145
29146 Documentation of the strings accepted may be found in the GnuTLS manual, under
29147 "Priority strings".  This is online as
29148 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
29149 but beware that this relates to GnuTLS 3, which may be newer than the version
29150 installed on your system.  If you are using GnuTLS 3,
29151 then the example code
29152 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
29153 on that site can be used to test a given string.
29154
29155 For example:
29156 .code
29157 # Disable older versions of protocols
29158 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
29159 .endd
29160
29161 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
29162 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
29163 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
29164
29165 This example will let the library defaults be permitted on the MX port, where
29166 there's probably no identity verification anyway, and lowers security further
29167 by increasing compatibility; but this ups the ante on the submission ports
29168 where the administrator might have some influence on the choice of clients
29169 used:
29170 .code
29171 # GnuTLS variant
29172 tls_require_ciphers = ${if =={$received_port}{25}\
29173                            {NORMAL:%COMPAT}\
29174                            {SECURE128}}
29175 .endd
29176
29177
29178 .section "Configuring an Exim server to use TLS" "SECID182"
29179 .cindex "TLS" "configuring an Exim server"
29180 .cindex "ESMTP extensions" STARTTLS
29181 When Exim has been built with TLS support, it advertises the availability of
29182 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
29183 but not to any others. The default value of this option is *, which means
29184 that STARTTLS is always advertised.  Set it to blank to never advertise;
29185 this is reasonable for systems that want to use TLS only as a client.
29186
29187 If STARTTLS is to be used you
29188 need to set some other options in order to make TLS available.
29189
29190 If a client issues a STARTTLS command and there is some configuration
29191 problem in the server, the command is rejected with a 454 error. If the client
29192 persists in trying to issue SMTP commands, all except QUIT are rejected
29193 with the error
29194 .code
29195 554 Security failure
29196 .endd
29197 If a STARTTLS command is issued within an existing TLS session, it is
29198 rejected with a 554 error code.
29199
29200 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
29201 must be set to match some hosts. The default is * which matches all hosts.
29202
29203 If this is all you do, TLS encryption will be enabled but not authentication -
29204 meaning that the peer has no assurance it is actually you he is talking to.
29205 You gain protection from a passive sniffer listening on the wire but not
29206 from someone able to intercept the communication.
29207
29208 Further protection requires some further configuration at the server end.
29209
29210 To make TLS work you need to set, in the server,
29211 .code
29212 tls_certificate = /some/file/name
29213 tls_privatekey = /some/file/name
29214 .endd
29215 These options are, in fact, expanded strings, so you can make them depend on
29216 the identity of the client that is connected if you wish. The first file
29217 contains the server's X509 certificate, and the second contains the private key
29218 that goes with it. These files need to be
29219 PEM format and readable by the Exim user, and must
29220 always be given as full path names.
29221 The key must not be password-protected.
29222 They can be the same file if both the
29223 certificate and the key are contained within it. If &%tls_privatekey%& is not
29224 set, or if its expansion is forced to fail or results in an empty string, this
29225 is assumed to be the case. The certificate file may also contain intermediate
29226 certificates that need to be sent to the client to enable it to authenticate
29227 the server's certificate.
29228
29229 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
29230 colon-separated lists of file paths.  Ciphers using given authentication
29231 algorithms require the presence of a suitable certificate to supply the
29232 public-key.  The server selects among the certificates to present to the
29233 client depending on the selected cipher, hence the priority ordering for
29234 ciphers will affect which certificate is used.
29235
29236 If you do not understand about certificates and keys, please try to find a
29237 source of this background information, which is not Exim-specific. (There are a
29238 few comments below in section &<<SECTcerandall>>&.)
29239
29240 &*Note*&: These options do not apply when Exim is operating as a client &--
29241 they apply only in the case of a server. If you need to use a certificate in an
29242 Exim client, you must set the options of the same names in an &(smtp)&
29243 transport.
29244
29245 With just these options, an Exim server will be able to use TLS. It does not
29246 require the client to have a certificate (but see below for how to insist on
29247 this). There is one other option that may be needed in other situations. If
29248 .code
29249 tls_dhparam = /some/file/name
29250 .endd
29251 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
29252 with the parameters contained in the file.
29253 Set this to &`none`& to disable use of DH entirely, by making no prime
29254 available:
29255 .code
29256 tls_dhparam = none
29257 .endd
29258 This may also be set to a string identifying a standard prime to be used for
29259 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
29260 used is &`ike23`&.  There are a few standard primes available, see the
29261 documentation for &%tls_dhparam%& for the complete list.
29262
29263 See the command
29264 .code
29265 openssl dhparam
29266 .endd
29267 for a way of generating file data.
29268
29269 The strings supplied for these three options are expanded every time a client
29270 host connects. It is therefore possible to use different certificates and keys
29271 for different hosts, if you so wish, by making use of the client's IP address
29272 in &$sender_host_address$& to control the expansion. If a string expansion is
29273 forced to fail, Exim behaves as if the option is not set.
29274
29275 .cindex "cipher" "logging"
29276 .cindex "log" "TLS cipher"
29277 .vindex "&$tls_in_cipher$&"
29278 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29279 an incoming TLS connection. It is included in the &'Received:'& header of an
29280 incoming message (by default &-- you can, of course, change this), and it is
29281 also included in the log line that records a message's arrival, keyed by
29282 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29283 condition can be used to test for specific cipher suites in ACLs.
29284
29285 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29286 can check the name of the cipher suite and vary their actions accordingly. The
29287 cipher suite names vary, depending on which TLS library is being used. For
29288 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29289 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29290 documentation for more details.
29291
29292 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29293 (again depending on the &%tls_cipher%& log selector).
29294
29295
29296 .section "Requesting and verifying client certificates" "SECID183"
29297 .cindex "certificate" "verification of client"
29298 .cindex "TLS" "client certificate verification"
29299 If you want an Exim server to request a certificate when negotiating a TLS
29300 session with a client, you must set either &%tls_verify_hosts%& or
29301 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29302 apply to all TLS connections. For any host that matches one of these options,
29303 Exim requests a certificate as part of the setup of the TLS session. The
29304 contents of the certificate are verified by comparing it with a list of
29305 expected trust-anchors or certificates.
29306 These may be the system default set (depending on library version),
29307 an explicit file or,
29308 depending on library version, a directory, identified by
29309 &%tls_verify_certificates%&.
29310
29311 A file can contain multiple certificates, concatenated end to end. If a
29312 directory is used
29313 (OpenSSL only),
29314 each certificate must be in a separate file, with a name (or a symbolic link)
29315 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29316 certificate. You can compute the relevant hash by running the command
29317 .code
29318 openssl x509 -hash -noout -in /cert/file
29319 .endd
29320 where &_/cert/file_& contains a single certificate.
29321
29322 There is no checking of names of the client against the certificate
29323 Subject Name or Subject Alternate Names.
29324
29325 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29326 what happens if the client does not supply a certificate, or if the certificate
29327 does not match any of the certificates in the collection named by
29328 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29329 attempt to set up a TLS session is aborted, and the incoming connection is
29330 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29331 session continues. ACLs that run for subsequent SMTP commands can detect the
29332 fact that no certificate was verified, and vary their actions accordingly. For
29333 example, you can insist on a certificate before accepting a message for
29334 relaying, but not when the message is destined for local delivery.
29335
29336 .vindex "&$tls_in_peerdn$&"
29337 When a client supplies a certificate (whether it verifies or not), the value of
29338 the Distinguished Name of the certificate is made available in the variable
29339 &$tls_in_peerdn$& during subsequent processing of the message.
29340
29341 .cindex "log" "distinguished name"
29342 Because it is often a long text string, it is not included in the log line or
29343 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29344 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29345 &%received_header_text%& to change the &'Received:'& header. When no
29346 certificate is supplied, &$tls_in_peerdn$& is empty.
29347
29348
29349 .section "Revoked certificates" "SECID184"
29350 .cindex "TLS" "revoked certificates"
29351 .cindex "revocation list"
29352 .cindex "certificate" "revocation list"
29353 .cindex "OCSP" "stapling"
29354 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29355 certificates are revoked. If you have such a list, you can pass it to an Exim
29356 server using the global option called &%tls_crl%& and to an Exim client using
29357 an identically named option for the &(smtp)& transport. In each case, the value
29358 of the option is expanded and must then be the name of a file that contains a
29359 CRL in PEM format.
29360 The downside is that clients have to periodically re-download a potentially huge
29361 file from every certificate authority they know of.
29362
29363 The way with most moving parts at query time is Online Certificate
29364 Status Protocol (OCSP), where the client verifies the certificate
29365 against an OCSP server run by the CA.  This lets the CA track all
29366 usage of the certs.  It requires running software with access to the
29367 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29368 is based on HTTP and can be proxied accordingly.
29369
29370 The only widespread OCSP server implementation (known to this writer)
29371 comes as part of OpenSSL and aborts on an invalid request, such as
29372 connecting to the port and then disconnecting.  This requires
29373 re-entering the passphrase each time some random client does this.
29374
29375 The third way is OCSP Stapling; in this, the server using a certificate
29376 issued by the CA periodically requests an OCSP proof of validity from
29377 the OCSP server, then serves it up inline as part of the TLS
29378 negotiation.   This approach adds no extra round trips, does not let the
29379 CA track users, scales well with number of certs issued by the CA and is
29380 resilient to temporary OCSP server failures, as long as the server
29381 starts retrying to fetch an OCSP proof some time before its current
29382 proof expires.  The downside is that it requires server support.
29383
29384 Unless Exim is built with the support disabled,
29385 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29386 support for OCSP stapling is included.
29387
29388 There is a global option called &%tls_ocsp_file%&.
29389 The file specified therein is expected to be in DER format, and contain
29390 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29391 option will be re-expanded for SNI, if the &%tls_certificate%& option
29392 contains &`tls_in_sni`&, as per other TLS options.
29393
29394 Exim does not at this time implement any support for fetching a new OCSP
29395 proof.  The burden is on the administrator to handle this, outside of
29396 Exim.  The file specified should be replaced atomically, so that the
29397 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29398 on each connection, so a new file will be handled transparently on the
29399 next connection.
29400
29401 When built with OpenSSL Exim will check for a valid next update timestamp
29402 in the OCSP proof; if not present, or if the proof has expired, it will be
29403 ignored.
29404
29405 For the client to be able to verify the stapled OCSP the server must
29406 also supply, in its stapled information, any intermediate
29407 certificates for the chain leading to the OCSP proof from the signer
29408 of the server certificate.  There may be zero or one such. These
29409 intermediate certificates should be added to the server OCSP stapling
29410 file named by &%tls_ocsp_file%&.
29411
29412 Note that the proof only covers the terminal server certificate,
29413 not any of the chain from CA to it.
29414
29415 There is no current way to staple a proof for a client certificate.
29416
29417 .code
29418   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29419   OCSP server is supplied.  The server URL may be included in the
29420   server certificate, if the CA is helpful.
29421
29422   One failure mode seen was the OCSP Signer cert expiring before the end
29423   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29424   noted this as invalid overall, but the re-fetch script did not.
29425 .endd
29426
29427
29428 .new
29429 .section "Caching of static server configuration items" "SECTserverTLScache"
29430 .cindex certificate caching
29431 .cindex privatekey caching
29432 .cindex crl caching
29433 .cindex ocsp caching
29434 .cindex ciphers caching
29435 .cindex "CA bundle" caching
29436 .cindex "certificate authorities" caching
29437 .cindex tls_certificate caching
29438 .cindex tls_privatekey caching
29439 .cindex tls_crl caching
29440 .cindex tls_ocsp_file caching
29441 .cindex tls_require_ciphers caching
29442 .cindex tls_verify_certificate caching
29443 .cindex caching certificate
29444 .cindex caching privatekey
29445 .cindex caching crl
29446 .cindex caching ocsp
29447 .cindex caching ciphers
29448 .cindex caching "certificate authorities
29449 If any of the main configuration options &%tls_certificate%&, &%tls_privatekey%&,
29450 &%tls_crl%& and &%tls_ocsp_file%& have values with no
29451 expandable elements,
29452 then the associated information is loaded at daemon startup.
29453 It is made available
29454 to child processes forked for handling received SMTP connections.
29455
29456 This caching is currently only supported under Linux and FreeBSD.
29457
29458 If caching is not possible, for example if an item has to be dependent
29459 on the peer host so contains a &$sender_host_name$& expansion, the load
29460 of the associated information is done at the startup of the TLS connection.
29461
29462 The cache is invalidated and reloaded after any changes to the directories
29463 containing files specified by these options.
29464
29465 The information specified by the main option &%tls_verify_certificates%&
29466 is similarly cached so long as it specifies files explicitly
29467 or (under GnuTLS) is the string &"system,cache"&.
29468 The latter case is not automatically invalidated;
29469 it is the operator's responsibility to arrange for a daemon restart
29470 any time the system certificate authority bundle is updated.
29471 A HUP signal is sufficient for this.
29472 The value &"system"& results in no caching under GnuTLS.
29473
29474 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29475 is acceptable in configurations for the Exim executavble.
29476
29477 Caching of the system Certificate Authorities bundle can
29478 save siginificant time and processing on every TLS connection
29479 accepted by Exim.
29480 .wen
29481
29482
29483
29484
29485 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29486 .cindex "cipher" "logging"
29487 .cindex "log" "TLS cipher"
29488 .cindex "log" "distinguished name"
29489 .cindex "TLS" "configuring an Exim client"
29490 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29491 deliveries as well as to incoming, the latter one causing logging of the
29492 server certificate's DN. The remaining client configuration for TLS is all
29493 within the &(smtp)& transport.
29494
29495 .cindex "ESMTP extensions" STARTTLS
29496 It is not necessary to set any options to have TLS work in the &(smtp)&
29497 transport. If Exim is built with TLS support, and TLS is advertised by a
29498 server, the &(smtp)& transport always tries to start a TLS session. However,
29499 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29500 transport) to a list of server hosts for which TLS should not be used.
29501
29502 If you do not want Exim to attempt to send messages unencrypted when an attempt
29503 to set up an encrypted connection fails in any way, you can set
29504 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29505 those hosts, delivery is always deferred if an encrypted connection cannot be
29506 set up. If there are any other hosts for the address, they are tried in the
29507 usual way.
29508
29509 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29510 the message unencrypted. It always does this if the response to STARTTLS is
29511 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29512 session after a success response code, what happens is controlled by the
29513 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29514 delivery to this host is deferred, and other hosts (if available) are tried. If
29515 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29516 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29517 negotiation fails, Exim closes the current connection (because it is in an
29518 unknown state), opens a new one to the same host, and then tries the delivery
29519 unencrypted.
29520
29521 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29522 transport provide the client with a certificate, which is passed to the server
29523 if it requests it.
29524 This is an optional thing for TLS connections, although either end
29525 may insist on it.
29526 If the server is Exim, it will request a certificate only if
29527 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29528
29529 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29530 for client use (they are usable for server use).
29531 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29532 in failed connections.
29533
29534 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29535 specifies a collection of expected server certificates.
29536 These may be
29537 the system default set (depending on library version),
29538 a file,
29539 or (depending on library version) a directory.
29540 The client verifies the server's certificate
29541 against this collection, taking into account any revoked certificates that are
29542 in the list defined by &%tls_crl%&.
29543 Failure to verify fails the TLS connection unless either of the
29544 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29545
29546 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29547 certificate verification to the listed servers.  Verification either must
29548 or need not succeed respectively.
29549
29550 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29551 name checks are made on the server certificate.
29552 .new
29553 The match against this list is, as per other Exim usage, the
29554 IP for the host.  That is most closely associated with the
29555 name on the DNS A (or AAAA) record for the host.
29556 However, the name that needs to be in the certificate
29557 is the one at the head of any CNAME chain leading to the A record.
29558 .wen
29559 The option defaults to always checking.
29560
29561 The &(smtp)& transport has two OCSP-related options:
29562 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29563 is requested and required for the connection to proceed.  The default
29564 value is empty.
29565 &%hosts_request_ocsp%&; a host-list for which (additionally)
29566 a Certificate Status is requested (but not necessarily verified).  The default
29567 value is "*" meaning that requests are made unless configured
29568 otherwise.
29569
29570 The host(s) should also be in &%hosts_require_tls%&, and
29571 &%tls_verify_certificates%& configured for the transport,
29572 for OCSP to be relevant.
29573
29574 If
29575 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29576 list of permitted cipher suites. If either of these checks fails, delivery to
29577 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29578 alternative hosts, if any.
29579
29580  &*Note*&:
29581 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29582 is operating as a client. Exim does not assume that a server certificate (set
29583 by the global options of the same name) should also be used when operating as a
29584 client.
29585
29586 .vindex "&$host$&"
29587 .vindex "&$host_address$&"
29588 All the TLS options in the &(smtp)& transport are expanded before use, with
29589 &$host$& and &$host_address$& containing the name and address of the server to
29590 which the client is connected. Forced failure of an expansion causes Exim to
29591 behave as if the relevant option were unset.
29592
29593 .vindex &$tls_out_bits$&
29594 .vindex &$tls_out_cipher$&
29595 .vindex &$tls_out_peerdn$&
29596 .vindex &$tls_out_sni$&
29597 Before an SMTP connection is established, the
29598 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29599 variables are emptied. (Until the first connection, they contain the values
29600 that were set when the message was received.) If STARTTLS is subsequently
29601 successfully obeyed, these variables are set to the relevant values for the
29602 outgoing connection.
29603
29604
29605
29606 .new
29607 .section "Caching of static client configuration items" "SECTclientTLScache"
29608 .cindex certificate caching
29609 .cindex privatekey caching
29610 .cindex crl caching
29611 .cindex ciphers caching
29612 .cindex "CA bundle" caching
29613 .cindex "certificate authorities" caching
29614 .cindex tls_certificate caching
29615 .cindex tls_privatekey caching
29616 .cindex tls_crl caching
29617 .cindex tls_require_ciphers caching
29618 .cindex tls_verify_certificate caching
29619 .cindex caching certificate
29620 .cindex caching privatekey
29621 .cindex caching crl
29622 .cindex caching ciphers
29623 .cindex caching "certificate authorities
29624 If any of the transport configuration options &%tls_certificate%&, &%tls_privatekey%&
29625 and &%tls_crl%& have values with no
29626 expandable elements,
29627 then the associated information is loaded per smtp transport
29628 at daemon startup, at the start of a queue run, or on a
29629 command-line specified message delivery.
29630 It is made available
29631 to child processes forked for handling making SMTP connections.
29632
29633 This caching is currently only supported under Linux.
29634
29635 If caching is not possible, the load
29636 of the associated information is done at the startup of the TLS connection.
29637
29638 The cache is invalidated in the daemon
29639 and reloaded after any changes to the directories
29640 containing files specified by these options.
29641
29642 The information specified by the main option &%tls_verify_certificates%&
29643 is similarly cached so long as it specifies files explicitly
29644 or (under GnuTLS) is the string &"system,cache"&.
29645 The latter case is not automatically invaludated;
29646 it is the operator's responsibility to arrange for a daemon restart
29647 any time the system certificate authority bundle is updated.
29648 A HUP signal is sufficient for this.
29649 The value &"system"& results in no caching under GnuTLS.
29650
29651 The macro _HAVE_TLS_CA_CACHE will be defined if the suffix for "system"
29652 is acceptable in configurations for the Exim executavble.
29653
29654 Caching of the system Certificate Authorities bundle can
29655 save siginificant time and processing on every TLS connection
29656 initiated by Exim.
29657 .wen
29658
29659
29660
29661
29662 .section "Use of TLS Server Name Indication" "SECTtlssni"
29663 .cindex "TLS" "Server Name Indication"
29664 .cindex "TLS" SNI
29665 .cindex SNI
29666 .vindex "&$tls_in_sni$&"
29667 .oindex "&%tls_in_sni%&"
29668 With TLS1.0 or above, there is an extension mechanism by which extra
29669 information can be included at various points in the protocol.  One of these
29670 extensions, documented in RFC 6066 (and before that RFC 4366) is
29671 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29672 client in the initial handshake, so that the server can examine the servername
29673 within and possibly choose to use different certificates and keys (and more)
29674 for this session.
29675
29676 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29677 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29678 address.
29679
29680 With SMTP to MX, there are the same problems here as in choosing the identity
29681 against which to validate a certificate: you can't rely on insecure DNS to
29682 provide the identity which you then cryptographically verify.  So this will
29683 be of limited use in that environment.
29684
29685 With SMTP to Submission, there is a well-defined hostname which clients are
29686 connecting to and can validate certificates against.  Thus clients &*can*&
29687 choose to include this information in the TLS negotiation.  If this becomes
29688 wide-spread, then hosters can choose to present different certificates to
29689 different clients.  Or even negotiate different cipher suites.
29690
29691 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29692 if not empty, will be sent on a TLS session as part of the handshake.  There's
29693 nothing more to it.  Choosing a sensible value not derived insecurely is the
29694 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29695 for the lifetime of the client connection (including during authentication).
29696
29697 .new
29698 If DANE validated the connection attempt then the value of the &%tls_sni%& option
29699 is forced to the domain part of the recipient address.
29700 .wen
29701
29702 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29703 received from a client.
29704 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29705
29706 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29707 option (prior to expansion) then the following options will be re-expanded
29708 during TLS session handshake, to permit alternative values to be chosen:
29709
29710 .ilist
29711 &%tls_certificate%&
29712 .next
29713 &%tls_crl%&
29714 .next
29715 &%tls_privatekey%&
29716 .next
29717 &%tls_verify_certificates%&
29718 .next
29719 &%tls_ocsp_file%&
29720 .endlist
29721
29722 Great care should be taken to deal with matters of case, various injection
29723 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29724 can always be referenced; it is important to remember that &$tls_in_sni$& is
29725 arbitrary unverified data provided prior to authentication.
29726 Further, the initial certificate is loaded before SNI has arrived, so
29727 an expansion for &%tls_certificate%& must have a default which is used
29728 when &$tls_in_sni$& is empty.
29729
29730 The Exim developers are proceeding cautiously and so far no other TLS options
29731 are re-expanded.
29732
29733 When Exim is built against OpenSSL, OpenSSL must have been built with support
29734 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29735 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29736 see &`-servername`& in the output, then OpenSSL has support.
29737
29738 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29739 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29740 built, then you have SNI support).
29741
29742
29743
29744 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29745          "SECTmulmessam"
29746 .cindex "multiple SMTP deliveries with TLS"
29747 .cindex "TLS" "multiple message deliveries"
29748 Exim sends multiple messages down the same TCP/IP connection by starting up
29749 an entirely new delivery process for each message, passing the socket from
29750 one process to the next. This implementation does not fit well with the use
29751 of TLS, because there is quite a lot of state information associated with a TLS
29752 connection, not just a socket identification. Passing all the state information
29753 to a new process is not feasible. Consequently, for sending using TLS Exim
29754 starts an additional proxy process for handling the encryption, piping the
29755 unencrypted data stream from and to the delivery processes.
29756
29757 An older mode of operation can be enabled on a per-host basis by the
29758 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29759 this list the proxy process described above is not used; instead Exim
29760 shuts down an existing TLS session being run by the delivery process
29761 before passing the socket to a new process. The new process may then
29762 try to start a new TLS session, and if successful, may try to re-authenticate
29763 if AUTH is in use, before sending the next message.
29764
29765 The RFC is not clear as to whether or not an SMTP session continues in clear
29766 after TLS has been shut down, or whether TLS may be restarted again later, as
29767 just described. However, if the server is Exim, this shutdown and
29768 reinitialization works. It is not known which (if any) other servers operate
29769 successfully if the client closes a TLS session and continues with unencrypted
29770 SMTP, but there are certainly some that do not work. For such servers, Exim
29771 should not pass the socket to another process, because the failure of the
29772 subsequent attempt to use it would cause Exim to record a temporary host error,
29773 and delay other deliveries to that host.
29774
29775 To test for this case, Exim sends an EHLO command to the server after
29776 closing down the TLS session. If this fails in any way, the connection is
29777 closed instead of being passed to a new delivery process, but no retry
29778 information is recorded.
29779
29780 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29781 &(smtp)& transport to match those hosts for which Exim should not pass
29782 connections to new processes if TLS has been used.
29783
29784
29785
29786
29787 .section "Certificates and all that" "SECTcerandall"
29788 .cindex "certificate" "references to discussion"
29789 In order to understand fully how TLS works, you need to know about
29790 certificates, certificate signing, and certificate authorities.
29791 This is a large topic and an introductory guide is unsuitable for the Exim
29792 reference manual, so instead we provide pointers to existing documentation.
29793
29794 The Apache web-server was for a long time the canonical guide, so their
29795 documentation is a good place to start; their SSL module's Introduction
29796 document is currently at
29797 .display
29798 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29799 .endd
29800 and their FAQ is at
29801 .display
29802 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29803 .endd
29804
29805 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29806 0-201-61598-3) in 2001, contains both introductory and more in-depth
29807 descriptions.
29808 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29809 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29810 Ivan is the author of the popular TLS testing tools at
29811 &url(https://www.ssllabs.com/).
29812
29813
29814 .section "Certificate chains" "SECID186"
29815 A file named by &%tls_certificate%& may contain more than one
29816 certificate. This is useful in the case where the certificate that is being
29817 sent is validated by an intermediate certificate which the other end does
29818 not have. Multiple certificates must be in the correct order in the file.
29819 First the host's certificate itself, then the first intermediate
29820 certificate to validate the issuer of the host certificate, then the next
29821 intermediate certificate to validate the issuer of the first intermediate
29822 certificate, and so on, until finally (optionally) the root certificate.
29823 The root certificate must already be trusted by the recipient for
29824 validation to succeed, of course, but if it's not preinstalled, sending the
29825 root certificate along with the rest makes it available for the user to
29826 install if the receiving end is a client MUA that can interact with a user.
29827
29828 Note that certificates using MD5 are unlikely to work on today's Internet;
29829 even if your libraries allow loading them for use in Exim when acting as a
29830 server, increasingly clients will not accept such certificates.  The error
29831 diagnostics in such a case can be frustratingly vague.
29832
29833
29834
29835 .section "Self-signed certificates" "SECID187"
29836 .cindex "certificate" "self-signed"
29837 You can create a self-signed certificate using the &'req'& command provided
29838 with OpenSSL, like this:
29839 . ==== Do not shorten the duration here without reading and considering
29840 . ==== the text below.  Please leave it at 9999 days.
29841 .code
29842 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29843             -days 9999 -nodes
29844 .endd
29845 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29846 delimited and so can be identified independently. The &%-days%& option
29847 specifies a period for which the certificate is valid. The &%-nodes%& option is
29848 important: if you do not set it, the key is encrypted with a passphrase
29849 that you are prompted for, and any use that is made of the key causes more
29850 prompting for the passphrase. This is not helpful if you are going to use
29851 this certificate and key in an MTA, where prompting is not possible.
29852
29853 . ==== I expect to still be working 26 years from now.  The less technical
29854 . ==== debt I create, in terms of storing up trouble for my later years, the
29855 . ==== happier I will be then.  We really have reached the point where we
29856 . ==== should start, at the very least, provoking thought and making folks
29857 . ==== pause before proceeding, instead of leaving all the fixes until two
29858 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29859 . ==== -pdp, 2012
29860 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29861 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29862 the above command might produce a date in the past.  Think carefully about
29863 the lifetime of the systems you're deploying, and either reduce the duration
29864 of the certificate or reconsider your platform deployment.  (At time of
29865 writing, reducing the duration is the most likely choice, but the inexorable
29866 progression of time takes us steadily towards an era where this will not
29867 be a sensible resolution).
29868
29869 A self-signed certificate made in this way is sufficient for testing, and
29870 may be adequate for all your requirements if you are mainly interested in
29871 encrypting transfers, and not in secure identification.
29872
29873 However, many clients require that the certificate presented by the server be a
29874 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29875 certificate. In this situation, the self-signed certificate described above
29876 must be installed on the client host as a trusted root &'certification
29877 authority'& (CA), and the certificate used by Exim must be a user certificate
29878 signed with that self-signed certificate.
29879
29880 For information on creating self-signed CA certificates and using them to sign
29881 user certificates, see the &'General implementation overview'& chapter of the
29882 Open-source PKI book, available online at
29883 &url(https://sourceforge.net/projects/ospkibook/).
29884 .ecindex IIDencsmtp1
29885 .ecindex IIDencsmtp2
29886
29887
29888 .new
29889 .section "TLS Resumption" "SECTresumption"
29890 .cindex TLS resumption
29891 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29892 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29893 (or later).
29894
29895 Session resumption (this is the "stateless" variant) involves the server sending
29896 a "session ticket" to the client on one connection, which can be stored by the
29897 client and used for a later session.  The ticket contains sufficient state for
29898 the server to reconstruct the TLS session, avoiding some expensive crypto
29899 calculation and (on TLS1.2) one full packet roundtrip time.
29900
29901 .ilist
29902 Operational cost/benefit:
29903
29904  The extra data being transmitted costs a minor amount, and the client has
29905  extra costs in storing and retrieving the data.
29906
29907  In the Exim/Gnutls implementation the extra cost on an initial connection
29908  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29909  The saved cost on a subsequent connection is about 4ms; three or more
29910  connections become a net win.  On longer network paths, two or more
29911  connections will have an average lower startup time thanks to the one
29912  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29913  packet roundtrips.
29914
29915 .cindex "hints database" tls
29916  Since a new hints DB is used on the TLS client,
29917  the hints DB maintenance should be updated to additionally handle "tls".
29918
29919 .next
29920 Security aspects:
29921
29922  The session ticket is encrypted, but is obviously an additional security
29923  vulnarability surface.  An attacker able to decrypt it would have access
29924  all connections using the resumed session.
29925  The session ticket encryption key is not committed to storage by the server
29926  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29927  overlap; GnuTLS 6hr but does not specify any overlap).
29928  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29929  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29930
29931  There is a question-mark over the security of the Diffie-Helman parameters
29932  used for session negotiation.
29933
29934 .next
29935 Observability:
29936
29937  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29938  element.
29939
29940  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29941  have bits 0-4 indicating respectively
29942  support built, client requested ticket, client offered session,
29943  server issued ticket, resume used.  A suitable decode list is provided
29944  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29945
29946 .next
29947 Control:
29948
29949 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29950 exim, operating as a server, will offer resumption to clients.
29951 Current best practice is to not offer the feature to MUA connection.
29952 Commonly this can be done like this:
29953 .code
29954 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29955 .endd
29956 If the peer host matches the list after expansion then resumption
29957 is offered and/or accepted.
29958
29959 The &%tls_resumption_hosts%& smtp transport option performs the
29960 equivalent function for operation as a client.
29961 If the peer host matches the list after expansion then resumption
29962 is attempted (if a stored session is available) or the information
29963 stored (if supplied by the peer).
29964
29965
29966 .next
29967 Issues:
29968
29969  In a resumed session:
29970 .ilist
29971   The variables &$tls_{in,out}_cipher$& will have values different
29972  to the original (under GnuTLS).
29973 .next
29974   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29975  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29976 . XXX need to do something with that hosts_require_ocsp
29977 .endlist
29978
29979 .endlist
29980 .wen
29981
29982
29983 .section DANE "SECDANE"
29984 .cindex DANE
29985 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29986 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29987 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29988 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29989 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29990 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29991
29992 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29993 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29994 by (a) is thought to be smaller than that of the set of root CAs.
29995
29996 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29997 fail to pass on a server's STARTTLS.
29998
29999 DANE scales better than having to maintain (and communicate via side-channel) copies of server certificates
30000 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
30001 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
30002
30003 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
30004 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
30005 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
30006 DNSSEC.
30007 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
30008 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
30009
30010 There are no changes to Exim specific to server-side operation of DANE.
30011 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
30012 in &_Local/Makefile_&.
30013 If it has been included, the macro "_HAVE_DANE" will be defined.
30014
30015 A TLSA record consist of 4 fields, the "Certificate Usage", the
30016 "Selector", the "Matching type", and the "Certificate Association Data".
30017 For a detailed description of the TLSA record see
30018 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
30019
30020 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
30021 These are the "Trust Anchor" and "End Entity" variants.
30022 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
30023 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
30024 this is appropriate for a single system, using a self-signed certificate.
30025 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
30026 well-known one.
30027 A private CA at simplest is just a self-signed certificate (with certain
30028 attributes) which is used to sign server certificates, but running one securely
30029 does require careful arrangement.
30030 With DANE-TA, as implemented in Exim and commonly in other MTAs,
30031 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
30032 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
30033 all of which point to a single TLSA record.
30034 DANE-TA and DANE-EE can both be used together.
30035
30036 Our recommendation is to use DANE with a certificate from a public CA,
30037 because this enables a variety of strategies for remote clients to verify
30038 your certificate.
30039 You can then publish information both via DANE and another technology,
30040 "MTA-STS", described below.
30041
30042 When you use DANE-TA to publish trust anchor information, you ask entities
30043 outside your administrative control to trust the Certificate Authority for
30044 connections to you.
30045 If using a private CA then you should expect others to still apply the
30046 technical criteria they'd use for a public CA to your certificates.
30047 In particular, you should probably try to follow current best practices for CA
30048 operation around hash algorithms and key sizes.
30049 Do not expect other organizations to lower their security expectations just
30050 because a particular profile might be reasonable for your own internal use.
30051
30052 When this text was last updated, this in practice means to avoid use of SHA-1
30053 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
30054 than 4096, for interoperability); to use keyUsage fields correctly; to use
30055 random serial numbers.
30056 The list of requirements is subject to change as best practices evolve.
30057 If you're not already using a private CA, or it doesn't meet these
30058 requirements, then we encourage you to avoid all these issues and use a public
30059 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
30060
30061 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
30062 a "Matching Type" (3rd) field of SHA2-512(2).
30063
30064 For the "Certificate Authority Data" (4th) field, commands like
30065
30066 .code
30067   openssl x509 -pubkey -noout <certificate.pem \
30068   | openssl rsa -outform der -pubin 2>/dev/null \
30069   | openssl sha512 \
30070   | awk '{print $2}'
30071 .endd
30072
30073 are workable to create a hash of the certificate's public key.
30074
30075 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
30076
30077 .code
30078   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
30079 .endd
30080
30081 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
30082 is useful for quickly generating TLSA records.
30083
30084
30085 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
30086
30087 The Certificate issued by the CA published in the DANE-TA model should be
30088 issued using a strong hash algorithm.
30089 Exim, and importantly various other MTAs sending to you, will not
30090 re-enable hash algorithms which have been disabled by default in TLS
30091 libraries.
30092 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
30093 interoperability (and probably the maximum too, in 2018).
30094
30095 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
30096 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
30097 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
30098
30099 .code
30100   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
30101                                  {= {4}{$tls_out_tlsa_usage}} } \
30102                          {*}{}}
30103 .endd
30104
30105 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
30106 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
30107 found. If the definition of &%hosts_request_ocsp%& includes the
30108 string "tls_out_tlsa_usage", they are re-expanded in time to
30109 control the OCSP request.
30110
30111 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
30112 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
30113
30114
30115 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
30116 and &%dane_require_tls_ciphers%&.
30117 The &"require"& variant will result in failure if the target host is not
30118 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
30119 the &%dnssec_request_domains%& router or transport option.
30120
30121 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
30122
30123 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using DNSSEC.
30124 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
30125 will be required for the host.  If it does not, the host will not
30126 be used; there is no fallback to non-DANE or non-TLS.
30127
30128 If DANE is requested and usable, then the TLS cipher list configuration
30129 prefers to use the option &%dane_require_tls_ciphers%& and falls
30130 back to &%tls_require_ciphers%& only if that is unset.
30131 This lets you configure "decent crypto" for DANE and "better than nothing
30132 crypto" as the default.  Note though that while GnuTLS lets the string control
30133 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
30134 limited to ciphersuite constraints.
30135
30136 If DANE is requested and useable (see above) the following transport options are ignored:
30137 .code
30138   hosts_require_tls
30139   tls_verify_hosts
30140   tls_try_verify_hosts
30141   tls_verify_certificates
30142   tls_crl
30143   tls_verify_cert_hostnames
30144   tls_sni
30145 .endd
30146
30147 If DANE is not usable, whether requested or not, and CA-anchored
30148 verification evaluation is wanted, the above variables should be set appropriately.
30149
30150 The router and transport option &%dnssec_request_domains%& must not be
30151 set to &"never"&, and &%dnssec_require_domains%& is ignored.
30152
30153 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
30154
30155 There is a new variable &$tls_out_dane$& which will have "yes" if
30156 verification succeeded using DANE and "no" otherwise (only useful
30157 in combination with events; see &<<CHAPevents>>&),
30158 and a new variable &$tls_out_tlsa_usage$& (detailed above).
30159
30160 .cindex DANE reporting
30161 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
30162 to achieve DANE-verified connection, if one was either requested and offered, or
30163 required.  This is intended to support TLS-reporting as defined in
30164 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
30165 The &$event_data$& will be one of the Result Types defined in
30166 Section 4.3 of that document.
30167
30168 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
30169
30170 DANE is specified in published RFCs and decouples certificate authority trust
30171 selection from a "race to the bottom" of "you must trust everything for mail
30172 to get through".  There is an alternative technology called MTA-STS, which
30173 instead publishes MX trust anchor information on an HTTPS website.  At the
30174 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
30175 Exim has no support for MTA-STS as a client, but Exim mail server operators
30176 can choose to publish information describing their TLS configuration using
30177 MTA-STS to let those clients who do use that protocol derive trust
30178 information.
30179
30180 The MTA-STS design requires a certificate from a public Certificate Authority
30181 which is recognized by clients sending to you.
30182 That selection of which CAs are trusted by others is outside your control.
30183
30184 The most interoperable course of action is probably to use
30185 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
30186 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
30187 records for DANE clients (such as Exim and Postfix) and to publish anchor
30188 information for MTA-STS as well.  This is what is done for the &'exim.org'&
30189 domain itself (with caveats around occasionally broken MTA-STS because of
30190 incompatible specification changes prior to reaching RFC status).
30191
30192
30193
30194 . ////////////////////////////////////////////////////////////////////////////
30195 . ////////////////////////////////////////////////////////////////////////////
30196
30197 .chapter "Access control lists" "CHAPACL"
30198 .scindex IIDacl "&ACL;" "description"
30199 .cindex "control of incoming mail"
30200 .cindex "message" "controlling incoming"
30201 .cindex "policy control" "access control lists"
30202 Access Control Lists (ACLs) are defined in a separate section of the runtime
30203 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
30204 name, terminated by a colon. Here is a complete ACL section that contains just
30205 one very small ACL:
30206 .code
30207 begin acl
30208 small_acl:
30209   accept   hosts = one.host.only
30210 .endd
30211 You can have as many lists as you like in the ACL section, and the order in
30212 which they appear does not matter. The lists are self-terminating.
30213
30214 The majority of ACLs are used to control Exim's behaviour when it receives
30215 certain SMTP commands. This applies both to incoming TCP/IP connections, and
30216 when a local process submits a message using SMTP by specifying the &%-bs%&
30217 option. The most common use is for controlling which recipients are accepted
30218 in incoming messages. In addition, you can define an ACL that is used to check
30219 local non-SMTP messages. The default configuration file contains an example of
30220 a realistic ACL for checking RCPT commands. This is discussed in chapter
30221 &<<CHAPdefconfil>>&.
30222
30223
30224 .section "Testing ACLs" "SECID188"
30225 The &%-bh%& command line option provides a way of testing your ACL
30226 configuration locally by running a fake SMTP session with which you interact.
30227
30228
30229 .section "Specifying when ACLs are used" "SECID189"
30230 .cindex "&ACL;" "options for specifying"
30231 In order to cause an ACL to be used, you have to name it in one of the relevant
30232 options in the main part of the configuration. These options are:
30233 .cindex "AUTH" "ACL for"
30234 .cindex "DATA" "ACLs for"
30235 .cindex "ETRN" "ACL for"
30236 .cindex "EXPN" "ACL for"
30237 .cindex "HELO" "ACL for"
30238 .cindex "EHLO" "ACL for"
30239 .cindex "DKIM" "ACL for"
30240 .cindex "MAIL" "ACL for"
30241 .cindex "QUIT, ACL for"
30242 .cindex "RCPT" "ACL for"
30243 .cindex "STARTTLS, ACL for"
30244 .cindex "VRFY" "ACL for"
30245 .cindex "SMTP" "connection, ACL for"
30246 .cindex "non-SMTP messages" "ACLs for"
30247 .cindex "MIME content scanning" "ACL for"
30248 .cindex "PRDR" "ACL for"
30249
30250 .table2 140pt
30251 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
30252 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
30253 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
30254 .irow &%acl_smtp_auth%&        "ACL for AUTH"
30255 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
30256 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
30257 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
30258 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
30259 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
30260 .irow &%acl_smtp_expn%&        "ACL for EXPN"
30261 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
30262 .irow &%acl_smtp_mail%&        "ACL for MAIL"
30263 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
30264 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
30265 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
30266 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
30267 .irow &%acl_smtp_quit%&        "ACL for QUIT"
30268 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
30269 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
30270 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
30271 .endtable
30272
30273 For example, if you set
30274 .code
30275 acl_smtp_rcpt = small_acl
30276 .endd
30277 the little ACL defined above is used whenever Exim receives a RCPT command
30278 in an SMTP dialogue. The majority of policy tests on incoming messages can be
30279 done when RCPT commands arrive. A rejection of RCPT should cause the
30280 sending MTA to give up on the recipient address contained in the RCPT
30281 command, whereas rejection at other times may cause the client MTA to keep on
30282 trying to deliver the message. It is therefore recommended that you do as much
30283 testing as possible at RCPT time.
30284
30285
30286 .section "The non-SMTP ACLs" "SECID190"
30287 .cindex "non-SMTP messages" "ACLs for"
30288 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
30289 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
30290 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
30291 the state of the SMTP connection such as encryption and authentication) are not
30292 relevant and are forbidden in these ACLs. However, the sender and recipients
30293 are known, so the &%senders%& and &%sender_domains%& conditions and the
30294 &$sender_address$& and &$recipients$& variables can be used. Variables such as
30295 &$authenticated_sender$& are also available. You can specify added header lines
30296 in any of these ACLs.
30297
30298 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
30299 non-SMTP message, before any of the message has been read. (This is the
30300 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
30301 batched SMTP input, it runs after the DATA command has been reached. The
30302 result of this ACL is ignored; it cannot be used to reject a message. If you
30303 really need to, you could set a value in an ACL variable here and reject based
30304 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
30305 controls, and in particular, it can be used to set
30306 .code
30307 control = suppress_local_fixups
30308 .endd
30309 This cannot be used in the other non-SMTP ACLs because by the time they are
30310 run, it is too late.
30311
30312 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
30313 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30314
30315 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
30316 kind of rejection is treated as permanent, because there is no way of sending a
30317 temporary error for these kinds of message.
30318
30319
30320 .section "The SMTP connect ACL" "SECID191"
30321 .cindex "SMTP" "connection, ACL for"
30322 .oindex &%smtp_banner%&
30323 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
30324 session, after the test specified by &%host_reject_connection%& (which is now
30325 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
30326 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
30327 the message override the banner message that is otherwise specified by the
30328 &%smtp_banner%& option.
30329
30330
30331 .section "The EHLO/HELO ACL" "SECID192"
30332 .cindex "EHLO" "ACL for"
30333 .cindex "HELO" "ACL for"
30334 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
30335 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
30336 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
30337 Note that a client may issue more than one EHLO or HELO command in an SMTP
30338 session, and indeed is required to issue a new EHLO or HELO after successfully
30339 setting up encryption following a STARTTLS command.
30340
30341 Note also that a deny neither forces the client to go away nor means that
30342 mail will be refused on the connection.  Consider checking for
30343 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
30344
30345 If the command is accepted by an &%accept%& verb that has a &%message%&
30346 modifier, the message may not contain more than one line (it will be truncated
30347 at the first newline and a panic logged if it does). Such a message cannot
30348 affect the EHLO options that are listed on the second and subsequent lines of
30349 an EHLO response.
30350
30351
30352 .section "The DATA ACLs" "SECID193"
30353 .cindex "DATA" "ACLs for"
30354 Two ACLs are associated with the DATA command, because it is two-stage
30355 command, with two responses being sent to the client.
30356 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
30357 is obeyed. This gives you control after all the RCPT commands, but before
30358 the message itself is received. It offers the opportunity to give a negative
30359 response to the DATA command before the data is transmitted. Header lines
30360 added by MAIL or RCPT ACLs are not visible at this time, but any that
30361 are defined here are visible when the &%acl_smtp_data%& ACL is run.
30362
30363 You cannot test the contents of the message, for example, to verify addresses
30364 in the headers, at RCPT time or when the DATA command is received. Such
30365 tests have to appear in the ACL that is run after the message itself has been
30366 received, before the final response to the DATA command is sent. This is
30367 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
30368 associated with the DATA command.
30369
30370 .cindex CHUNKING "BDAT command"
30371 .cindex BDAT "SMTP command"
30372 .cindex "RFC 3030" CHUNKING
30373 If CHUNKING was advertised and a BDAT command sequence is received,
30374 the &%acl_smtp_predata%& ACL is not run.
30375 . XXX why not?  It should be possible, for the first BDAT.
30376 The &%acl_smtp_data%& is run after the last BDAT command and all of
30377 the data specified is received.
30378
30379 For both of these ACLs, it is not possible to reject individual recipients. An
30380 error response rejects the entire message. Unfortunately, it is known that some
30381 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
30382 before or after the data) correctly &-- they keep the message on their queues
30383 and try again later, but that is their problem, though it does waste some of
30384 your resources.
30385
30386 The &%acl_smtp_data%& ACL is run after
30387 the &%acl_smtp_data_prdr%&,
30388 the &%acl_smtp_dkim%&
30389 and the &%acl_smtp_mime%& ACLs.
30390
30391 .section "The SMTP DKIM ACL" "SECTDKIMACL"
30392 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
30393 enabled (which is the default).
30394
30395 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30396 received, and is executed for each DKIM signature found in a message.  If not
30397 otherwise specified, the default action is to accept.
30398
30399 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30400
30401 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30402
30403
30404 .section "The SMTP MIME ACL" "SECID194"
30405 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30406 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30407
30408 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30409
30410
30411 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30412 .cindex "PRDR" "ACL for"
30413 .oindex "&%prdr_enable%&"
30414 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30415 with PRDR support enabled (which is the default).
30416 It becomes active only when the PRDR feature is negotiated between
30417 client and server for a message, and more than one recipient
30418 has been accepted.
30419
30420 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30421 has been received, and is executed once for each recipient of the message
30422 with &$local_part$& and &$domain$& valid.
30423 The test may accept, defer or deny for individual recipients.
30424 The &%acl_smtp_data%& will still be called after this ACL and
30425 can reject the message overall, even if this ACL has accepted it
30426 for some or all recipients.
30427
30428 PRDR may be used to support per-user content filtering.  Without it
30429 one must defer any recipient after the first that has a different
30430 content-filter configuration.  With PRDR, the RCPT-time check
30431 .cindex "PRDR" "variable for"
30432 for this can be disabled when the variable &$prdr_requested$&
30433 is &"yes"&.
30434 Any required difference in behaviour of the main DATA-time
30435 ACL should however depend on the PRDR-time ACL having run, as Exim
30436 will avoid doing so in some situations (e.g. single-recipient mails).
30437
30438 See also the &%prdr_enable%& global option
30439 and the &%hosts_try_prdr%& smtp transport option.
30440
30441 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30442 If the ACL is not defined, processing completes as if
30443 the feature was not requested by the client.
30444
30445 .section "The QUIT ACL" "SECTQUITACL"
30446 .cindex "QUIT, ACL for"
30447 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30448 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30449 does not in fact control any access.
30450 For this reason, it may only accept
30451 or warn as its final result.
30452
30453 This ACL can be used for tasks such as custom logging at the end of an SMTP
30454 session. For example, you can use ACL variables in other ACLs to count
30455 messages, recipients, etc., and log the totals at QUIT time using one or
30456 more &%logwrite%& modifiers on a &%warn%& verb.
30457
30458 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30459 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30460
30461 You do not need to have a final &%accept%&, but if you do, you can use a
30462 &%message%& modifier to specify custom text that is sent as part of the 221
30463 response to QUIT.
30464
30465 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30466 failure (for example, failure to open a log file, or when Exim is bombing out
30467 because it has detected an unrecoverable error), all SMTP commands from the
30468 client are given temporary error responses until QUIT is received or the
30469 connection is closed. In these special cases, the QUIT ACL does not run.
30470
30471
30472 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30473 .vindex &$acl_smtp_notquit$&
30474 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30475 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30476 trouble, such as being unable to write to its log files, this ACL is not run,
30477 because it might try to do things (such as write to log files) that make the
30478 situation even worse.
30479
30480 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30481 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30482 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30483 and &%warn%&.
30484
30485 .vindex &$smtp_notquit_reason$&
30486 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30487 to a string that indicates the reason for the termination of the SMTP
30488 connection. The possible values are:
30489 .table2
30490 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30491 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30492 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30493 .irow &`connection-lost`&          "The SMTP connection has been lost"
30494 .irow &`data-timeout`&             "Timeout while reading message data"
30495 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30496 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30497 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30498 .irow &`synchronization-error`&    "SMTP synchronization error"
30499 .irow &`tls-failed`&               "TLS failed to start"
30500 .endtable
30501 In most cases when an SMTP connection is closed without having received QUIT,
30502 Exim sends an SMTP response message before actually closing the connection.
30503 With the exception of the &`acl-drop`& case, the default message can be
30504 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30505 &%drop%& verb in another ACL, it is the message from the other ACL that is
30506 used.
30507
30508
30509 .section "Finding an ACL to use" "SECID195"
30510 .cindex "&ACL;" "finding which to use"
30511 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30512 you can use different ACLs in different circumstances. For example,
30513 .code
30514 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30515                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30516 .endd
30517 In the default configuration file there are some example settings for
30518 providing an RFC 4409 message &"submission"& service on port 587 and
30519 an RFC 8314 &"submissions"& service on port 465. You can use a string
30520 expansion like this to choose an ACL for MUAs on these ports which is
30521 more appropriate for this purpose than the default ACL on port 25.
30522
30523 The expanded string does not have to be the name of an ACL in the
30524 configuration file; there are other possibilities. Having expanded the
30525 string, Exim searches for an ACL as follows:
30526
30527 .ilist
30528 If the string begins with a slash, Exim uses it as a filename, and reads its
30529 contents as an ACL. The lines are processed in the same way as lines in the
30530 Exim configuration file. In particular, continuation lines are supported, blank
30531 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30532 If the file does not exist or cannot be read, an error occurs (typically
30533 causing a temporary failure of whatever caused the ACL to be run). For example:
30534 .code
30535 acl_smtp_data = /etc/acls/\
30536   ${lookup{$sender_host_address}lsearch\
30537   {/etc/acllist}{$value}{default}}
30538 .endd
30539 This looks up an ACL file to use on the basis of the host's IP address, falling
30540 back to a default if the lookup fails. If an ACL is successfully read from a
30541 file, it is retained in memory for the duration of the Exim process, so that it
30542 can be re-used without having to re-read the file.
30543 .next
30544 If the string does not start with a slash, and does not contain any spaces,
30545 Exim searches the ACL section of the configuration for an ACL whose name
30546 matches the string.
30547 .next
30548 If no named ACL is found, or if the string contains spaces, Exim parses
30549 the string as an inline ACL. This can save typing in cases where you just
30550 want to have something like
30551 .code
30552 acl_smtp_vrfy = accept
30553 .endd
30554 in order to allow free use of the VRFY command. Such a string may contain
30555 newlines; it is processed in the same way as an ACL that is read from a file.
30556 .endlist
30557
30558
30559
30560
30561 .section "ACL return codes" "SECID196"
30562 .cindex "&ACL;" "return codes"
30563 Except for the QUIT ACL, which does not affect the SMTP return code (see
30564 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30565 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30566 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30567 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30568 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30569 This also causes a 4&'xx'& return code.
30570
30571 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30572 &"deny"&, because there is no mechanism for passing temporary errors to the
30573 submitters of non-SMTP messages.
30574
30575
30576 ACLs that are relevant to message reception may also return &"discard"&. This
30577 has the effect of &"accept"&, but causes either the entire message or an
30578 individual recipient address to be discarded. In other words, it is a
30579 blackholing facility. Use it with care.
30580
30581 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30582 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30583 RCPT ACL is to discard just the one recipient address. If there are no
30584 recipients left when the message's data is received, the DATA ACL is not
30585 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30586 remaining recipients. The &"discard"& return is not permitted for the
30587 &%acl_smtp_predata%& ACL.
30588
30589 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30590 is done on the address and the result determines the SMTP response.
30591
30592
30593 .cindex "&[local_scan()]& function" "when all recipients discarded"
30594 The &[local_scan()]& function is always run, even if there are no remaining
30595 recipients; it may create new recipients.
30596
30597
30598
30599 .section "Unset ACL options" "SECID197"
30600 .cindex "&ACL;" "unset options"
30601 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30602 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30603 not defined at all. For any defined ACL, the default action when control
30604 reaches the end of the ACL statements is &"deny"&.
30605
30606 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30607 these two are ACLs that are used only for their side effects. They cannot be
30608 used to accept or reject anything.
30609
30610 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30611 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30612 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30613 when the ACL is not defined is &"accept"&.
30614
30615 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30616 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30617 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30618 messages over an SMTP connection. For an example, see the ACL in the default
30619 configuration file.
30620
30621
30622
30623
30624 .section "Data for message ACLs" "SECID198"
30625 .cindex "&ACL;" "data for message ACL"
30626 .vindex &$domain$&
30627 .vindex &$local_part$&
30628 .vindex &$sender_address$&
30629 .vindex &$sender_host_address$&
30630 .vindex &$smtp_command$&
30631 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30632 that contain information about the host and the message's sender (for example,
30633 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30634 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30635 &$local_part$& are set from the argument address. The entire SMTP command
30636 is available in &$smtp_command$&.
30637
30638 When an ACL for the AUTH parameter of MAIL is running, the variables that
30639 contain information about the host are set, but &$sender_address$& is not yet
30640 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30641 how it is used.
30642
30643 .vindex "&$message_size$&"
30644 The &$message_size$& variable is set to the value of the SIZE parameter on
30645 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30646 that parameter is not given. The value is updated to the true message size by
30647 the time the final DATA ACL is run (after the message data has been
30648 received).
30649
30650 .vindex "&$rcpt_count$&"
30651 .vindex "&$recipients_count$&"
30652 The &$rcpt_count$& variable increases by one for each RCPT command received.
30653 The &$recipients_count$& variable increases by one each time a RCPT command is
30654 accepted, so while an ACL for RCPT is being processed, it contains the number
30655 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30656 &$rcpt_count$& contains the total number of RCPT commands, and
30657 &$recipients_count$& contains the total number of accepted recipients.
30658
30659
30660
30661
30662
30663 .section "Data for non-message ACLs" "SECTdatfornon"
30664 .cindex "&ACL;" "data for non-message ACL"
30665 .vindex &$smtp_command_argument$&
30666 .vindex &$smtp_command$&
30667 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30668 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30669 and the entire SMTP command is available in &$smtp_command$&.
30670 These variables can be tested using a &%condition%& condition. For example,
30671 here is an ACL for use with AUTH, which insists that either the session is
30672 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30673 does not permit authentication methods that use cleartext passwords on
30674 unencrypted connections.
30675 .code
30676 acl_check_auth:
30677   accept encrypted = *
30678   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30679                      {CRAM-MD5}}
30680   deny   message   = TLS encryption or CRAM-MD5 required
30681 .endd
30682 (Another way of applying this restriction is to arrange for the authenticators
30683 that use cleartext passwords not to be advertised when the connection is not
30684 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30685 option to do this.)
30686
30687
30688
30689 .section "Format of an ACL" "SECID199"
30690 .cindex "&ACL;" "format of"
30691 .cindex "&ACL;" "verbs, definition of"
30692 An individual ACL consists of a number of statements. Each statement starts
30693 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30694 Modifiers can change the way the verb operates, define error and log messages,
30695 set variables, insert delays, and vary the processing of accepted messages.
30696
30697 If all the conditions are met, the verb is obeyed. The same condition may be
30698 used (with different arguments) more than once in the same statement. This
30699 provides a means of specifying an &"and"& conjunction between conditions. For
30700 example:
30701 .code
30702 deny  dnslists = list1.example
30703       dnslists = list2.example
30704 .endd
30705 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30706 the conditions and modifiers when it reaches a condition that fails. What
30707 happens then depends on the verb (and in one case, on a special modifier). Not
30708 all the conditions make sense at every testing point. For example, you cannot
30709 test a sender address in the ACL that is run for a VRFY command.
30710
30711
30712 .section "ACL verbs" "SECID200"
30713 The ACL verbs are as follows:
30714
30715 .ilist
30716 .cindex "&%accept%& ACL verb"
30717 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30718 of the conditions are not met, what happens depends on whether &%endpass%&
30719 appears among the conditions (for syntax see below). If the failing condition
30720 is before &%endpass%&, control is passed to the next ACL statement; if it is
30721 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30722 check a RCPT command:
30723 .code
30724 accept domains = +local_domains
30725        endpass
30726        verify = recipient
30727 .endd
30728 If the recipient domain does not match the &%domains%& condition, control
30729 passes to the next statement. If it does match, the recipient is verified, and
30730 the command is accepted if verification succeeds. However, if verification
30731 fails, the ACL yields &"deny"&, because the failing condition is after
30732 &%endpass%&.
30733
30734 The &%endpass%& feature has turned out to be confusing to many people, so its
30735 use is not recommended nowadays. It is always possible to rewrite an ACL so
30736 that &%endpass%& is not needed, and it is no longer used in the default
30737 configuration.
30738
30739 .cindex "&%message%& ACL modifier" "with &%accept%&"
30740 If a &%message%& modifier appears on an &%accept%& statement, its action
30741 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30742 (when an &%accept%& verb either accepts or passes control to the next
30743 statement), &%message%& can be used to vary the message that is sent when an
30744 SMTP command is accepted. For example, in a RCPT ACL you could have:
30745 .display
30746 &`accept  `&<&'some conditions'&>
30747 &`        message = OK, I will allow you through today`&
30748 .endd
30749 You can specify an SMTP response code, optionally followed by an &"extended
30750 response code"& at the start of the message, but the first digit must be the
30751 same as would be sent by default, which is 2 for an &%accept%& verb.
30752
30753 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30754 an error message that is used when access is denied. This behaviour is retained
30755 for backward compatibility, but current &"best practice"& is to avoid the use
30756 of &%endpass%&.
30757
30758
30759 .next
30760 .cindex "&%defer%& ACL verb"
30761 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30762 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30763 &%defer%& is the same as &%deny%&, because there is no way of sending a
30764 temporary error. For a RCPT command, &%defer%& is much the same as using a
30765 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30766 be used in any ACL, and even for a recipient it might be a simpler approach.
30767
30768
30769 .next
30770 .cindex "&%deny%& ACL verb"
30771 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30772 the conditions are not met, control is passed to the next ACL statement. For
30773 example,
30774 .code
30775 deny dnslists = blackholes.mail-abuse.org
30776 .endd
30777 rejects commands from hosts that are on a DNS black list.
30778
30779
30780 .next
30781 .cindex "&%discard%& ACL verb"
30782 &%discard%&: This verb behaves like &%accept%&, except that it returns
30783 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30784 that are concerned with receiving messages. When all the conditions are true,
30785 the sending entity receives a &"success"& response. However, &%discard%& causes
30786 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30787 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30788 message's recipients are discarded. Recipients that are discarded before DATA
30789 do not appear in the log line when the &%received_recipients%& log selector is set.
30790
30791 If the &%log_message%& modifier is set when &%discard%& operates,
30792 its contents are added to the line that is automatically written to the log.
30793 The &%message%& modifier operates exactly as it does for &%accept%&.
30794
30795
30796 .next
30797 .cindex "&%drop%& ACL verb"
30798 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30799 forcibly closed after the 5&'xx'& error message has been sent. For example:
30800 .code
30801 drop   condition = ${if > {$rcpt_count}{20}}
30802        message   = I don't take more than 20 RCPTs
30803 .endd
30804 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30805 The connection is always dropped after sending a 550 response.
30806
30807 .next
30808 .cindex "&%require%& ACL verb"
30809 &%require%&: If all the conditions are met, control is passed to the next ACL
30810 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30811 example, when checking a RCPT command,
30812 .code
30813 require message = Sender did not verify
30814         verify  = sender
30815 .endd
30816 passes control to subsequent statements only if the message's sender can be
30817 verified. Otherwise, it rejects the command. Note the positioning of the
30818 &%message%& modifier, before the &%verify%& condition. The reason for this is
30819 discussed in section &<<SECTcondmodproc>>&.
30820
30821 .next
30822 .cindex "&%warn%& ACL verb"
30823 &%warn%&: If all the conditions are true, a line specified by the
30824 &%log_message%& modifier is written to Exim's main log. Control always passes
30825 to the next ACL statement. If any condition is false, the log line is not
30826 written. If an identical log line is requested several times in the same
30827 message, only one copy is actually written to the log. If you want to force
30828 duplicates to be written, use the &%logwrite%& modifier instead.
30829
30830 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30831 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30832 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30833 first failing condition. There is more about adding header lines in section
30834 &<<SECTaddheadacl>>&.
30835
30836 If any condition on a &%warn%& statement cannot be completed (that is, there is
30837 some sort of defer), the log line specified by &%log_message%& is not written.
30838 This does not include the case of a forced failure from a lookup, which
30839 is considered to be a successful completion. After a defer, no further
30840 conditions or modifiers in the &%warn%& statement are processed. The incident
30841 is logged, and the ACL continues to be processed, from the next statement
30842 onwards.
30843
30844
30845 .vindex "&$acl_verify_message$&"
30846 When one of the &%warn%& conditions is an address verification that fails, the
30847 text of the verification failure message is in &$acl_verify_message$&. If you
30848 want this logged, you must set it up explicitly. For example:
30849 .code
30850 warn   !verify = sender
30851        log_message = sender verify failed: $acl_verify_message
30852 .endd
30853 .endlist
30854
30855 At the end of each ACL there is an implicit unconditional &%deny%&.
30856
30857 As you can see from the examples above, the conditions and modifiers are
30858 written one to a line, with the first one on the same line as the verb, and
30859 subsequent ones on following lines. If you have a very long condition, you can
30860 continue it onto several physical lines by the usual backslash continuation
30861 mechanism. It is conventional to align the conditions vertically.
30862
30863
30864
30865 .section "ACL variables" "SECTaclvariables"
30866 .cindex "&ACL;" "variables"
30867 There are some special variables that can be set during ACL processing. They
30868 can be used to pass information between different ACLs, different invocations
30869 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30870 transports, and filters that are used to deliver a message. The names of these
30871 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30872 an underscore, but the remainder of the name can be any sequence of
30873 alphanumeric characters and underscores that you choose. There is no limit on
30874 the number of ACL variables. The two sets act as follows:
30875 .ilist
30876 The values of those variables whose names begin with &$acl_c$& persist
30877 throughout an SMTP connection. They are never reset. Thus, a value that is set
30878 while receiving one message is still available when receiving the next message
30879 on the same SMTP connection.
30880 .next
30881 The values of those variables whose names begin with &$acl_m$& persist only
30882 while a message is being received. They are reset afterwards. They are also
30883 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30884 .endlist
30885
30886 When a message is accepted, the current values of all the ACL variables are
30887 preserved with the message and are subsequently made available at delivery
30888 time. The ACL variables are set by a modifier called &%set%&. For example:
30889 .code
30890 accept hosts = whatever
30891        set acl_m4 = some value
30892 accept authenticated = *
30893        set acl_c_auth = yes
30894 .endd
30895 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30896 be set. If you want to set a variable without taking any action, you can use a
30897 &%warn%& verb without any other modifiers or conditions.
30898
30899 .oindex &%strict_acl_vars%&
30900 What happens if a syntactically valid but undefined ACL variable is
30901 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30902 false (the default), an empty string is substituted; if it is true, an
30903 error is generated.
30904
30905 Versions of Exim before 4.64 have a limited set of numbered variables, but
30906 their names are compatible, so there is no problem with upgrading.
30907
30908
30909 .section "Condition and modifier processing" "SECTcondmodproc"
30910 .cindex "&ACL;" "conditions; processing"
30911 .cindex "&ACL;" "modifiers; processing"
30912 An exclamation mark preceding a condition negates its result. For example:
30913 .code
30914 deny   domains = *.dom.example
30915       !verify  = recipient
30916 .endd
30917 causes the ACL to return &"deny"& if the recipient domain ends in
30918 &'dom.example'& and the recipient address cannot be verified. Sometimes
30919 negation can be used on the right-hand side of a condition. For example, these
30920 two statements are equivalent:
30921 .code
30922 deny  hosts = !192.168.3.4
30923 deny !hosts =  192.168.3.4
30924 .endd
30925 However, for many conditions (&%verify%& being a good example), only left-hand
30926 side negation of the whole condition is possible.
30927
30928 The arguments of conditions and modifiers are expanded. A forced failure
30929 of an expansion causes a condition to be ignored, that is, it behaves as if the
30930 condition is true. Consider these two statements:
30931 .code
30932 accept  senders = ${lookup{$host_name}lsearch\
30933                   {/some/file}{$value}fail}
30934 accept  senders = ${lookup{$host_name}lsearch\
30935                   {/some/file}{$value}{}}
30936 .endd
30937 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30938 the returned list is searched, but if the lookup fails the behaviour is
30939 different in the two cases. The &%fail%& in the first statement causes the
30940 condition to be ignored, leaving no further conditions. The &%accept%& verb
30941 therefore succeeds. The second statement, however, generates an empty list when
30942 the lookup fails. No sender can match an empty list, so the condition fails,
30943 and therefore the &%accept%& also fails.
30944
30945 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30946 specify actions that are taken as the conditions for a statement are checked;
30947 others specify text for messages that are used when access is denied or a
30948 warning is generated. The &%control%& modifier affects the way an incoming
30949 message is handled.
30950
30951 The positioning of the modifiers in an ACL statement is important, because the
30952 processing of a verb ceases as soon as its outcome is known. Only those
30953 modifiers that have already been encountered will take effect. For example,
30954 consider this use of the &%message%& modifier:
30955 .code
30956 require message = Can't verify sender
30957         verify  = sender
30958         message = Can't verify recipient
30959         verify  = recipient
30960         message = This message cannot be used
30961 .endd
30962 If sender verification fails, Exim knows that the result of the statement is
30963 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30964 so its text is used as the error message. If sender verification succeeds, but
30965 recipient verification fails, the second message is used. If recipient
30966 verification succeeds, the third message becomes &"current"&, but is never used
30967 because there are no more conditions to cause failure.
30968
30969 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30970 modifier that is used, because all the conditions must be true for rejection to
30971 happen. Specifying more than one &%message%& modifier does not make sense, and
30972 the message can even be specified after all the conditions. For example:
30973 .code
30974 deny   hosts = ...
30975       !senders = *@my.domain.example
30976        message = Invalid sender from client host
30977 .endd
30978 The &"deny"& result does not happen until the end of the statement is reached,
30979 by which time Exim has set up the message.
30980
30981
30982
30983 .section "ACL modifiers" "SECTACLmodi"
30984 .cindex "&ACL;" "modifiers; list of"
30985 The ACL modifiers are as follows:
30986
30987 .vlist
30988 .vitem &*add_header*&&~=&~<&'text'&>
30989 This modifier specifies one or more header lines that are to be added to an
30990 incoming message, assuming, of course, that the message is ultimately
30991 accepted. For details, see section &<<SECTaddheadacl>>&.
30992
30993 .vitem &*continue*&&~=&~<&'text'&>
30994 .cindex "&%continue%& ACL modifier"
30995 .cindex "database" "updating in ACL"
30996 This modifier does nothing of itself, and processing of the ACL always
30997 continues with the next condition or modifier. The value of &%continue%& is in
30998 the side effects of expanding its argument. Typically this could be used to
30999 update a database. It is really just a syntactic tidiness, to avoid having to
31000 write rather ugly lines like this:
31001 .display
31002 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
31003 .endd
31004 Instead, all you need is
31005 .display
31006 &`continue = `&<&'some expansion'&>
31007 .endd
31008
31009 .vitem &*control*&&~=&~<&'text'&>
31010 .cindex "&%control%& ACL modifier"
31011 This modifier affects the subsequent processing of the SMTP connection or of an
31012 incoming message that is accepted. The effect of the first type of control
31013 lasts for the duration of the connection, whereas the effect of the second type
31014 lasts only until the current message has been received. The message-specific
31015 controls always apply to the whole message, not to individual recipients,
31016 even if the &%control%& modifier appears in a RCPT ACL.
31017
31018 As there are now quite a few controls that can be applied, they are described
31019 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
31020 in several different ways. For example:
31021
31022 . ==== As this is a nested list, any displays it contains must be indented
31023 . ==== as otherwise they are too far to the left. That comment applies only
31024 . ==== when xmlto and fop are used; formatting with sdop gets it right either
31025 . ==== way.
31026
31027 .ilist
31028 It can be at the end of an &%accept%& statement:
31029 .code
31030     accept  ...some conditions
31031             control = queue
31032 .endd
31033 In this case, the control is applied when this statement yields &"accept"&, in
31034 other words, when the conditions are all true.
31035
31036 .next
31037 It can be in the middle of an &%accept%& statement:
31038 .code
31039     accept  ...some conditions...
31040             control = queue
31041             ...some more conditions...
31042 .endd
31043 If the first set of conditions are true, the control is applied, even if the
31044 statement does not accept because one of the second set of conditions is false.
31045 In this case, some subsequent statement must yield &"accept"& for the control
31046 to be relevant.
31047
31048 .next
31049 It can be used with &%warn%& to apply the control, leaving the
31050 decision about accepting or denying to a subsequent verb. For
31051 example:
31052 .code
31053     warn    ...some conditions...
31054             control = freeze
31055     accept  ...
31056 .endd
31057 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
31058 &%logwrite%&, so it does not add anything to the message and does not write a
31059 log entry.
31060
31061 .next
31062 If you want to apply a control unconditionally, you can use it with a
31063 &%require%& verb. For example:
31064 .code
31065     require  control = no_multiline_responses
31066 .endd
31067 .endlist
31068
31069 .vitem &*delay*&&~=&~<&'time'&>
31070 .cindex "&%delay%& ACL modifier"
31071 .oindex "&%-bh%&"
31072 This modifier may appear in any ACL except notquit. It causes Exim to wait for
31073 the time interval before proceeding. However, when testing Exim using the
31074 &%-bh%& option, the delay is not actually imposed (an appropriate message is
31075 output instead). The time is given in the usual Exim notation, and the delay
31076 happens as soon as the modifier is processed. In an SMTP session, pending
31077 output is flushed before the delay is imposed.
31078
31079 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
31080 example:
31081 .code
31082 deny    ...some conditions...
31083         delay = 30s
31084 .endd
31085 The delay happens if all the conditions are true, before the statement returns
31086 &"deny"&. Compare this with:
31087 .code
31088 deny    delay = 30s
31089         ...some conditions...
31090 .endd
31091 which waits for 30s before processing the conditions. The &%delay%& modifier
31092 can also be used with &%warn%& and together with &%control%&:
31093 .code
31094 warn    ...some conditions...
31095         delay = 2m
31096         control = freeze
31097 accept  ...
31098 .endd
31099
31100 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
31101 responses to several commands are no longer buffered and sent in one packet (as
31102 they would normally be) because all output is flushed before imposing the
31103 delay. This optimization is disabled so that a number of small delays do not
31104 appear to the client as one large aggregated delay that might provoke an
31105 unwanted timeout. You can, however, disable output flushing for &%delay%& by
31106 using a &%control%& modifier to set &%no_delay_flush%&.
31107
31108
31109 .vitem &*endpass*&
31110 .cindex "&%endpass%& ACL modifier"
31111 This modifier, which has no argument, is recognized only in &%accept%& and
31112 &%discard%& statements. It marks the boundary between the conditions whose
31113 failure causes control to pass to the next statement, and the conditions whose
31114 failure causes the ACL to return &"deny"&. This concept has proved to be
31115 confusing to some people, so the use of &%endpass%& is no longer recommended as
31116 &"best practice"&. See the description of &%accept%& above for more details.
31117
31118
31119 .vitem &*log_message*&&~=&~<&'text'&>
31120 .cindex "&%log_message%& ACL modifier"
31121 This modifier sets up a message that is used as part of the log message if the
31122 ACL denies access or a &%warn%& statement's conditions are true. For example:
31123 .code
31124 require log_message = wrong cipher suite $tls_in_cipher
31125         encrypted   = DES-CBC3-SHA
31126 .endd
31127 &%log_message%& is also used when recipients are discarded by &%discard%&. For
31128 example:
31129 .display
31130 &`discard `&<&'some conditions'&>
31131 &`        log_message = Discarded $local_part@$domain because...`&
31132 .endd
31133 When access is denied, &%log_message%& adds to any underlying error message
31134 that may exist because of a condition failure. For example, while verifying a
31135 recipient address, a &':fail:'& redirection might have already set up a
31136 message.
31137
31138 The message may be defined before the conditions to which it applies, because
31139 the string expansion does not happen until Exim decides that access is to be
31140 denied. This means that any variables that are set by the condition are
31141 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
31142 variables are set after a DNS black list lookup succeeds. If the expansion of
31143 &%log_message%& fails, or if the result is an empty string, the modifier is
31144 ignored.
31145
31146 .vindex "&$acl_verify_message$&"
31147 If you want to use a &%warn%& statement to log the result of an address
31148 verification, you can use &$acl_verify_message$& to include the verification
31149 error message.
31150
31151 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
31152 the start of the logged message. If the same warning log message is requested
31153 more than once while receiving  a single email message, only one copy is
31154 actually logged. If you want to log multiple copies, use &%logwrite%& instead
31155 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
31156 is logged for a successful &%warn%& statement.
31157
31158 If &%log_message%& is not present and there is no underlying error message (for
31159 example, from the failure of address verification), but &%message%& is present,
31160 the &%message%& text is used for logging rejections. However, if any text for
31161 logging contains newlines, only the first line is logged. In the absence of
31162 both &%log_message%& and &%message%&, a default built-in message is used for
31163 logging rejections.
31164
31165
31166 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
31167 .cindex "&%log_reject_target%& ACL modifier"
31168 .cindex "logging in ACL" "specifying which log"
31169 This modifier makes it possible to specify which logs are used for messages
31170 about ACL rejections. Its argument is a colon-separated list of words that can
31171 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
31172 may be empty, in which case a rejection is not logged at all. For example, this
31173 ACL fragment writes no logging information when access is denied:
31174 .display
31175 &`deny `&<&'some conditions'&>
31176 &`     log_reject_target =`&
31177 .endd
31178 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
31179 permanent and temporary rejections. Its effect lasts for the rest of the
31180 current ACL.
31181
31182
31183 .vitem &*logwrite*&&~=&~<&'text'&>
31184 .cindex "&%logwrite%& ACL modifier"
31185 .cindex "logging in ACL" "immediate"
31186 This modifier writes a message to a log file as soon as it is encountered when
31187 processing an ACL. (Compare &%log_message%&, which, except in the case of
31188 &%warn%& and &%discard%&, is used only if the ACL statement denies
31189 access.) The &%logwrite%& modifier can be used to log special incidents in
31190 ACLs. For example:
31191 .display
31192 &`accept `&<&'some special conditions'&>
31193 &`       control  = freeze`&
31194 &`       logwrite = froze message because ...`&
31195 .endd
31196 By default, the message is written to the main log. However, it may begin
31197 with a colon, followed by a comma-separated list of log names, and then
31198 another colon, to specify exactly which logs are to be written. For
31199 example:
31200 .code
31201 logwrite = :main,reject: text for main and reject logs
31202 logwrite = :panic: text for panic log only
31203 .endd
31204
31205
31206 .vitem &*message*&&~=&~<&'text'&>
31207 .cindex "&%message%& ACL modifier"
31208 This modifier sets up a text string that is expanded and used as a response
31209 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
31210 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
31211 there is some complication if &%endpass%& is involved; see the description of
31212 &%accept%& for details.)
31213
31214 The expansion of the message happens at the time Exim decides that the ACL is
31215 to end, not at the time it processes &%message%&. If the expansion fails, or
31216 generates an empty string, the modifier is ignored. Here is an example where
31217 &%message%& must be specified first, because the ACL ends with a rejection if
31218 the &%hosts%& condition fails:
31219 .code
31220 require  message = Host not recognized
31221          hosts = 10.0.0.0/8
31222 .endd
31223 (Once a condition has failed, no further conditions or modifiers are
31224 processed.)
31225
31226 .cindex "SMTP" "error codes"
31227 .oindex "&%smtp_banner%&
31228 For ACLs that are triggered by SMTP commands, the message is returned as part
31229 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
31230 is meaningful only for SMTP, as no message is returned when a non-SMTP message
31231 is accepted. In the case of the connect ACL, accepting with a message modifier
31232 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
31233 accept message may not contain more than one line (otherwise it will be
31234 truncated at the first newline and a panic logged), and it cannot affect the
31235 EHLO options.
31236
31237 When SMTP is involved, the message may begin with an overriding response code,
31238 consisting of three digits optionally followed by an &"extended response code"&
31239 of the form &'n.n.n'&, each code being followed by a space. For example:
31240 .code
31241 deny  message = 599 1.2.3 Host not welcome
31242       hosts = 192.168.34.0/24
31243 .endd
31244 The first digit of the supplied response code must be the same as would be sent
31245 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
31246 access, but for the predata ACL, note that the default success code is 354, not
31247 2&'xx'&.
31248
31249 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
31250 the message modifier cannot override the 221 response code.
31251
31252 The text in a &%message%& modifier is literal; any quotes are taken as
31253 literals, but because the string is expanded, backslash escapes are processed
31254 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
31255 response.
31256
31257 .vindex "&$acl_verify_message$&"
31258 For ACLs that are called by an &%acl =%& ACL condition, the message is
31259 stored in &$acl_verify_message$&, from which the calling ACL may use it.
31260
31261 If &%message%& is used on a statement that verifies an address, the message
31262 specified overrides any message that is generated by the verification process.
31263 However, the original message is available in the variable
31264 &$acl_verify_message$&, so you can incorporate it into your message if you
31265 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
31266 routers to be passed back as part of the SMTP response, you should either not
31267 use a &%message%& modifier, or make use of &$acl_verify_message$&.
31268
31269 For compatibility with previous releases of Exim, a &%message%& modifier that
31270 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
31271 modifier, but this usage is now deprecated. However, &%message%& acts only when
31272 all the conditions are true, wherever it appears in an ACL command, whereas
31273 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
31274 &%warn%& in an ACL that is not concerned with receiving a message, it has no
31275 effect.
31276
31277
31278 .vitem &*queue*&&~=&~<&'text'&>
31279 .cindex "&%queue%& ACL modifier"
31280 .cindex "named queues" "selecting in ACL"
31281 This modifier specifies the use of a named queue for spool files
31282 for the message.
31283 It can only be used before the message is received (i.e. not in
31284 the DATA ACL).
31285 This could be used, for example, for known high-volume burst sources
31286 of traffic, or for quarantine of messages.
31287 Separate queue-runner processes will be needed for named queues.
31288 If the text after expansion is empty, the default queue is used.
31289
31290
31291 .vitem &*remove_header*&&~=&~<&'text'&>
31292 This modifier specifies one or more header names in a colon-separated list
31293  that are to be removed from an incoming message, assuming, of course, that
31294 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
31295
31296
31297 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
31298 .cindex "&%set%& ACL modifier"
31299 This modifier puts a value into one of the ACL variables (see section
31300 &<<SECTaclvariables>>&).
31301
31302
31303 .vitem &*udpsend*&&~=&~<&'parameters'&>
31304 .cindex "UDP communications"
31305 This modifier sends a UDP packet, for purposes such as statistics
31306 collection or behaviour monitoring. The parameters are expanded, and
31307 the result of the expansion must be a colon-separated list consisting
31308 of a destination server, port number, and the packet contents. The
31309 server can be specified as a host name or IPv4 or IPv6 address. The
31310 separator can be changed with the usual angle bracket syntax. For
31311 example, you might want to collect information on which hosts connect
31312 when:
31313 .code
31314 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
31315              $tod_zulu $sender_host_address
31316 .endd
31317 .endlist
31318
31319
31320
31321
31322 .section "Use of the control modifier" "SECTcontrols"
31323 .cindex "&%control%& ACL modifier"
31324 The &%control%& modifier supports the following settings:
31325
31326 .vlist
31327 .vitem &*control&~=&~allow_auth_unadvertised*&
31328 This modifier allows a client host to use the SMTP AUTH command even when it
31329 has not been advertised in response to EHLO. Furthermore, because there are
31330 apparently some really broken clients that do this, Exim will accept AUTH after
31331 HELO (rather than EHLO) when this control is set. It should be used only if you
31332 really need it, and you should limit its use to those broken clients that do
31333 not work without it. For example:
31334 .code
31335 warn hosts   = 192.168.34.25
31336      control = allow_auth_unadvertised
31337 .endd
31338 Normally, when an Exim server receives an AUTH command, it checks the name of
31339 the authentication mechanism that is given in the command to ensure that it
31340 matches an advertised mechanism. When this control is set, the check that a
31341 mechanism has been advertised is bypassed. Any configured mechanism can be used
31342 by the client. This control is permitted only in the connection and HELO ACLs.
31343
31344
31345 .vitem &*control&~=&~caseful_local_part*& &&&
31346        &*control&~=&~caselower_local_part*&
31347 .cindex "&ACL;" "case of local part in"
31348 .cindex "case of local parts"
31349 .vindex "&$local_part$&"
31350 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
31351 (that is, during RCPT processing). By default, the contents of &$local_part$&
31352 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
31353 any uppercase letters in the original local part are restored in &$local_part$&
31354 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
31355 is encountered.
31356
31357 These controls affect only the current recipient. Moreover, they apply only to
31358 local part handling that takes place directly in the ACL (for example, as a key
31359 in lookups). If a test to verify the recipient is obeyed, the case-related
31360 handling of the local part during the verification is controlled by the router
31361 configuration (see the &%caseful_local_part%& generic router option).
31362
31363 This facility could be used, for example, to add a spam score to local parts
31364 containing upper case letters. For example, using &$acl_m4$& to accumulate the
31365 spam score:
31366 .code
31367 warn  control = caseful_local_part
31368       set acl_m4 = ${eval:\
31369                      $acl_m4 + \
31370                      ${if match{$local_part}{[A-Z]}{1}{0}}\
31371                     }
31372       control = caselower_local_part
31373 .endd
31374 Notice that we put back the lower cased version afterwards, assuming that
31375 is what is wanted for subsequent tests.
31376
31377
31378 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
31379 .cindex "&ACL;" "cutthrough routing"
31380 .cindex "cutthrough" "requesting"
31381 This option requests delivery be attempted while the item is being received.
31382
31383 The option is usable in the RCPT ACL.
31384 If enabled for a message received via smtp and routed to an smtp transport,
31385 and only one transport, interface, destination host and port combination
31386 is used for all recipients of the message,
31387 then the delivery connection is made while the receiving connection is open
31388 and data is copied from one to the other.
31389
31390 An attempt to set this option for any recipient but the first
31391 for a mail will be quietly ignored.
31392 If a recipient-verify callout
31393 (with use_sender)
31394 connection is subsequently
31395 requested in the same ACL it is held open and used for
31396 any subsequent recipients and the data,
31397 otherwise one is made after the initial RCPT ACL completes.
31398
31399 Note that routers are used in verify mode,
31400 and cannot depend on content of received headers.
31401 Note also that headers cannot be
31402 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31403 Headers may be modified by routers (subject to the above) and transports.
31404 The &'Received-By:'& header is generated as soon as the body reception starts,
31405 rather than the traditional time after the full message is received;
31406 this will affect the timestamp.
31407
31408 All the usual ACLs are called; if one results in the message being
31409 rejected, all effort spent in delivery (including the costs on
31410 the ultimate destination) will be wasted.
31411 Note that in the case of data-time ACLs this includes the entire
31412 message body.
31413
31414 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31415 of outgoing messages is done, because it sends data to the ultimate destination
31416 before the entire message has been received from the source.
31417 It is not supported for messages received with the SMTP PRDR
31418 or CHUNKING
31419 options in use.
31420
31421 Should the ultimate destination system positively accept or reject the mail,
31422 a corresponding indication is given to the source system and nothing is queued.
31423 If the item is successfully delivered in cutthrough mode
31424 the delivery log lines are tagged with ">>" rather than "=>" and appear
31425 before the acceptance "<=" line.
31426
31427 If there is a temporary error the item is queued for later delivery in the
31428 usual fashion.
31429 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31430 to the control; the default value is &"spool"& and the alternate value
31431 &"pass"& copies an SMTP defer response from the target back to the initiator
31432 and does not queue the message.
31433 Note that this is independent of any recipient verify conditions in the ACL.
31434
31435 Delivery in this mode avoids the generation of a bounce mail to a
31436 (possibly faked)
31437 sender when the destination system is doing content-scan based rejection.
31438
31439
31440 .vitem &*control&~=&~debug/*&<&'options'&>
31441 .cindex "&ACL;" "enabling debug logging"
31442 .cindex "debugging" "enabling from an ACL"
31443 This control turns on debug logging, almost as though Exim had been invoked
31444 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31445 by default called &'debuglog'&.
31446 The filename can be adjusted with the &'tag'& option, which
31447 may access any variables already defined.  The logging may be adjusted with
31448 the &'opts'& option, which takes the same values as the &`-d`& command-line
31449 option.
31450 Logging started this way may be stopped, and the file removed,
31451 with the &'kill'& option.
31452 Some examples (which depend on variables that don't exist in all
31453 contexts):
31454 .code
31455       control = debug
31456       control = debug/tag=.$sender_host_address
31457       control = debug/opts=+expand+acl
31458       control = debug/tag=.$message_exim_id/opts=+expand
31459       control = debug/kill
31460 .endd
31461
31462
31463 .vitem &*control&~=&~dkim_disable_verify*&
31464 .cindex "disable DKIM verify"
31465 .cindex "DKIM" "disable verify"
31466 This control turns off DKIM verification processing entirely.  For details on
31467 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31468
31469
31470 .vitem &*control&~=&~dmarc_disable_verify*&
31471 .cindex "disable DMARC verify"
31472 .cindex "DMARC" "disable verify"
31473 This control turns off DMARC verification processing entirely.  For details on
31474 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31475
31476
31477 .vitem &*control&~=&~dscp/*&<&'value'&>
31478 .cindex "&ACL;" "setting DSCP value"
31479 .cindex "DSCP" "inbound"
31480 This option causes the DSCP value associated with the socket for the inbound
31481 connection to be adjusted to a given value, given as one of a number of fixed
31482 strings or to numeric value.
31483 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31484 Common values include &`throughput`&, &`mincost`&, and on newer systems
31485 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31486
31487 The outbound packets from Exim will be marked with this value in the header
31488 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31489 that these values will have any effect, not be stripped by networking
31490 equipment, or do much of anything without cooperation with your Network
31491 Engineer and those of all network operators between the source and destination.
31492
31493
31494 .vitem &*control&~=&~enforce_sync*& &&&
31495        &*control&~=&~no_enforce_sync*&
31496 .cindex "SMTP" "synchronization checking"
31497 .cindex "synchronization checking in SMTP"
31498 These controls make it possible to be selective about when SMTP synchronization
31499 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31500 state of the switch (it is true by default). See the description of this option
31501 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31502
31503 The effect of these two controls lasts for the remainder of the SMTP
31504 connection. They can appear in any ACL except the one for the non-SMTP
31505 messages. The most straightforward place to put them is in the ACL defined by
31506 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31507 before the first synchronization check. The expected use is to turn off the
31508 synchronization checks for badly-behaved hosts that you nevertheless need to
31509 work with.
31510
31511
31512 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31513 .cindex "fake defer"
31514 .cindex "defer, fake"
31515 This control works in exactly the same way as &%fakereject%& (described below)
31516 except that it causes an SMTP 450 response after the message data instead of a
31517 550 response. You must take care when using &%fakedefer%& because it causes the
31518 messages to be duplicated when the sender retries. Therefore, you should not
31519 use &%fakedefer%& if the message is to be delivered normally.
31520
31521 .vitem &*control&~=&~fakereject/*&<&'message'&>
31522 .cindex "fake rejection"
31523 .cindex "rejection, fake"
31524 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31525 words, only when an SMTP message is being received. If Exim accepts the
31526 message, instead the final 250 response, a 550 rejection message is sent.
31527 However, Exim proceeds to deliver the message as normal. The control applies
31528 only to the current message, not to any subsequent ones that may be received in
31529 the same SMTP connection.
31530
31531 The text for the 550 response is taken from the &%control%& modifier. If no
31532 message is supplied, the following is used:
31533 .code
31534 550-Your message has been rejected but is being
31535 550-kept for evaluation.
31536 550-If it was a legitimate message, it may still be
31537 550 delivered to the target recipient(s).
31538 .endd
31539 This facility should be used with extreme caution.
31540
31541 .vitem &*control&~=&~freeze*&
31542 .cindex "frozen messages" "forcing in ACL"
31543 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31544 other words, only when a message is being received. If the message is accepted,
31545 it is placed on Exim's queue and frozen. The control applies only to the
31546 current message, not to any subsequent ones that may be received in the same
31547 SMTP connection.
31548
31549 This modifier can optionally be followed by &`/no_tell`&. If the global option
31550 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31551 is told about the freezing), provided all the &*control=freeze*& modifiers that
31552 are obeyed for the current message have the &`/no_tell`& option.
31553
31554 .vitem &*control&~=&~no_delay_flush*&
31555 .cindex "SMTP" "output flushing, disabling for delay"
31556 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31557 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31558 use. This control, as long as it is encountered before the &%delay%& modifier,
31559 disables such output flushing.
31560
31561 .vitem &*control&~=&~no_callout_flush*&
31562 .cindex "SMTP" "output flushing, disabling for callout"
31563 Exim normally flushes SMTP output before performing a callout in an ACL, to
31564 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31565 use. This control, as long as it is encountered before the &%verify%& condition
31566 that causes the callout, disables such output flushing.
31567
31568 .vitem &*control&~=&~no_mbox_unspool*&
31569 This control is available when Exim is compiled with the content scanning
31570 extension. Content scanning may require a copy of the current message, or parts
31571 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31572 or spam scanner. Normally, such copies are deleted when they are no longer
31573 needed. If this control is set, the copies are not deleted. The control applies
31574 only to the current message, not to any subsequent ones that may be received in
31575 the same SMTP connection. It is provided for debugging purposes and is unlikely
31576 to be useful in production.
31577
31578 .vitem &*control&~=&~no_multiline_responses*&
31579 .cindex "multiline responses, suppressing"
31580 This control is permitted for any ACL except the one for non-SMTP messages.
31581 It seems that there are broken clients in use that cannot handle multiline
31582 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31583
31584 If this control is set, multiline SMTP responses from ACL rejections are
31585 suppressed. One way of doing this would have been to put out these responses as
31586 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31587 (&"use multiline responses for more"& it says &-- ha!), and some of the
31588 responses might get close to that. So this facility, which is after all only a
31589 sop to broken clients, is implemented by doing two very easy things:
31590
31591 .ilist
31592 Extra information that is normally output as part of a rejection caused by
31593 sender verification failure is omitted. Only the final line (typically &"sender
31594 verification failed"&) is sent.
31595 .next
31596 If a &%message%& modifier supplies a multiline response, only the first
31597 line is output.
31598 .endlist
31599
31600 The setting of the switch can, of course, be made conditional on the
31601 calling host. Its effect lasts until the end of the SMTP connection.
31602
31603 .vitem &*control&~=&~no_pipelining*&
31604 .cindex "PIPELINING" "suppressing advertising"
31605 .cindex "ESMTP extensions" PIPELINING
31606 This control turns off the advertising of the PIPELINING extension to SMTP in
31607 the current session. To be useful, it must be obeyed before Exim sends its
31608 response to an EHLO command. Therefore, it should normally appear in an ACL
31609 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31610 &%pipelining_advertise_hosts%&.
31611
31612 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31613        &*control&~=&~queue_only*&
31614 .oindex "&%queue%&"
31615 .oindex "&%queue_only%&"
31616 .cindex "queueing incoming messages"
31617 .cindex queueing "forcing in ACL"
31618 .cindex "first pass routing"
31619 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31620 other words, only when a message is being received. If the message is accepted,
31621 it is placed on Exim's queue and left there for delivery by a subsequent queue
31622 runner.
31623 If used with no options set,
31624 no immediate delivery process is started. In other words, it has the
31625 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31626
31627 If the &'first_pass_route'& option is given then
31628 the behaviour is like the command-line &'-oqds'& option;
31629 a delivery process is started which stops short of making
31630 any SMTP delivery.  The benefit is that the hints database will be updated for
31631 the message being waiting for a specific host, and a later queue run will be
31632 able to send all such messages on a single connection.
31633
31634 The control only applies to the current message, not to any subsequent ones that
31635  may be received in the same SMTP connection.
31636
31637 .vitem &*control&~=&~submission/*&<&'options'&>
31638 .cindex "message" "submission"
31639 .cindex "submission mode"
31640 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31641 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31642 the current message is a submission from a local MUA. In this case, Exim
31643 operates in &"submission mode"&, and applies certain fixups to the message if
31644 necessary. For example, it adds a &'Date:'& header line if one is not present.
31645 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31646 late (the message has already been created).
31647
31648 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31649 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31650 submission mode; the available options for this control are described there.
31651 The control applies only to the current message, not to any subsequent ones
31652 that may be received in the same SMTP connection.
31653
31654 .vitem &*control&~=&~suppress_local_fixups*&
31655 .cindex "submission fixups, suppressing"
31656 This control applies to locally submitted (non TCP/IP) messages, and is the
31657 complement of &`control = submission`&. It disables the fixups that are
31658 normally applied to locally-submitted messages. Specifically:
31659
31660 .ilist
31661 Any &'Sender:'& header line is left alone (in this respect, it is a
31662 dynamic version of &%local_sender_retain%&).
31663 .next
31664 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31665 .next
31666 There is no check that &'From:'& corresponds to the actual sender.
31667 .endlist ilist
31668
31669 This control may be useful when a remotely-originated message is accepted,
31670 passed to some scanning program, and then re-submitted for delivery. It can be
31671 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31672 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31673 data is read.
31674
31675 &*Note:*& This control applies only to the current message, not to any others
31676 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31677
31678 .vitem &*control&~=&~utf8_downconvert*&
31679 This control enables conversion of UTF-8 in message envelope addresses
31680 to a-label form.
31681 For details see section &<<SECTi18nMTA>>&.
31682 .endlist vlist
31683
31684
31685 .section "Summary of message fixup control" "SECTsummesfix"
31686 All four possibilities for message fixups can be specified:
31687
31688 .ilist
31689 Locally submitted, fixups applied: the default.
31690 .next
31691 Locally submitted, no fixups applied: use
31692 &`control = suppress_local_fixups`&.
31693 .next
31694 Remotely submitted, no fixups applied: the default.
31695 .next
31696 Remotely submitted, fixups applied: use &`control = submission`&.
31697 .endlist
31698
31699
31700
31701 .section "Adding header lines in ACLs" "SECTaddheadacl"
31702 .cindex "header lines" "adding in an ACL"
31703 .cindex "header lines" "position of added lines"
31704 .cindex "&%add_header%& ACL modifier"
31705 The &%add_header%& modifier can be used to add one or more extra header lines
31706 to an incoming message, as in this example:
31707 .code
31708 warn dnslists = sbl.spamhaus.org : \
31709                 dialup.mail-abuse.org
31710      add_header = X-blacklisted-at: $dnslist_domain
31711 .endd
31712 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31713 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31714 receiving a message). The message must ultimately be accepted for
31715 &%add_header%& to have any significant effect. You can use &%add_header%& with
31716 any ACL verb, including &%deny%& (though this is potentially useful only in a
31717 RCPT ACL).
31718
31719 Headers will not be added to the message if the modifier is used in
31720 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31721
31722 Leading and trailing newlines are removed from
31723 the data for the &%add_header%& modifier; if it then
31724 contains one or more newlines that
31725 are not followed by a space or a tab, it is assumed to contain multiple header
31726 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31727 front of any line that is not a valid header line.
31728
31729 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31730 They are added to the message before processing the DATA and MIME ACLs.
31731 However, if an identical header line is requested more than once, only one copy
31732 is actually added to the message. Further header lines may be accumulated
31733 during the DATA and MIME ACLs, after which they are added to the message, again
31734 with duplicates suppressed. Thus, it is possible to add two identical header
31735 lines to an SMTP message, but only if one is added before DATA and one after.
31736 In the case of non-SMTP messages, new headers are accumulated during the
31737 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31738 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31739 are included in the entry that is written to the reject log.
31740
31741 .cindex "header lines" "added; visibility of"
31742 Header lines are not visible in string expansions
31743 of message headers
31744 until they are added to the
31745 message. It follows that header lines defined in the MAIL, RCPT, and predata
31746 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31747 header lines that are added by the DATA or MIME ACLs are not visible in those
31748 ACLs. Because of this restriction, you cannot use header lines as a way of
31749 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31750 this, you can use ACL variables, as described in section
31751 &<<SECTaclvariables>>&.
31752
31753 The list of headers yet to be added is given by the &%$headers_added%& variable.
31754
31755 The &%add_header%& modifier acts immediately as it is encountered during the
31756 processing of an ACL. Notice the difference between these two cases:
31757 .display
31758 &`accept add_header = ADDED: some text`&
31759 &`       `&<&'some condition'&>
31760
31761 &`accept `&<&'some condition'&>
31762 &`       add_header = ADDED: some text`&
31763 .endd
31764 In the first case, the header line is always added, whether or not the
31765 condition is true. In the second case, the header line is added only if the
31766 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31767 ACL statement. All those that are encountered before a condition fails are
31768 honoured.
31769
31770 .cindex "&%warn%& ACL verb"
31771 For compatibility with previous versions of Exim, a &%message%& modifier for a
31772 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31773 effect only if all the conditions are true, even if it appears before some of
31774 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31775 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31776 are present on a &%warn%& verb, both are processed according to their
31777 specifications.
31778
31779 By default, new header lines are added to a message at the end of the existing
31780 header lines. However, you can specify that any particular header line should
31781 be added right at the start (before all the &'Received:'& lines), immediately
31782 after the first block of &'Received:'& lines, or immediately before any line
31783 that is not a &'Received:'& or &'Resent-something:'& header.
31784
31785 This is done by specifying &":at_start:"&, &":after_received:"&, or
31786 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31787 header line, respectively. (Header text cannot start with a colon, as there has
31788 to be a header name first.) For example:
31789 .code
31790 warn add_header = \
31791        :after_received:X-My-Header: something or other...
31792 .endd
31793 If more than one header line is supplied in a single &%add_header%& modifier,
31794 each one is treated independently and can therefore be placed differently. If
31795 you add more than one line at the start, or after the Received: block, they end
31796 up in reverse order.
31797
31798 &*Warning*&: This facility currently applies only to header lines that are
31799 added in an ACL. It does NOT work for header lines that are added in a
31800 system filter or in a router or transport.
31801
31802
31803
31804 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31805 .cindex "header lines" "removing in an ACL"
31806 .cindex "header lines" "position of removed lines"
31807 .cindex "&%remove_header%& ACL modifier"
31808 The &%remove_header%& modifier can be used to remove one or more header lines
31809 from an incoming message, as in this example:
31810 .code
31811 warn   message        = Remove internal headers
31812        remove_header  = x-route-mail1 : x-route-mail2
31813 .endd
31814 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31815 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31816 receiving a message). The message must ultimately be accepted for
31817 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31818 with any ACL verb, including &%deny%&, though this is really not useful for
31819 any verb that doesn't result in a delivered message.
31820
31821 Headers will not be removed from the message if the modifier is used in
31822 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31823
31824 More than one header can be removed at the same time by using a colon separated
31825 list of header names. The header matching is case insensitive. Wildcards are
31826 not permitted, nor is list expansion performed, so you cannot use hostlists to
31827 create a list of headers, however both connection and message variable expansion
31828 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31829 .code
31830 warn   hosts           = +internal_hosts
31831        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31832 warn   message         = Remove internal headers
31833        remove_header   = $acl_c_ihdrs
31834 .endd
31835 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31836 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31837 If multiple header lines match, all are removed.
31838 There is no harm in attempting to remove the same header twice nor in removing
31839 a non-existent header. Further header lines to be removed may be accumulated
31840 during the DATA and MIME ACLs, after which they are removed from the message,
31841 if present. In the case of non-SMTP messages, headers to be removed are
31842 accumulated during the non-SMTP ACLs, and are removed from the message after
31843 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31844 ACL, there really is no effect because there is no logging of what headers
31845 would have been removed.
31846
31847 .cindex "header lines" "removed; visibility of"
31848 Header lines are not visible in string expansions until the DATA phase when it
31849 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31850 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31851 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31852 this restriction, you cannot use header lines as a way of controlling data
31853 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31854 you should instead use ACL variables, as described in section
31855 &<<SECTaclvariables>>&.
31856
31857 The &%remove_header%& modifier acts immediately as it is encountered during the
31858 processing of an ACL. Notice the difference between these two cases:
31859 .display
31860 &`accept remove_header = X-Internal`&
31861 &`       `&<&'some condition'&>
31862
31863 &`accept `&<&'some condition'&>
31864 &`       remove_header = X-Internal`&
31865 .endd
31866 In the first case, the header line is always removed, whether or not the
31867 condition is true. In the second case, the header line is removed only if the
31868 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31869 same ACL statement. All those that are encountered before a condition fails
31870 are honoured.
31871
31872 &*Warning*&: This facility currently applies only to header lines that are
31873 present during ACL processing. It does NOT remove header lines that are added
31874 in a system filter or in a router or transport.
31875
31876
31877
31878
31879 .section "ACL conditions" "SECTaclconditions"
31880 .cindex "&ACL;" "conditions; list of"
31881 Some of the conditions listed in this section are available only when Exim is
31882 compiled with the content-scanning extension. They are included here briefly
31883 for completeness. More detailed descriptions can be found in the discussion on
31884 content scanning in chapter &<<CHAPexiscan>>&.
31885
31886 Not all conditions are relevant in all circumstances. For example, testing
31887 senders and recipients does not make sense in an ACL that is being run as the
31888 result of the arrival of an ETRN command, and checks on message headers can be
31889 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31890 can use the same condition (with different parameters) more than once in the
31891 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31892 The conditions are as follows:
31893
31894
31895 .vlist
31896 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31897 .cindex "&ACL;" "nested"
31898 .cindex "&ACL;" "indirect"
31899 .cindex "&ACL;" "arguments"
31900 .cindex "&%acl%& ACL condition"
31901 The possible values of the argument are the same as for the
31902 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31903 &"accept"& the condition is true; if it returns &"deny"& the condition is
31904 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31905 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31906 condition false. This means that further processing of the &%warn%& verb
31907 ceases, but processing of the ACL continues.
31908
31909 If the argument is a named ACL, up to nine space-separated optional values
31910 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31911 and $acl_narg is set to the count of values.
31912 Previous values of these variables are restored after the call returns.
31913 The name and values are expanded separately.
31914 Note that spaces in complex expansions which are used as arguments
31915 will act as argument separators.
31916
31917 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31918 the connection is dropped. If it returns &"discard"&, the verb must be
31919 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31920 conditions are tested.
31921
31922 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31923 loops. This condition allows you to use different ACLs in different
31924 circumstances. For example, different ACLs can be used to handle RCPT commands
31925 for different local users or different local domains.
31926
31927 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31928 .cindex "&%authenticated%& ACL condition"
31929 .cindex "authentication" "ACL checking"
31930 .cindex "&ACL;" "testing for authentication"
31931 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31932 the name of the authenticator is tested against the list. To test for
31933 authentication by any authenticator, you can set
31934 .code
31935 authenticated = *
31936 .endd
31937
31938 .vitem &*condition&~=&~*&<&'string'&>
31939 .cindex "&%condition%& ACL condition"
31940 .cindex "customizing" "ACL condition"
31941 .cindex "&ACL;" "customized test"
31942 .cindex "&ACL;" "testing, customized"
31943 This feature allows you to make up custom conditions. If the result of
31944 expanding the string is an empty string, the number zero, or one of the strings
31945 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31946 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31947 any other value, some error is assumed to have occurred, and the ACL returns
31948 &"defer"&. However, if the expansion is forced to fail, the condition is
31949 ignored. The effect is to treat it as true, whether it is positive or
31950 negative.
31951
31952 .vitem &*decode&~=&~*&<&'location'&>
31953 .cindex "&%decode%& ACL condition"
31954 This condition is available only when Exim is compiled with the
31955 content-scanning extension, and it is allowed only in the ACL defined by
31956 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31957 If all goes well, the condition is true. It is false only if there are
31958 problems such as a syntax error or a memory shortage. For more details, see
31959 chapter &<<CHAPexiscan>>&.
31960
31961 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31962 .cindex "&%dnslists%& ACL condition"
31963 .cindex "DNS list" "in ACL"
31964 .cindex "black list (DNS)"
31965 .cindex "&ACL;" "testing a DNS list"
31966 This condition checks for entries in DNS black lists. These are also known as
31967 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31968 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31969 different variants of this condition to describe briefly here. See sections
31970 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31971
31972 .vitem &*domains&~=&~*&<&'domain&~list'&>
31973 .cindex "&%domains%& ACL condition"
31974 .cindex "domain" "ACL checking"
31975 .cindex "&ACL;" "testing a recipient domain"
31976 .vindex "&$domain_data$&"
31977 This condition is relevant only after a RCPT command. It checks that the domain
31978 of the recipient address is in the domain list. If percent-hack processing is
31979 enabled, it is done before this test is done. If the check succeeds with a
31980 lookup, the result of the lookup is placed in &$domain_data$& until the next
31981 &%domains%& test.
31982
31983 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31984 use &%domains%& in a DATA ACL.
31985
31986
31987 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31988 .cindex "&%encrypted%& ACL condition"
31989 .cindex "encryption" "checking in an ACL"
31990 .cindex "&ACL;" "testing for encryption"
31991 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31992 name of the cipher suite in use is tested against the list. To test for
31993 encryption without testing for any specific cipher suite(s), set
31994 .code
31995 encrypted = *
31996 .endd
31997
31998
31999 .vitem &*hosts&~=&~*&<&'host&~list'&>
32000 .cindex "&%hosts%& ACL condition"
32001 .cindex "host" "ACL checking"
32002 .cindex "&ACL;" "testing the client host"
32003 This condition tests that the calling host matches the host list. If you have
32004 name lookups or wildcarded host names and IP addresses in the same host list,
32005 you should normally put the IP addresses first. For example, you could have:
32006 .code
32007 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
32008 .endd
32009 The lookup in this example uses the host name for its key. This is implied by
32010 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
32011 and it wouldn't matter which way round you had these two items.)
32012
32013 The reason for the problem with host names lies in the left-to-right way that
32014 Exim processes lists. It can test IP addresses without doing any DNS lookups,
32015 but when it reaches an item that requires a host name, it fails if it cannot
32016 find a host name to compare with the pattern. If the above list is given in the
32017 opposite order, the &%accept%& statement fails for a host whose name cannot be
32018 found, even if its IP address is 10.9.8.7.
32019
32020 If you really do want to do the name check first, and still recognize the IP
32021 address even if the name lookup fails, you can rewrite the ACL like this:
32022 .code
32023 accept hosts = dbm;/etc/friendly/hosts
32024 accept hosts = 10.9.8.7
32025 .endd
32026 The default action on failing to find the host name is to assume that the host
32027 is not in the list, so the first &%accept%& statement fails. The second
32028 statement can then check the IP address.
32029
32030 .vindex "&$host_data$&"
32031 If a &%hosts%& condition is satisfied by means of a lookup, the result
32032 of the lookup is made available in the &$host_data$& variable. This
32033 allows you, for example, to set up a statement like this:
32034 .code
32035 deny  hosts = net-lsearch;/some/file
32036       message = $host_data
32037 .endd
32038 which gives a custom error message for each denied host.
32039
32040 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
32041 .cindex "&%local_parts%& ACL condition"
32042 .cindex "local part" "ACL checking"
32043 .cindex "&ACL;" "testing a local part"
32044 .vindex "&$local_part_data$&"
32045 This condition is relevant only after a RCPT command. It checks that the local
32046 part of the recipient address is in the list. If percent-hack processing is
32047 enabled, it is done before this test. If the check succeeds with a lookup, the
32048 result of the lookup is placed in &$local_part_data$&, which remains set until
32049 the next &%local_parts%& test.
32050
32051 .vitem &*malware&~=&~*&<&'option'&>
32052 .cindex "&%malware%& ACL condition"
32053 .cindex "&ACL;" "virus scanning"
32054 .cindex "&ACL;" "scanning for viruses"
32055 This condition is available only when Exim is compiled with the
32056 content-scanning extension
32057 and only after a DATA command.
32058 It causes the incoming message to be scanned for
32059 viruses. For details, see chapter &<<CHAPexiscan>>&.
32060
32061 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32062 .cindex "&%mime_regex%& ACL condition"
32063 .cindex "&ACL;" "testing by regex matching"
32064 This condition is available only when Exim is compiled with the
32065 content-scanning extension, and it is allowed only in the ACL defined by
32066 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
32067 with any of the regular expressions. For details, see chapter
32068 &<<CHAPexiscan>>&.
32069
32070 .vitem &*ratelimit&~=&~*&<&'parameters'&>
32071 .cindex "rate limiting"
32072 This condition can be used to limit the rate at which a user or host submits
32073 messages. Details are given in section &<<SECTratelimiting>>&.
32074
32075 .vitem &*recipients&~=&~*&<&'address&~list'&>
32076 .cindex "&%recipients%& ACL condition"
32077 .cindex "recipient" "ACL checking"
32078 .cindex "&ACL;" "testing a recipient"
32079 This condition is relevant only after a RCPT command. It checks the entire
32080 recipient address against a list of recipients.
32081
32082 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
32083 .cindex "&%regex%& ACL condition"
32084 .cindex "&ACL;" "testing by regex matching"
32085 This condition is available only when Exim is compiled with the
32086 content-scanning extension, and is available only in the DATA, MIME, and
32087 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
32088 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
32089
32090 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
32091 .cindex "&%sender_domains%& ACL condition"
32092 .cindex "sender" "ACL checking"
32093 .cindex "&ACL;" "testing a sender domain"
32094 .vindex "&$domain$&"
32095 .vindex "&$sender_address_domain$&"
32096 This condition tests the domain of the sender of the message against the given
32097 domain list. &*Note*&: The domain of the sender address is in
32098 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
32099 of this condition. This is an exception to the general rule for testing domain
32100 lists. It is done this way so that, if this condition is used in an ACL for a
32101 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
32102 influence the sender checking.
32103
32104 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32105 relaying, because sender addresses are easily, and commonly, forged.
32106
32107 .vitem &*senders&~=&~*&<&'address&~list'&>
32108 .cindex "&%senders%& ACL condition"
32109 .cindex "sender" "ACL checking"
32110 .cindex "&ACL;" "testing a sender"
32111 This condition tests the sender of the message against the given list. To test
32112 for a bounce message, which has an empty sender, set
32113 .code
32114 senders = :
32115 .endd
32116 &*Warning*&: It is a bad idea to use this condition on its own as a control on
32117 relaying, because sender addresses are easily, and commonly, forged.
32118
32119 .vitem &*spam&~=&~*&<&'username'&>
32120 .cindex "&%spam%& ACL condition"
32121 .cindex "&ACL;" "scanning for spam"
32122 This condition is available only when Exim is compiled with the
32123 content-scanning extension. It causes the incoming message to be scanned by
32124 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
32125
32126 .vitem &*verify&~=&~certificate*&
32127 .cindex "&%verify%& ACL condition"
32128 .cindex "TLS" "client certificate verification"
32129 .cindex "certificate" "verification of client"
32130 .cindex "&ACL;" "certificate verification"
32131 .cindex "&ACL;" "testing a TLS certificate"
32132 This condition is true in an SMTP session if the session is encrypted, and a
32133 certificate was received from the client, and the certificate was verified. The
32134 server requests a certificate only if the client matches &%tls_verify_hosts%&
32135 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
32136
32137 .vitem &*verify&~=&~csa*&
32138 .cindex "CSA verification"
32139 This condition checks whether the sending host (the client) is authorized to
32140 send email. Details of how this works are given in section
32141 &<<SECTverifyCSA>>&.
32142
32143 .vitem &*verify&~=&~header_names_ascii*&
32144 .cindex "&%verify%& ACL condition"
32145 .cindex "&ACL;" "verifying header names only ASCII"
32146 .cindex "header lines" "verifying header names only ASCII"
32147 .cindex "verifying" "header names only ASCII"
32148 This condition is relevant only in an ACL that is run after a message has been
32149 received.
32150 This usually means an ACL specified by &%acl_smtp_data%& or &%acl_not_smtp%&.
32151 It checks all header names (not the content) to make sure
32152 there are no non-ASCII characters, also excluding control characters.  The
32153 allowable characters are decimal ASCII values 33 through 126.
32154
32155 Exim itself will handle headers with non-ASCII characters, but it can cause
32156 problems for downstream applications, so this option will allow their
32157 detection and rejection in the DATA ACL's.
32158
32159 .vitem &*verify&~=&~header_sender/*&<&'options'&>
32160 .cindex "&%verify%& ACL condition"
32161 .cindex "&ACL;" "verifying sender in the header"
32162 .cindex "header lines" "verifying the sender in"
32163 .cindex "sender" "verifying in header"
32164 .cindex "verifying" "sender in header"
32165 This condition is relevant only in an ACL that is run after a message has been
32166 received, that is, in an ACL specified by &%acl_smtp_data%& or
32167 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
32168 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
32169 is loosely thought of as a &"sender"& address (hence the name of the test).
32170 However, an address that appears in one of these headers need not be an address
32171 that accepts bounce messages; only sender addresses in envelopes are required
32172 to accept bounces. Therefore, if you use the callout option on this check, you
32173 might want to arrange for a non-empty address in the MAIL command.
32174
32175 Details of address verification and the options are given later, starting at
32176 section &<<SECTaddressverification>>& (callouts are described in section
32177 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
32178 condition to restrict it to bounce messages only:
32179 .code
32180 deny    senders = :
32181        !verify  = header_sender
32182         message = A valid sender header is required for bounces
32183 .endd
32184
32185 .vitem &*verify&~=&~header_syntax*&
32186 .cindex "&%verify%& ACL condition"
32187 .cindex "&ACL;" "verifying header syntax"
32188 .cindex "header lines" "verifying syntax"
32189 .cindex "verifying" "header syntax"
32190 This condition is relevant only in an ACL that is run after a message has been
32191 received, that is, in an ACL specified by &%acl_smtp_data%& or
32192 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
32193 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
32194 and &'Bcc:'&), returning true if there are no problems.
32195 Unqualified addresses (local parts without domains) are
32196 permitted only in locally generated messages and from hosts that match
32197 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
32198 appropriate.
32199
32200 Note that this condition is a syntax check only. However, a common spamming
32201 ploy used to be to send syntactically invalid headers such as
32202 .code
32203 To: @
32204 .endd
32205 and this condition can be used to reject such messages, though they are not as
32206 common as they used to be.
32207
32208 .vitem &*verify&~=&~helo*&
32209 .cindex "&%verify%& ACL condition"
32210 .cindex "&ACL;" "verifying HELO/EHLO"
32211 .cindex "HELO" "verifying"
32212 .cindex "EHLO" "verifying"
32213 .cindex "verifying" "EHLO"
32214 .cindex "verifying" "HELO"
32215 This condition is true if a HELO or EHLO command has been received from the
32216 client host, and its contents have been verified. If there has been no previous
32217 attempt to verify the HELO/EHLO contents, it is carried out when this
32218 condition is encountered. See the description of the &%helo_verify_hosts%& and
32219 &%helo_try_verify_hosts%& options for details of how to request verification
32220 independently of this condition, and for detail of the verification.
32221
32222 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
32223 option), this condition is always true.
32224
32225
32226 .vitem &*verify&~=&~not_blind/*&<&'options'&>
32227 .cindex "verifying" "not blind"
32228 .cindex "bcc recipients, verifying none"
32229 This condition checks that there are no blind (bcc) recipients in the message.
32230 Every envelope recipient must appear either in a &'To:'& header line or in a
32231 &'Cc:'& header line for this condition to be true. Local parts are checked
32232 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
32233 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
32234 used only in a DATA or non-SMTP ACL.
32235
32236 There is one possible option, &`case_insensitive`&.  If this is present then
32237 local parts are checked case-insensitively.
32238
32239 There are, of course, many legitimate messages that make use of blind (bcc)
32240 recipients. This check should not be used on its own for blocking messages.
32241
32242
32243 .vitem &*verify&~=&~recipient/*&<&'options'&>
32244 .cindex "&%verify%& ACL condition"
32245 .cindex "&ACL;" "verifying recipient"
32246 .cindex "recipient" "verifying"
32247 .cindex "verifying" "recipient"
32248 .vindex "&$address_data$&"
32249 This condition is relevant only after a RCPT command. It verifies the current
32250 recipient. Details of address verification are given later, starting at section
32251 &<<SECTaddressverification>>&. After a recipient has been verified, the value
32252 of &$address_data$& is the last value that was set while routing the address.
32253 This applies even if the verification fails. When an address that is being
32254 verified is redirected to a single address, verification continues with the new
32255 address, and in that case, the subsequent value of &$address_data$& is the
32256 value for the child address.
32257
32258 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
32259 .cindex "&%verify%& ACL condition"
32260 .cindex "&ACL;" "verifying host reverse lookup"
32261 .cindex "host" "verifying reverse lookup"
32262 This condition ensures that a verified host name has been looked up from the IP
32263 address of the client host. (This may have happened already if the host name
32264 was needed for checking a host list, or if the host matched &%host_lookup%&.)
32265 Verification ensures that the host name obtained from a reverse DNS lookup, or
32266 one of its aliases, does, when it is itself looked up in the DNS, yield the
32267 original IP address.
32268
32269 There is one possible option, &`defer_ok`&.  If this is present and a
32270 DNS operation returns a temporary error, the verify condition succeeds.
32271
32272 If this condition is used for a locally generated message (that is, when there
32273 is no client host involved), it always succeeds.
32274
32275 .vitem &*verify&~=&~sender/*&<&'options'&>
32276 .cindex "&%verify%& ACL condition"
32277 .cindex "&ACL;" "verifying sender"
32278 .cindex "sender" "verifying"
32279 .cindex "verifying" "sender"
32280 This condition is relevant only after a MAIL or RCPT command, or after a
32281 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
32282 the message's sender is empty (that is, this is a bounce message), the
32283 condition is true. Otherwise, the sender address is verified.
32284
32285 .vindex "&$address_data$&"
32286 .vindex "&$sender_address_data$&"
32287 If there is data in the &$address_data$& variable at the end of routing, its
32288 value is placed in &$sender_address_data$& at the end of verification. This
32289 value can be used in subsequent conditions and modifiers in the same ACL
32290 statement. It does not persist after the end of the current statement. If you
32291 want to preserve the value for longer, you can save it in an ACL variable.
32292
32293 Details of verification are given later, starting at section
32294 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
32295 to avoid doing it more than once per message.
32296
32297 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
32298 .cindex "&%verify%& ACL condition"
32299 This is a variation of the previous option, in which a modified address is
32300 verified as a sender.
32301
32302 Note that '/' is legal in local-parts; if the address may have such
32303 (eg. is generated from the received message)
32304 they must be protected from the options parsing by doubling:
32305 .code
32306 verify = sender=${listquote{/}{${address:$h_sender:}}}
32307 .endd
32308 .endlist
32309
32310
32311
32312 .section "Using DNS lists" "SECTmorednslists"
32313 .cindex "DNS list" "in ACL"
32314 .cindex "black list (DNS)"
32315 .cindex "&ACL;" "testing a DNS list"
32316 In its simplest form, the &%dnslists%& condition tests whether the calling host
32317 is on at least one of a number of DNS lists by looking up the inverted IP
32318 address in one or more DNS domains. (Note that DNS list domains are not mail
32319 domains, so the &`+`& syntax for named lists doesn't work - it is used for
32320 special options instead.) For example, if the calling host's IP
32321 address is 192.168.62.43, and the ACL statement is
32322 .code
32323 deny dnslists = blackholes.mail-abuse.org : \
32324                 dialups.mail-abuse.org
32325 .endd
32326 the following records are looked up:
32327 .code
32328 43.62.168.192.blackholes.mail-abuse.org
32329 43.62.168.192.dialups.mail-abuse.org
32330 .endd
32331 As soon as Exim finds an existing DNS record, processing of the list stops.
32332 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
32333 to test that a host is on more than one list (an &"and"& conjunction), you can
32334 use two separate conditions:
32335 .code
32336 deny dnslists = blackholes.mail-abuse.org
32337      dnslists = dialups.mail-abuse.org
32338 .endd
32339 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
32340 behaves as if the host does not match the list item, that is, as if the DNS
32341 record does not exist. If there are further items in the DNS list, they are
32342 processed.
32343
32344 This is usually the required action when &%dnslists%& is used with &%deny%&
32345 (which is the most common usage), because it prevents a DNS failure from
32346 blocking mail. However, you can change this behaviour by putting one of the
32347 following special items in the list:
32348 .display
32349 &`+include_unknown `&   behave as if the item is on the list
32350 &`+exclude_unknown `&   behave as if the item is not on the list (default)
32351 &`+defer_unknown   `&   give a temporary error
32352 .endd
32353 .cindex "&`+include_unknown`&"
32354 .cindex "&`+exclude_unknown`&"
32355 .cindex "&`+defer_unknown`&"
32356 Each of these applies to any subsequent items on the list. For example:
32357 .code
32358 deny dnslists = +defer_unknown : foo.bar.example
32359 .endd
32360 Testing the list of domains stops as soon as a match is found. If you want to
32361 warn for one list and block for another, you can use two different statements:
32362 .code
32363 deny  dnslists = blackholes.mail-abuse.org
32364 warn  dnslists = dialups.mail-abuse.org
32365       message  = X-Warn: sending host is on dialups list
32366 .endd
32367 .cindex caching "of dns lookup"
32368 .cindex DNS TTL
32369 DNS list lookups are cached by Exim for the duration of the SMTP session
32370 (but limited by the DNS return TTL value),
32371 so a lookup based on the IP address is done at most once for any incoming
32372 connection (assuming long-enough TTL).
32373 Exim does not share information between multiple incoming
32374 connections (but your local name server cache should be active).
32375
32376 There are a number of DNS lists to choose from, some commercial, some free,
32377 or free for small deployments.  An overview can be found at
32378 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
32379
32380
32381
32382 .section "Specifying the IP address for a DNS list lookup" "SECID201"
32383 .cindex "DNS list" "keyed by explicit IP address"
32384 By default, the IP address that is used in a DNS list lookup is the IP address
32385 of the calling host. However, you can specify another IP address by listing it
32386 after the domain name, introduced by a slash. For example:
32387 .code
32388 deny dnslists = black.list.tld/192.168.1.2
32389 .endd
32390 This feature is not very helpful with explicit IP addresses; it is intended for
32391 use with IP addresses that are looked up, for example, the IP addresses of the
32392 MX hosts or nameservers of an email sender address. For an example, see section
32393 &<<SECTmulkeyfor>>& below.
32394
32395
32396
32397
32398 .section "DNS lists keyed on domain names" "SECID202"
32399 .cindex "DNS list" "keyed by domain name"
32400 There are some lists that are keyed on domain names rather than inverted IP
32401 addresses (see, e.g., the &'domain based zones'& link at
32402 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32403 with these lists. You can change the name that is looked up in a DNS list by
32404 listing it after the domain name, introduced by a slash. For example,
32405 .code
32406 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32407       message  = Sender's domain is listed at $dnslist_domain
32408 .endd
32409 This particular example is useful only in ACLs that are obeyed after the
32410 RCPT or DATA commands, when a sender address is available. If (for
32411 example) the message's sender is &'user@tld.example'& the name that is looked
32412 up by this example is
32413 .code
32414 tld.example.dsn.rfc-ignorant.org
32415 .endd
32416 A single &%dnslists%& condition can contain entries for both names and IP
32417 addresses. For example:
32418 .code
32419 deny dnslists = sbl.spamhaus.org : \
32420                 dsn.rfc-ignorant.org/$sender_address_domain
32421 .endd
32422 The first item checks the sending host's IP address; the second checks a domain
32423 name. The whole condition is true if either of the DNS lookups succeeds.
32424
32425
32426
32427
32428 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32429 .cindex "DNS list" "multiple keys for"
32430 The syntax described above for looking up explicitly-defined values (either
32431 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32432 name for the DNS list, what follows the slash can in fact be a list of items.
32433 As with all lists in Exim, the default separator is a colon. However, because
32434 this is a sublist within the list of DNS blacklist domains, it is necessary
32435 either to double the separators like this:
32436 .code
32437 dnslists = black.list.tld/name.1::name.2
32438 .endd
32439 or to change the separator character, like this:
32440 .code
32441 dnslists = black.list.tld/<;name.1;name.2
32442 .endd
32443 If an item in the list is an IP address, it is inverted before the DNS
32444 blacklist domain is appended. If it is not an IP address, no inversion
32445 occurs. Consider this condition:
32446 .code
32447 dnslists = black.list.tld/<;192.168.1.2;a.domain
32448 .endd
32449 The DNS lookups that occur are:
32450 .code
32451 2.1.168.192.black.list.tld
32452 a.domain.black.list.tld
32453 .endd
32454 Once a DNS record has been found (that matches a specific IP return
32455 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32456 are done. If there is a temporary DNS error, the rest of the sublist of domains
32457 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32458 only if no other DNS lookup in this sublist succeeds. In other words, a
32459 successful lookup for any of the items in the sublist overrides a temporary
32460 error for a previous item.
32461
32462 The ability to supply a list of items after the slash is in some sense just a
32463 syntactic convenience. These two examples have the same effect:
32464 .code
32465 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32466 dnslists = black.list.tld/a.domain::b.domain
32467 .endd
32468 However, when the data for the list is obtained from a lookup, the second form
32469 is usually much more convenient. Consider this example:
32470 .code
32471 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32472                                    ${lookup dnsdb {>|mxh=\
32473                                    $sender_address_domain} }} }
32474      message  = The mail servers for the domain \
32475                 $sender_address_domain \
32476                 are listed at $dnslist_domain ($dnslist_value); \
32477                 see $dnslist_text.
32478 .endd
32479 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32480 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32481 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32482 of expanding the condition might be something like this:
32483 .code
32484 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32485 .endd
32486 Thus, this example checks whether or not the IP addresses of the sender
32487 domain's mail servers are on the Spamhaus black list.
32488
32489 The key that was used for a successful DNS list lookup is put into the variable
32490 &$dnslist_matched$& (see section &<<SECID204>>&).
32491
32492
32493
32494
32495 .section "Data returned by DNS lists" "SECID203"
32496 .cindex "DNS list" "data returned from"
32497 DNS lists are constructed using address records in the DNS. The original RBL
32498 just used the address 127.0.0.1 on the right hand side of each record, but the
32499 RBL+ list and some other lists use a number of values with different meanings.
32500 The values used on the RBL+ list are:
32501 .display
32502 127.1.0.1  RBL
32503 127.1.0.2  DUL
32504 127.1.0.3  DUL and RBL
32505 127.1.0.4  RSS
32506 127.1.0.5  RSS and RBL
32507 127.1.0.6  RSS and DUL
32508 127.1.0.7  RSS and DUL and RBL
32509 .endd
32510 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32511 different values. Some DNS lists may return more than one address record;
32512 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32513
32514 .new
32515 Values returned by a properly running DBSBL should be in the 127.0.0.0/8
32516 range. If a DNSBL operator loses control of the domain, lookups on it
32517 may start returning other addresses.  Because of this, Exim now ignores
32518 returned values outside the 127/8 region.
32519 .wen
32520
32521
32522 .section "Variables set from DNS lists" "SECID204"
32523 .cindex "expansion" "variables, set from DNS list"
32524 .cindex "DNS list" "variables set from"
32525 .vindex "&$dnslist_domain$&"
32526 .vindex "&$dnslist_matched$&"
32527 .vindex "&$dnslist_text$&"
32528 .vindex "&$dnslist_value$&"
32529 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32530 the name of the overall domain that matched (for example,
32531 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32532 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32533 the DNS record. When the key is an IP address, it is not reversed in
32534 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32535 cases, for example:
32536 .code
32537 deny dnslists = spamhaus.example
32538 .endd
32539 the key is also available in another variable (in this case,
32540 &$sender_host_address$&). In more complicated cases, however, this is not true.
32541 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32542 might generate a dnslists lookup like this:
32543 .code
32544 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32545 .endd
32546 If this condition succeeds, the value in &$dnslist_matched$& might be
32547 &`192.168.6.7`& (for example).
32548
32549 If more than one address record is returned by the DNS lookup, all the IP
32550 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32551 The variable &$dnslist_text$& contains the contents of any associated TXT
32552 record. For lists such as RBL+ the TXT record for a merged entry is often not
32553 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32554 information.
32555
32556 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32557 &-- even if these appear before the condition in the ACL, they are not
32558 expanded until after it has failed. For example:
32559 .code
32560 deny    hosts = !+local_networks
32561         message = $sender_host_address is listed \
32562                   at $dnslist_domain
32563         dnslists = rbl-plus.mail-abuse.example
32564 .endd
32565
32566
32567
32568 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32569 .cindex "DNS list" "matching specific returned data"
32570 You can add an equals sign and an IP address after a &%dnslists%& domain name
32571 in order to restrict its action to DNS records with a matching right hand side.
32572 For example,
32573 .code
32574 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32575 .endd
32576 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32577 any address record is considered to be a match. For the moment, we assume
32578 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32579 describes how multiple records are handled.
32580
32581 More than one IP address may be given for checking, using a comma as a
32582 separator. These are alternatives &-- if any one of them matches, the
32583 &%dnslists%& condition is true. For example:
32584 .code
32585 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32586 .endd
32587 If you want to specify a constraining address list and also specify names or IP
32588 addresses to be looked up, the constraining address list must be specified
32589 first. For example:
32590 .code
32591 deny dnslists = dsn.rfc-ignorant.org\
32592                 =127.0.0.2/$sender_address_domain
32593 .endd
32594
32595 If the character &`&&`& is used instead of &`=`&, the comparison for each
32596 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32597 In other words, the listed addresses are used as bit masks. The comparison is
32598 true if all the bits in the mask are present in the address that is being
32599 tested. For example:
32600 .code
32601 dnslists = a.b.c&0.0.0.3
32602 .endd
32603 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32604 want to test whether one bit or another bit is present (as opposed to both
32605 being present), you must use multiple values. For example:
32606 .code
32607 dnslists = a.b.c&0.0.0.1,0.0.0.2
32608 .endd
32609 matches if the final component of the address is an odd number or two times
32610 an odd number.
32611
32612
32613
32614 .section "Negated DNS matching conditions" "SECID205"
32615 You can supply a negative list of IP addresses as part of a &%dnslists%&
32616 condition. Whereas
32617 .code
32618 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32619 .endd
32620 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32621 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32622 .code
32623 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32624 .endd
32625 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32626 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32627 words, the result of the test is inverted if an exclamation mark appears before
32628 the &`=`& (or the &`&&`&) sign.
32629
32630 &*Note*&: This kind of negation is not the same as negation in a domain,
32631 host, or address list (which is why the syntax is different).
32632
32633 If you are using just one list, the negation syntax does not gain you much. The
32634 previous example is precisely equivalent to
32635 .code
32636 deny  dnslists = a.b.c
32637      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32638 .endd
32639 However, if you are using multiple lists, the negation syntax is clearer.
32640 Consider this example:
32641 .code
32642 deny  dnslists = sbl.spamhaus.org : \
32643                  list.dsbl.org : \
32644                  dnsbl.njabl.org!=127.0.0.3 : \
32645                  relays.ordb.org
32646 .endd
32647 Using only positive lists, this would have to be:
32648 .code
32649 deny  dnslists = sbl.spamhaus.org : \
32650                  list.dsbl.org
32651 deny  dnslists = dnsbl.njabl.org
32652      !dnslists = dnsbl.njabl.org=127.0.0.3
32653 deny  dnslists = relays.ordb.org
32654 .endd
32655 which is less clear, and harder to maintain.
32656
32657 Negation can also be used with a bitwise-and restriction.
32658 The dnslists condition with only be trus if a result is returned
32659 by the lookup which, anded with the restriction, is all zeroes.
32660 For example:
32661 .code
32662 deny dnslists = zen.spamhaus.org!&0.255.255.0
32663 .endd
32664
32665
32666
32667
32668 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32669 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32670 thereby providing more than one IP address. When an item in a &%dnslists%& list
32671 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32672 the match to specific results from the DNS lookup, there are two ways in which
32673 the checking can be handled. For example, consider the condition:
32674 .code
32675 dnslists = a.b.c=127.0.0.1
32676 .endd
32677 What happens if the DNS lookup for the incoming IP address yields both
32678 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32679 condition true because at least one given value was found, or is it false
32680 because at least one of the found values was not listed? And how does this
32681 affect negated conditions? Both possibilities are provided for with the help of
32682 additional separators &`==`& and &`=&&`&.
32683
32684 .ilist
32685 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32686 IP addresses matches one of the listed addresses. For the example above, the
32687 condition is true because 127.0.0.1 matches.
32688 .next
32689 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32690 looked up IP addresses matches one of the listed addresses. If the condition is
32691 changed to:
32692 .code
32693 dnslists = a.b.c==127.0.0.1
32694 .endd
32695 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32696 false because 127.0.0.2 is not listed. You would need to have:
32697 .code
32698 dnslists = a.b.c==127.0.0.1,127.0.0.2
32699 .endd
32700 for the condition to be true.
32701 .endlist
32702
32703 When &`!`& is used to negate IP address matching, it inverts the result, giving
32704 the precise opposite of the behaviour above. Thus:
32705 .ilist
32706 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32707 addresses matches one of the listed addresses. Consider:
32708 .code
32709 dnslists = a.b.c!&0.0.0.1
32710 .endd
32711 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32712 false because 127.0.0.1 matches.
32713 .next
32714 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32715 looked up IP address that does not match. Consider:
32716 .code
32717 dnslists = a.b.c!=&0.0.0.1
32718 .endd
32719 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32720 true, because 127.0.0.2 does not match. You would need to have:
32721 .code
32722 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32723 .endd
32724 for the condition to be false.
32725 .endlist
32726 When the DNS lookup yields only a single IP address, there is no difference
32727 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32728
32729
32730
32731
32732 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32733 .cindex "DNS list" "information from merged"
32734 When the facility for restricting the matching IP values in a DNS list is used,
32735 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32736 the true reason for rejection. This happens when lists are merged and the IP
32737 address in the A record is used to distinguish them; unfortunately there is
32738 only one TXT record. One way round this is not to use merged lists, but that
32739 can be inefficient because it requires multiple DNS lookups where one would do
32740 in the vast majority of cases when the host of interest is not on any of the
32741 lists.
32742
32743 A less inefficient way of solving this problem is available. If
32744 two domain names, comma-separated, are given, the second is used first to
32745 do an initial check, making use of any IP value restrictions that are set.
32746 If there is a match, the first domain is used, without any IP value
32747 restrictions, to get the TXT record. As a byproduct of this, there is also
32748 a check that the IP being tested is indeed on the first list. The first
32749 domain is the one that is put in &$dnslist_domain$&. For example:
32750 .code
32751 deny   dnslists = \
32752          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32753          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32754        message  = \
32755          rejected because $sender_host_address is blacklisted \
32756          at $dnslist_domain\n$dnslist_text
32757 .endd
32758 For the first blacklist item, this starts by doing a lookup in
32759 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32760 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32761 value, and as long as something is found, it looks for the corresponding TXT
32762 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32763 The second blacklist item is processed similarly.
32764
32765 If you are interested in more than one merged list, the same list must be
32766 given several times, but because the results of the DNS lookups are cached,
32767 the DNS calls themselves are not repeated. For example:
32768 .code
32769 deny dnslists = \
32770          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32771          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32772          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32773          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32774 .endd
32775 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32776 values matches (or if no record is found), this is the only lookup that is
32777 done. Only if there is a match is one of the more specific lists consulted.
32778
32779
32780
32781 .section "DNS lists and IPv6" "SECTmorednslistslast"
32782 .cindex "IPv6" "DNS black lists"
32783 .cindex "DNS list" "IPv6 usage"
32784 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32785 nibble by nibble. For example, if the calling host's IP address is
32786 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32787 .code
32788 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32789   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32790 .endd
32791 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32792 lists contain wildcard records, intended for IPv4, that interact badly with
32793 IPv6. For example, the DNS entry
32794 .code
32795 *.3.some.list.example.    A    127.0.0.1
32796 .endd
32797 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32798 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32799
32800 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32801 &%condition%& condition, as in this example:
32802 .code
32803 deny   condition = ${if isip4{$sender_host_address}}
32804        dnslists  = some.list.example
32805 .endd
32806
32807 If an explicit key is being used for a DNS lookup and it may be an IPv6
32808 address you should specify alternate list separators for both the outer
32809 (DNS list name) list and inner (lookup keys) list:
32810 .code
32811        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32812 .endd
32813
32814 .section "Rate limiting incoming messages" "SECTratelimiting"
32815 .cindex "rate limiting" "client sending"
32816 .cindex "limiting client sending rates"
32817 .oindex "&%smtp_ratelimit_*%&"
32818 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32819 which clients can send email. This is more powerful than the
32820 &%smtp_ratelimit_*%& options, because those options control the rate of
32821 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32822 works across all connections (concurrent and sequential) from the same client
32823 host. The syntax of the &%ratelimit%& condition is:
32824 .display
32825 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32826 .endd
32827 If the average client sending rate is less than &'m'& messages per time
32828 period &'p'& then the condition is false; otherwise it is true.
32829
32830 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32831 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32832 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32833 of &'p'&.
32834
32835 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32836 time interval, for example, &`8h`& for eight hours. A larger time constant
32837 means that it takes Exim longer to forget a client's past behaviour. The
32838 parameter &'m'& is the maximum number of messages that a client is permitted to
32839 send in each time interval. It also specifies the number of messages permitted
32840 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32841 constant, you can allow a client to send more messages in a burst without
32842 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32843 both small, messages must be sent at an even rate.
32844
32845 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32846 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32847 when deploying the &%ratelimit%& ACL condition. The script prints usage
32848 instructions when it is run with no arguments.
32849
32850 The key is used to look up the data for calculating the client's average
32851 sending rate. This data is stored in Exim's spool directory, alongside the
32852 retry and other hints databases. The default key is &$sender_host_address$&,
32853 which means Exim computes the sending rate of each client host IP address.
32854 By changing the key you can change how Exim identifies clients for the purpose
32855 of ratelimiting. For example, to limit the sending rate of each authenticated
32856 user, independent of the computer they are sending from, set the key to
32857 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32858 example, &$authenticated_id$& is only meaningful if the client has
32859 authenticated (which you can check with the &%authenticated%& ACL condition).
32860
32861 The lookup key does not have to identify clients: If you want to limit the
32862 rate at which a recipient receives messages, you can use the key
32863 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32864 ACL.
32865
32866 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32867 specifies what Exim measures the rate of, for example, messages or recipients
32868 or bytes. You can adjust the measurement using the &%unique=%& and/or
32869 &%count=%& options. You can also control when Exim updates the recorded rate
32870 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32871 separated by a slash, like the other parameters. They may appear in any order.
32872
32873 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32874 any options that alter the meaning of the stored data. The limit &'m'& is not
32875 stored, so you can alter the configured maximum rate and Exim will still
32876 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32877 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32878 behaviour. The lookup key is not affected by changes to the update mode and
32879 the &%count=%& option.
32880
32881
32882 .section "Ratelimit options for what is being measured" "ratoptmea"
32883 .cindex "rate limiting" "per_* options"
32884 The &%per_conn%& option limits the client's connection rate. It is not
32885 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32886 &%acl_not_smtp_start%& ACLs.
32887
32888 The &%per_mail%& option limits the client's rate of sending messages. This is
32889 the default if none of the &%per_*%& options is specified. It can be used in
32890 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32891 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32892
32893 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32894 the same ACLs as the &%per_mail%& option, though it is best to use this option
32895 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32896 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32897 in its MAIL command, which may be inaccurate or completely missing. You can
32898 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32899 in kilobytes, megabytes, or gigabytes, respectively.
32900
32901 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32902 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32903 &%acl_smtp_mime%&, or &%acl_smtp_data%& ACLs. In
32904 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32905 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32906 in either case the rate limiting engine will see a message with many
32907 recipients as a large high-speed burst.
32908
32909 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32910 number of different recipients that the client has sent messages to in the
32911 last time period. That is, if the client repeatedly sends messages to the same
32912 recipient, its measured rate is not increased. This option can only be used in
32913 &%acl_smtp_rcpt%&.
32914
32915 The &%per_cmd%& option causes Exim to recompute the rate every time the
32916 condition is processed. This can be used to limit the rate of any SMTP
32917 command. If it is used in multiple ACLs it can limit the aggregate rate of
32918 multiple different commands.
32919
32920 The &%count=%& option can be used to alter how much Exim adds to the client's
32921 measured rate. For example, the &%per_byte%& option is equivalent to
32922 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32923 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32924 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32925
32926 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32927
32928
32929 .section "Ratelimit update modes" "ratoptupd"
32930 .cindex "rate limiting" "reading data without updating"
32931 You can specify one of three options with the &%ratelimit%& condition to
32932 control when its database is updated. This section describes the &%readonly%&
32933 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32934
32935 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32936 previously-computed rate to check against the limit.
32937
32938 For example, you can test the client's sending rate and deny it access (when
32939 it is too fast) in the connect ACL. If the client passes this check then it
32940 can go on to send a message, in which case its recorded rate will be updated
32941 in the MAIL ACL. Subsequent connections from the same client will check this
32942 new rate.
32943 .code
32944 acl_check_connect:
32945  deny ratelimit = 100 / 5m / readonly
32946       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32947                   (max $sender_rate_limit)
32948 # ...
32949 acl_check_mail:
32950  warn ratelimit = 100 / 5m / strict
32951       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32952                   (max $sender_rate_limit)
32953 .endd
32954
32955 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32956 processing a message then it may increase the client's measured rate more than
32957 it should. For example, this will happen if you check the &%per_rcpt%& option
32958 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32959 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32960 multiple update problems by using the &%readonly%& option on later ratelimit
32961 checks.
32962
32963 The &%per_*%& options described above do not make sense in some ACLs. If you
32964 use a &%per_*%& option in an ACL where it is not normally permitted then the
32965 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32966 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32967 next section) so you must specify the &%readonly%& option explicitly.
32968
32969
32970 .section "Ratelimit options for handling fast clients" "ratoptfast"
32971 .cindex "rate limiting" "strict and leaky modes"
32972 If a client's average rate is greater than the maximum, the rate limiting
32973 engine can react in two possible ways, depending on the presence of the
32974 &%strict%& or &%leaky%& update modes. This is independent of the other
32975 counter-measures (such as rejecting the message) that may be specified by the
32976 rest of the ACL.
32977
32978 The &%leaky%& (default) option means that the client's recorded rate is not
32979 updated if it is above the limit. The effect of this is that Exim measures the
32980 client's average rate of successfully sent email,
32981 up to the given limit.
32982 This is appropriate if the countermeasure when the condition is true
32983 consists of refusing the message, and
32984 is generally the better choice if you have clients that retry automatically.
32985 If the action when true is anything more complex then this option is
32986 likely not what is wanted.
32987
32988 The &%strict%& option means that the client's recorded rate is always
32989 updated. The effect of this is that Exim measures the client's average rate
32990 of attempts to send email, which can be much higher than the maximum it is
32991 actually allowed. If the client is over the limit it may be subjected to
32992 counter-measures by the ACL. It must slow down and allow sufficient time to
32993 pass that its computed rate falls below the maximum before it can send email
32994 again. The time (the number of smoothing periods) it must wait and not
32995 attempt to send mail can be calculated with this formula:
32996 .code
32997         ln(peakrate/maxrate)
32998 .endd
32999
33000
33001 .section "Limiting the rate of different events" "ratoptuniq"
33002 .cindex "rate limiting" "counting unique events"
33003 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
33004 rate of different events. For example, the &%per_addr%& option uses this
33005 mechanism to count the number of different recipients that the client has
33006 sent messages to in the last time period; it is equivalent to
33007 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
33008 measure the rate that a client uses different sender addresses with the
33009 options &`per_mail/unique=$sender_address`&.
33010
33011 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
33012 has seen for that key. The whole set is thrown away when it is older than the
33013 rate smoothing period &'p'&, so each different event is counted at most once
33014 per period. In the &%leaky%& update mode, an event that causes the client to
33015 go over the limit is not added to the set, in the same way that the client's
33016 recorded rate is not updated in the same situation.
33017
33018 When you combine the &%unique=%& and &%readonly%& options, the specific
33019 &%unique=%& value is ignored, and Exim just retrieves the client's stored
33020 rate.
33021
33022 The &%unique=%& mechanism needs more space in the ratelimit database than the
33023 other &%ratelimit%& options in order to store the event set. The number of
33024 unique values is potentially as large as the rate limit, so the extra space
33025 required increases with larger limits.
33026
33027 The uniqueification is not perfect: there is a small probability that Exim
33028 will think a new event has happened before. If the sender's rate is less than
33029 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
33030 the measured rate can go above the limit, in which case Exim may under-count
33031 events by a significant margin. Fortunately, if the rate is high enough (2.7
33032 times the limit) that the false positive rate goes above 9%, then Exim will
33033 throw away the over-full event set before the measured rate falls below the
33034 limit. Therefore the only harm should be that exceptionally high sending rates
33035 are logged incorrectly; any countermeasures you configure will be as effective
33036 as intended.
33037
33038
33039 .section "Using rate limiting" "useratlim"
33040 Exim's other ACL facilities are used to define what counter-measures are taken
33041 when the rate limit is exceeded. This might be anything from logging a warning
33042 (for example, while measuring existing sending rates in order to define
33043 policy), through time delays to slow down fast senders, up to rejecting the
33044 message. For example:
33045 .code
33046 # Log all senders' rates
33047 warn ratelimit = 0 / 1h / strict
33048      log_message = Sender rate $sender_rate / $sender_rate_period
33049
33050 # Slow down fast senders; note the need to truncate $sender_rate
33051 # at the decimal point.
33052 warn ratelimit = 100 / 1h / per_rcpt / strict
33053      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
33054                    $sender_rate_limit }s
33055
33056 # Keep authenticated users under control
33057 deny authenticated = *
33058      ratelimit = 100 / 1d / strict / $authenticated_id
33059
33060 # System-wide rate limit
33061 defer ratelimit = 10 / 1s / $primary_hostname
33062       message = Sorry, too busy. Try again later.
33063
33064 # Restrict incoming rate from each host, with a default
33065 # set using a macro and special cases looked up in a table.
33066 defer ratelimit = ${lookup {$sender_host_address} \
33067                    cdb {DB/ratelimits.cdb} \
33068                    {$value} {RATELIMIT} }
33069       message = Sender rate exceeds $sender_rate_limit \
33070                messages per $sender_rate_period
33071 .endd
33072 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
33073 especially with the &%per_rcpt%& option, you may suffer from a performance
33074 bottleneck caused by locking on the ratelimit hints database. Apart from
33075 making your ACLs less complicated, you can reduce the problem by using a
33076 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
33077 this means that Exim will lose its hints data after a reboot (including retry
33078 hints, the callout cache, and ratelimit data).
33079
33080
33081
33082 .section "Address verification" "SECTaddressverification"
33083 .cindex "verifying address" "options for"
33084 .cindex "policy control" "address verification"
33085 Several of the &%verify%& conditions described in section
33086 &<<SECTaclconditions>>& cause addresses to be verified. Section
33087 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
33088 The verification conditions can be followed by options that modify the
33089 verification process. The options are separated from the keyword and from each
33090 other by slashes, and some of them contain parameters. For example:
33091 .code
33092 verify = sender/callout
33093 verify = recipient/defer_ok/callout=10s,defer_ok
33094 .endd
33095 The first stage of address verification, which always happens, is to run the
33096 address through the routers, in &"verify mode"&. Routers can detect the
33097 difference between verification and routing for delivery, and their actions can
33098 be varied by a number of generic options such as &%verify%& and &%verify_only%&
33099 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
33100 The available options are as follows:
33101
33102 .ilist
33103 If the &%callout%& option is specified, successful routing to one or more
33104 remote hosts is followed by a &"callout"& to those hosts as an additional
33105 check. Callouts and their sub-options are discussed in the next section.
33106 .next
33107 If there is a defer error while doing verification routing, the ACL
33108 normally returns &"defer"&. However, if you include &%defer_ok%& in the
33109 options, the condition is forced to be true instead. Note that this is a main
33110 verification option as well as a suboption for callouts.
33111 .next
33112 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
33113 discusses the reporting of sender address verification failures.
33114 .next
33115 The &%success_on_redirect%& option causes verification always to succeed
33116 immediately after a successful redirection. By default, if a redirection
33117 generates just one address, that address is also verified. See further
33118 discussion in section &<<SECTredirwhilveri>>&.
33119 .new
33120 .next
33121 If the &%quota%& option is specified for recipient verify,
33122 successful routing to an appendfile transport is followed by a call into
33123 the transport to evaluate the quota status for the recipient.
33124 No actual delivery is done, but verification will succeed if the quota
33125 is sufficient for the message (if the sender gave a message size) or
33126 not already exceeded (otherwise).
33127 .wen
33128 .endlist
33129
33130 .cindex "verifying address" "differentiating failures"
33131 .vindex "&$recipient_verify_failure$&"
33132 .vindex "&$sender_verify_failure$&"
33133 .vindex "&$acl_verify_message$&"
33134 After an address verification failure, &$acl_verify_message$& contains the
33135 error message that is associated with the failure. It can be preserved by
33136 coding like this:
33137 .code
33138 warn  !verify = sender
33139        set acl_m0 = $acl_verify_message
33140 .endd
33141 If you are writing your own custom rejection message or log message when
33142 denying access, you can use this variable to include information about the
33143 verification failure.
33144
33145 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
33146 appropriate) contains one of the following words:
33147
33148 .ilist
33149 &%qualify%&: The address was unqualified (no domain), and the message
33150 was neither local nor came from an exempted host.
33151 .next
33152 &%route%&: Routing failed.
33153 .next
33154 &%mail%&: Routing succeeded, and a callout was attempted; rejection
33155 occurred at or before the MAIL command (that is, on initial
33156 connection, HELO, or MAIL).
33157 .next
33158 &%recipient%&: The RCPT command in a callout was rejected.
33159 .next
33160 &%postmaster%&: The postmaster check in a callout was rejected.
33161 .new
33162 .next
33163 &%quota%&: The quota check for a local recipient did non pass.
33164 .endlist
33165
33166 The main use of these variables is expected to be to distinguish between
33167 rejections of MAIL and rejections of RCPT in callouts.
33168
33169 The above variables may also be set after a &*successful*&
33170 address verification to:
33171
33172 .ilist
33173 &%random%&: A random local-part callout succeeded
33174 .endlist
33175
33176
33177
33178
33179 .section "Callout verification" "SECTcallver"
33180 .cindex "verifying address" "by callout"
33181 .cindex "callout" "verification"
33182 .cindex "SMTP" "callout verification"
33183 For non-local addresses, routing verifies the domain, but is unable to do any
33184 checking of the local part. There are situations where some means of verifying
33185 the local part is desirable. One way this can be done is to make an SMTP
33186 &'callback'& to a delivery host for the sender address or a &'callforward'& to
33187 a subsequent host for a recipient address, to see if the host accepts the
33188 address. We use the term &'callout'& to cover both cases. Note that for a
33189 sender address, the callback is not to the client host that is trying to
33190 deliver the message, but to one of the hosts that accepts incoming mail for the
33191 sender's domain.
33192
33193 Exim does not do callouts by default. If you want them to happen, you must
33194 request them by setting appropriate options on the &%verify%& condition, as
33195 described below. This facility should be used with care, because it can add a
33196 lot of resource usage to the cost of verifying an address. However, Exim does
33197 cache the results of callouts, which helps to reduce the cost. Details of
33198 caching are in section &<<SECTcallvercache>>&.
33199
33200 Recipient callouts are usually used only between hosts that are controlled by
33201 the same administration. For example, a corporate gateway host could use
33202 callouts to check for valid recipients on an internal mailserver. A successful
33203 callout does not guarantee that a real delivery to the address would succeed;
33204 on the other hand, a failing callout does guarantee that a delivery would fail.
33205
33206 If the &%callout%& option is present on a condition that verifies an address, a
33207 second stage of verification occurs if the address is successfully routed to
33208 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
33209 &(manualroute)& router, where the router specifies the hosts. However, if a
33210 router that does not set up hosts routes to an &(smtp)& transport with a
33211 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
33212 &%hosts_override%& set, its hosts are always used, whether or not the router
33213 supplies a host list.
33214 Callouts are only supported on &(smtp)& transports.
33215
33216 The port that is used is taken from the transport, if it is specified and is a
33217 remote transport. (For routers that do verification only, no transport need be
33218 specified.) Otherwise, the default SMTP port is used. If a remote transport
33219 specifies an outgoing interface, this is used; otherwise the interface is not
33220 specified. Likewise, the text that is used for the HELO command is taken from
33221 the transport's &%helo_data%& option; if there is no transport, the value of
33222 &$smtp_active_hostname$& is used.
33223
33224 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
33225 test whether a bounce message could be delivered to the sender address. The
33226 following SMTP commands are sent:
33227 .display
33228 &`HELO `&<&'local host name'&>
33229 &`MAIL FROM:<>`&
33230 &`RCPT TO:`&<&'the address to be tested'&>
33231 &`QUIT`&
33232 .endd
33233 LHLO is used instead of HELO if the transport's &%protocol%& option is
33234 set to &"lmtp"&.
33235
33236 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
33237 settings.
33238
33239 A recipient callout check is similar. By default, it also uses an empty address
33240 for the sender. This default is chosen because most hosts do not make use of
33241 the sender address when verifying a recipient. Using the same address means
33242 that a single cache entry can be used for each recipient. Some sites, however,
33243 do make use of the sender address when verifying. These are catered for by the
33244 &%use_sender%& and &%use_postmaster%& options, described in the next section.
33245
33246 If the response to the RCPT command is a 2&'xx'& code, the verification
33247 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
33248 Exim tries the next host, if any. If there is a problem with all the remote
33249 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
33250 &%callout%& option is given, in which case the condition is forced to succeed.
33251
33252 .cindex "SMTP" "output flushing, disabling for callout"
33253 A callout may take a little time. For this reason, Exim normally flushes SMTP
33254 output before performing a callout in an ACL, to avoid unexpected timeouts in
33255 clients when the SMTP PIPELINING extension is in use. The flushing can be
33256 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
33257
33258
33259
33260
33261 .section "Additional parameters for callouts" "CALLaddparcall"
33262 .cindex "callout" "additional parameters for"
33263 The &%callout%& option can be followed by an equals sign and a number of
33264 optional parameters, separated by commas. For example:
33265 .code
33266 verify = recipient/callout=10s,defer_ok
33267 .endd
33268 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
33269 separate verify options, is retained for backwards compatibility, but is now
33270 deprecated. The additional parameters for &%callout%& are as follows:
33271
33272
33273 .vlist
33274 .vitem <&'a&~time&~interval'&>
33275 .cindex "callout" "timeout, specifying"
33276 This specifies the timeout that applies for the callout attempt to each host.
33277 For example:
33278 .code
33279 verify = sender/callout=5s
33280 .endd
33281 The default is 30 seconds. The timeout is used for each response from the
33282 remote host. It is also used for the initial connection, unless overridden by
33283 the &%connect%& parameter.
33284
33285
33286 .vitem &*connect&~=&~*&<&'time&~interval'&>
33287 .cindex "callout" "connection timeout, specifying"
33288 This parameter makes it possible to set a different (usually smaller) timeout
33289 for making the SMTP connection. For example:
33290 .code
33291 verify = sender/callout=5s,connect=1s
33292 .endd
33293 If not specified, this timeout defaults to the general timeout value.
33294
33295 .vitem &*defer_ok*&
33296 .cindex "callout" "defer, action on"
33297 When this parameter is present, failure to contact any host, or any other kind
33298 of temporary error, is treated as success by the ACL. However, the cache is not
33299 updated in this circumstance.
33300
33301 .vitem &*fullpostmaster*&
33302 .cindex "callout" "full postmaster check"
33303 This operates like the &%postmaster%& option (see below), but if the check for
33304 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
33305 accordance with the specification in RFC 2821. The RFC states that the
33306 unqualified address &'postmaster'& should be accepted.
33307
33308
33309 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
33310 .cindex "callout" "sender when verifying header"
33311 When verifying addresses in header lines using the &%header_sender%&
33312 verification option, Exim behaves by default as if the addresses are envelope
33313 sender addresses from a message. Callout verification therefore tests to see
33314 whether a bounce message could be delivered, by using an empty address in the
33315 MAIL command. However, it is arguable that these addresses might never be used
33316 as envelope senders, and could therefore justifiably reject bounce messages
33317 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
33318 address to use in the MAIL command. For example:
33319 .code
33320 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
33321 .endd
33322 This parameter is available only for the &%header_sender%& verification option.
33323
33324
33325 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
33326 .cindex "callout" "overall timeout, specifying"
33327 This parameter sets an overall timeout for performing a callout verification.
33328 For example:
33329 .code
33330 verify = sender/callout=5s,maxwait=30s
33331 .endd
33332 This timeout defaults to four times the callout timeout for individual SMTP
33333 commands. The overall timeout applies when there is more than one host that can
33334 be tried. The timeout is checked before trying the next host. This prevents
33335 very long delays if there are a large number of hosts and all are timing out
33336 (for example, when network connections are timing out).
33337
33338
33339 .vitem &*no_cache*&
33340 .cindex "callout" "cache, suppressing"
33341 .cindex "caching callout, suppressing"
33342 When this parameter is given, the callout cache is neither read nor updated.
33343
33344 .vitem &*postmaster*&
33345 .cindex "callout" "postmaster; checking"
33346 When this parameter is set, a successful callout check is followed by a similar
33347 check for the local part &'postmaster'& at the same domain. If this address is
33348 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
33349 the postmaster check is recorded in a cache record; if it is a failure, this is
33350 used to fail subsequent callouts for the domain without a connection being
33351 made, until the cache record expires.
33352
33353 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
33354 The postmaster check uses an empty sender in the MAIL command by default.
33355 You can use this parameter to do a postmaster check using a different address.
33356 For example:
33357 .code
33358 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
33359 .endd
33360 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
33361 one overrides. The &%postmaster%& parameter is equivalent to this example:
33362 .code
33363 require  verify = sender/callout=postmaster_mailfrom=
33364 .endd
33365 &*Warning*&: The caching arrangements for postmaster checking do not take
33366 account of the sender address. It is assumed that either the empty address or
33367 a fixed non-empty address will be used. All that Exim remembers is that the
33368 postmaster check for the domain succeeded or failed.
33369
33370
33371 .vitem &*random*&
33372 .cindex "callout" "&""random""& check"
33373 When this parameter is set, before doing the normal callout check, Exim does a
33374 check for a &"random"& local part at the same domain. The local part is not
33375 really random &-- it is defined by the expansion of the option
33376 &%callout_random_local_part%&, which defaults to
33377 .code
33378 $primary_hostname-$tod_epoch-testing
33379 .endd
33380 The idea here is to try to determine whether the remote host accepts all local
33381 parts without checking. If it does, there is no point in doing callouts for
33382 specific local parts. If the &"random"& check succeeds, the result is saved in
33383 a cache record, and used to force the current and subsequent callout checks to
33384 succeed without a connection being made, until the cache record expires.
33385
33386 .vitem &*use_postmaster*&
33387 .cindex "callout" "sender for recipient check"
33388 This parameter applies to recipient callouts only. For example:
33389 .code
33390 deny  !verify = recipient/callout=use_postmaster
33391 .endd
33392 .vindex "&$qualify_domain$&"
33393 It causes a non-empty postmaster address to be used in the MAIL command when
33394 performing the callout for the recipient, and also for a &"random"& check if
33395 that is configured. The local part of the address is &`postmaster`& and the
33396 domain is the contents of &$qualify_domain$&.
33397
33398 .vitem &*use_sender*&
33399 This option applies to recipient callouts only. For example:
33400 .code
33401 require  verify = recipient/callout=use_sender
33402 .endd
33403 It causes the message's actual sender address to be used in the MAIL
33404 command when performing the callout, instead of an empty address. There is no
33405 need to use this option unless you know that the called hosts make use of the
33406 sender when checking recipients. If used indiscriminately, it reduces the
33407 usefulness of callout caching.
33408
33409 .vitem &*hold*&
33410 This option applies to recipient callouts only. For example:
33411 .code
33412 require  verify = recipient/callout=use_sender,hold
33413 .endd
33414 It causes the connection to be held open and used for any further recipients
33415 and for eventual delivery (should that be done quickly).
33416 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33417 when that is used for the connections.
33418 The advantage is only gained if there are no callout cache hits
33419 (which could be enforced by the no_cache option),
33420 if the use_sender option is used,
33421 if neither the random nor the use_postmaster option is used,
33422 and if no other callouts intervene.
33423 .endlist
33424
33425 If you use any of the parameters that set a non-empty sender for the MAIL
33426 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33427 &%use_sender%&), you should think about possible loops. Recipient checking is
33428 usually done between two hosts that are under the same management, and the host
33429 that receives the callouts is not normally configured to do callouts itself.
33430 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33431 these circumstances.
33432
33433 However, if you use a non-empty sender address for a callout to an arbitrary
33434 host, there is the likelihood that the remote host will itself initiate a
33435 callout check back to your host. As it is checking what appears to be a message
33436 sender, it is likely to use an empty address in MAIL, thus avoiding a
33437 callout loop. However, to be on the safe side it would be best to set up your
33438 own ACLs so that they do not do sender verification checks when the recipient
33439 is the address you use for header sender or postmaster callout checking.
33440
33441 Another issue to think about when using non-empty senders for callouts is
33442 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33443 by the sender/recipient combination; thus, for any given recipient, many more
33444 actual callouts are performed than when an empty sender or postmaster is used.
33445
33446
33447
33448
33449 .section "Callout caching" "SECTcallvercache"
33450 .cindex "hints database" "callout cache"
33451 .cindex "callout" "cache, description of"
33452 .cindex "caching" "callout"
33453 Exim caches the results of callouts in order to reduce the amount of resources
33454 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33455 option. A hints database called &"callout"& is used for the cache. Two
33456 different record types are used: one records the result of a callout check for
33457 a specific address, and the other records information that applies to the
33458 entire domain (for example, that it accepts the local part &'postmaster'&).
33459
33460 When an original callout fails, a detailed SMTP error message is given about
33461 the failure. However, for subsequent failures use the cache data, this message
33462 is not available.
33463
33464 The expiry times for negative and positive address cache records are
33465 independent, and can be set by the global options &%callout_negative_expire%&
33466 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33467
33468 If a host gives a negative response to an SMTP connection, or rejects any
33469 commands up to and including
33470 .code
33471 MAIL FROM:<>
33472 .endd
33473 (but not including the MAIL command with a non-empty address),
33474 any callout attempt is bound to fail. Exim remembers such failures in a
33475 domain cache record, which it uses to fail callouts for the domain without
33476 making new connections, until the domain record times out. There are two
33477 separate expiry times for domain cache records:
33478 &%callout_domain_negative_expire%& (default 3h) and
33479 &%callout_domain_positive_expire%& (default 7d).
33480
33481 Domain records expire when the negative expiry time is reached if callouts
33482 cannot be made for the domain, or if the postmaster check failed.
33483 Otherwise, they expire when the positive expiry time is reached. This
33484 ensures that, for example, a host that stops accepting &"random"& local parts
33485 will eventually be noticed.
33486
33487 The callout caching mechanism is based on the domain of the address that is
33488 being tested. If the domain routes to several hosts, it is assumed that their
33489 behaviour will be the same.
33490
33491
33492
33493 .new
33494 .section "Quota caching" "SECTquotacache"
33495 .cindex "hints database" "quota cache"
33496 .cindex "quota" "cache, description of"
33497 .cindex "caching" "quota"
33498 Exim caches the results of quota verification
33499 in order to reduce the amount of resources used.
33500 The &"callout"& hints database is used.
33501
33502 The default cache periods are five minutes for a positive (good) result
33503 and one hour for a negative result.
33504 To change the periods the &%quota%& option can be followed by an equals sign
33505 and a number of optional paramemters, separated by commas.
33506 For example:
33507 .code
33508 verify = recipient/quota=cachepos=1h,cacheneg=1d
33509 .endd
33510 Possible parameters are:
33511 .vlist
33512 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33513 .cindex "quota cache" "positive entry expiry, specifying"
33514 Set the lifetime for a positive cache entry.
33515 A value of zero seconds is legitimate.
33516
33517 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33518 .cindex "quota cache" "negative entry expiry, specifying"
33519 As above, for a negative entry.
33520
33521 .vitem &*no_cache*&
33522 Set both positive and negative lifetimes to zero.
33523 .wen
33524
33525 .section "Sender address verification reporting" "SECTsenaddver"
33526 .cindex "verifying" "suppressing error details"
33527 See section &<<SECTaddressverification>>& for a general discussion of
33528 verification. When sender verification fails in an ACL, the details of the
33529 failure are given as additional output lines before the 550 response to the
33530 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33531 you might see:
33532 .code
33533 MAIL FROM:<xyz@abc.example>
33534 250 OK
33535 RCPT TO:<pqr@def.example>
33536 550-Verification failed for <xyz@abc.example>
33537 550-Called:   192.168.34.43
33538 550-Sent:     RCPT TO:<xyz@abc.example>
33539 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33540 550 Sender verification failed
33541 .endd
33542 If more than one RCPT command fails in the same way, the details are given
33543 only for the first of them. However, some administrators do not want to send
33544 out this much information. You can suppress the details by adding
33545 &`/no_details`& to the ACL statement that requests sender verification. For
33546 example:
33547 .code
33548 verify = sender/no_details
33549 .endd
33550
33551 .section "Redirection while verifying" "SECTredirwhilveri"
33552 .cindex "verifying" "redirection while"
33553 .cindex "address redirection" "while verifying"
33554 A dilemma arises when a local address is redirected by aliasing or forwarding
33555 during verification: should the generated addresses themselves be verified,
33556 or should the successful expansion of the original address be enough to verify
33557 it? By default, Exim takes the following pragmatic approach:
33558
33559 .ilist
33560 When an incoming address is redirected to just one child address, verification
33561 continues with the child address, and if that fails to verify, the original
33562 verification also fails.
33563 .next
33564 When an incoming address is redirected to more than one child address,
33565 verification does not continue. A success result is returned.
33566 .endlist
33567
33568 This seems the most reasonable behaviour for the common use of aliasing as a
33569 way of redirecting different local parts to the same mailbox. It means, for
33570 example, that a pair of alias entries of the form
33571 .code
33572 A.Wol:   aw123
33573 aw123:   :fail: Gone away, no forwarding address
33574 .endd
33575 work as expected, with both local parts causing verification failure. When a
33576 redirection generates more than one address, the behaviour is more like a
33577 mailing list, where the existence of the alias itself is sufficient for
33578 verification to succeed.
33579
33580 It is possible, however, to change the default behaviour so that all successful
33581 redirections count as successful verifications, however many new addresses are
33582 generated. This is specified by the &%success_on_redirect%& verification
33583 option. For example:
33584 .code
33585 require verify = recipient/success_on_redirect/callout=10s
33586 .endd
33587 In this example, verification succeeds if a router generates a new address, and
33588 the callout does not occur, because no address was routed to a remote host.
33589
33590 When verification is being tested via the &%-bv%& option, the treatment of
33591 redirections is as just described, unless the &%-v%& or any debugging option is
33592 also specified. In that case, full verification is done for every generated
33593 address and a report is output for each of them.
33594
33595
33596
33597 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33598 .cindex "CSA" "verifying"
33599 Client SMTP Authorization is a system that allows a site to advertise
33600 which machines are and are not permitted to send email. This is done by placing
33601 special SRV records in the DNS; these are looked up using the client's HELO
33602 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33603 Authorization checks in Exim are performed by the ACL condition:
33604 .code
33605 verify = csa
33606 .endd
33607 This fails if the client is not authorized. If there is a DNS problem, or if no
33608 valid CSA SRV record is found, or if the client is authorized, the condition
33609 succeeds. These three cases can be distinguished using the expansion variable
33610 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33611 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33612 be likely to cause problems for legitimate email.
33613
33614 The error messages produced by the CSA code include slightly more
33615 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33616 looking up the CSA SRV record, or problems looking up the CSA target
33617 address record. There are four reasons for &$csa_status$& being &"fail"&:
33618
33619 .ilist
33620 The client's host name is explicitly not authorized.
33621 .next
33622 The client's IP address does not match any of the CSA target IP addresses.
33623 .next
33624 The client's host name is authorized but it has no valid target IP addresses
33625 (for example, the target's addresses are IPv6 and the client is using IPv4).
33626 .next
33627 The client's host name has no CSA SRV record but a parent domain has asserted
33628 that all subdomains must be explicitly authorized.
33629 .endlist
33630
33631 The &%csa%& verification condition can take an argument which is the domain to
33632 use for the DNS query. The default is:
33633 .code
33634 verify = csa/$sender_helo_name
33635 .endd
33636 This implementation includes an extension to CSA. If the query domain
33637 is an address literal such as [192.0.2.95], or if it is a bare IP
33638 address, Exim searches for CSA SRV records in the reverse DNS as if
33639 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33640 meaningful to say:
33641 .code
33642 verify = csa/$sender_host_address
33643 .endd
33644 In fact, this is the check that Exim performs if the client does not say HELO.
33645 This extension can be turned off by setting the main configuration option
33646 &%dns_csa_use_reverse%& to be false.
33647
33648 If a CSA SRV record is not found for the domain itself, a search
33649 is performed through its parent domains for a record which might be
33650 making assertions about subdomains. The maximum depth of this search is limited
33651 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33652 default. Exim does not look for CSA SRV records in a top level domain, so the
33653 default settings handle HELO domains as long as seven
33654 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33655 of legitimate HELO domains.
33656
33657 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33658 direct SRV lookups, this is not sufficient because of the extra parent domain
33659 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33660 addresses into lookups in the reverse DNS space. The result of a successful
33661 lookup such as:
33662 .code
33663 ${lookup dnsdb {csa=$sender_helo_name}}
33664 .endd
33665 has two space-separated fields: an authorization code and a target host name.
33666 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33667 authorization required but absent, or &"?"& for unknown.
33668
33669
33670
33671
33672 .section "Bounce address tag validation" "SECTverifyPRVS"
33673 .cindex "BATV, verifying"
33674 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33675 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33676 Genuine incoming bounce messages should therefore always be addressed to
33677 recipients that have a valid tag. This scheme is a way of detecting unwanted
33678 bounce messages caused by sender address forgeries (often called &"collateral
33679 spam"&), because the recipients of such messages do not include valid tags.
33680
33681 There are two expansion items to help with the implementation of the BATV
33682 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33683 the original envelope sender address by using a simple key to add a hash of the
33684 address and some time-based randomizing information. The &%prvs%& expansion
33685 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33686 The syntax of these expansion items is described in section
33687 &<<SECTexpansionitems>>&.
33688 The validity period on signed addresses is seven days.
33689
33690 As an example, suppose the secret per-address keys are stored in an MySQL
33691 database. A query to look up the key for an address could be defined as a macro
33692 like this:
33693 .code
33694 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33695                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33696                 }{$value}}
33697 .endd
33698 Suppose also that the senders who make use of BATV are defined by an address
33699 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33700 use this:
33701 .code
33702 # Bounces: drop unsigned addresses for BATV senders
33703 deny senders = :
33704      recipients = +batv_senders
33705      message = This address does not send an unsigned reverse path
33706
33707 # Bounces: In case of prvs-signed address, check signature.
33708 deny senders = :
33709      condition  = ${prvscheck {$local_part@$domain}\
33710                   {PRVSCHECK_SQL}{1}}
33711      !condition = $prvscheck_result
33712      message = Invalid reverse path signature.
33713 .endd
33714 The first statement rejects recipients for bounce messages that are addressed
33715 to plain BATV sender addresses, because it is known that BATV senders do not
33716 send out messages with plain sender addresses. The second statement rejects
33717 recipients that are prvs-signed, but with invalid signatures (either because
33718 the key is wrong, or the signature has timed out).
33719
33720 A non-prvs-signed address is not rejected by the second statement, because the
33721 &%prvscheck%& expansion yields an empty string if its first argument is not a
33722 prvs-signed address, thus causing the &%condition%& condition to be false. If
33723 the first argument is a syntactically valid prvs-signed address, the yield is
33724 the third string (in this case &"1"&), whether or not the cryptographic and
33725 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33726 of the checks (empty for failure, &"1"& for success).
33727
33728 There is one more issue you must consider when implementing prvs-signing:
33729 you have to ensure that the routers accept prvs-signed addresses and
33730 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33731 router to remove the signature with a configuration along these lines:
33732 .code
33733 batv_redirect:
33734   driver = redirect
33735   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33736 .endd
33737 This works because, if the third argument of &%prvscheck%& is empty, the result
33738 of the expansion of a prvs-signed address is the decoded value of the original
33739 address. This router should probably be the first of your routers that handles
33740 local addresses.
33741
33742 To create BATV-signed addresses in the first place, a transport of this form
33743 can be used:
33744 .code
33745 external_smtp_batv:
33746   driver = smtp
33747   return_path = ${prvs {$return_path} \
33748                        {${lookup mysql{SELECT \
33749                        secret FROM batv_prvs WHERE \
33750                        sender='${quote_mysql:$sender_address}'} \
33751                        {$value}fail}}}
33752 .endd
33753 If no key can be found for the existing return path, no signing takes place.
33754
33755
33756
33757 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33758 .cindex "&ACL;" "relay control"
33759 .cindex "relaying" "control by ACL"
33760 .cindex "policy control" "relay control"
33761 An MTA is said to &'relay'& a message if it receives it from some host and
33762 delivers it directly to another host as a result of a remote address contained
33763 within it. Redirecting a local address via an alias or forward file and then
33764 passing the message on to another host is not relaying,
33765 .cindex "&""percent hack""&"
33766 but a redirection as a result of the &"percent hack"& is.
33767
33768 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33769 A host which is acting as a gateway or an MX backup is concerned with incoming
33770 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33771 a host which is acting as a smart host for a number of clients is concerned
33772 with outgoing relaying from those clients to the Internet at large. Often the
33773 same host is fulfilling both functions,
33774 . ///
33775 . as illustrated in the diagram below,
33776 . ///
33777 but in principle these two kinds of relaying are entirely independent. What is
33778 not wanted is the transmission of mail from arbitrary remote hosts through your
33779 system to arbitrary domains.
33780
33781
33782 You can implement relay control by means of suitable statements in the ACL that
33783 runs for each RCPT command. For convenience, it is often easiest to use
33784 Exim's named list facility to define the domains and hosts involved. For
33785 example, suppose you want to do the following:
33786
33787 .ilist
33788 Deliver a number of domains to mailboxes on the local host (or process them
33789 locally in some other way). Let's say these are &'my.dom1.example'& and
33790 &'my.dom2.example'&.
33791 .next
33792 Relay mail for a number of other domains for which you are the secondary MX.
33793 These might be &'friend1.example'& and &'friend2.example'&.
33794 .next
33795 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33796 Suppose your LAN is 192.168.45.0/24.
33797 .endlist
33798
33799
33800 In the main part of the configuration, you put the following definitions:
33801 .code
33802 domainlist local_domains    = my.dom1.example : my.dom2.example
33803 domainlist relay_to_domains = friend1.example : friend2.example
33804 hostlist   relay_from_hosts = 192.168.45.0/24
33805 .endd
33806 Now you can use these definitions in the ACL that is run for every RCPT
33807 command:
33808 .code
33809 acl_check_rcpt:
33810   accept domains = +local_domains : +relay_to_domains
33811   accept hosts   = +relay_from_hosts
33812 .endd
33813 The first statement accepts any RCPT command that contains an address in
33814 the local or relay domains. For any other domain, control passes to the second
33815 statement, which accepts the command only if it comes from one of the relay
33816 hosts. In practice, you will probably want to make your ACL more sophisticated
33817 than this, for example, by including sender and recipient verification. The
33818 default configuration includes a more comprehensive example, which is described
33819 in chapter &<<CHAPdefconfil>>&.
33820
33821
33822
33823 .section "Checking a relay configuration" "SECTcheralcon"
33824 .cindex "relaying" "checking control of"
33825 You can check the relay characteristics of your configuration in the same way
33826 that you can test any ACL behaviour for an incoming SMTP connection, by using
33827 the &%-bh%& option to run a fake SMTP session with which you interact.
33828 .ecindex IIDacl
33829
33830
33831
33832 . ////////////////////////////////////////////////////////////////////////////
33833 . ////////////////////////////////////////////////////////////////////////////
33834
33835 .chapter "Content scanning at ACL time" "CHAPexiscan"
33836 .scindex IIDcosca "content scanning" "at ACL time"
33837 The extension of Exim to include content scanning at ACL time, formerly known
33838 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33839 was integrated into the main source for Exim release 4.50, and Tom continues to
33840 maintain it. Most of the wording of this chapter is taken from Tom's
33841 specification.
33842
33843 It is also possible to scan the content of messages at other times. The
33844 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33845 scanning after all the ACLs have run. A transport filter can be used to scan
33846 messages at delivery time (see the &%transport_filter%& option, described in
33847 chapter &<<CHAPtransportgeneric>>&).
33848
33849 If you want to include the ACL-time content-scanning features when you compile
33850 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33851 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33852
33853 .ilist
33854 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33855 for all MIME parts for SMTP and non-SMTP messages, respectively.
33856 .next
33857 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33858 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33859 run at the end of message reception (the &%acl_smtp_data%& ACL).
33860 .next
33861 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33862 of messages, or parts of messages, for debugging purposes.
33863 .next
33864 Additional expansion variables that are set in the new ACL and by the new
33865 conditions.
33866 .next
33867 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33868 .endlist
33869
33870 Content-scanning is continually evolving, and new features are still being
33871 added. While such features are still unstable and liable to incompatible
33872 changes, they are made available in Exim by setting options whose names begin
33873 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33874 this manual. You can find out about them by reading the file called
33875 &_doc/experimental.txt_&.
33876
33877 All the content-scanning facilities work on a MBOX copy of the message that is
33878 temporarily created in a file called:
33879 .display
33880 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33881 .endd
33882 The &_.eml_& extension is a friendly hint to virus scanners that they can
33883 expect an MBOX-like structure inside that file. The file is created when the
33884 first content scanning facility is called. Subsequent calls to content
33885 scanning conditions open the same file again. The directory is recursively
33886 removed when the &%acl_smtp_data%& ACL has finished running, unless
33887 .code
33888 control = no_mbox_unspool
33889 .endd
33890 has been encountered. When the MIME ACL decodes files, they are put into the
33891 same directory by default.
33892
33893
33894
33895 .section "Scanning for viruses" "SECTscanvirus"
33896 .cindex "virus scanning"
33897 .cindex "content scanning" "for viruses"
33898 .cindex "content scanning" "the &%malware%& condition"
33899 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33900 It supports a &"generic"& interface to scanners called via the shell, and
33901 specialized interfaces for &"daemon"& type virus scanners, which are resident
33902 in memory and thus are much faster.
33903
33904 Since message data needs to have arrived,
33905 the condition may be only called in ACL defined by
33906 &%acl_smtp_data%&,
33907 &%acl_smtp_data_prdr%&,
33908 &%acl_smtp_mime%& or
33909 &%acl_smtp_dkim%&
33910
33911 A timeout of 2 minutes is applied to a scanner call (by default);
33912 if it expires then a defer action is taken.
33913
33914 .oindex "&%av_scanner%&"
33915 You can set the &%av_scanner%& option in the main part of the configuration
33916 to specify which scanner to use, together with any additional options that
33917 are needed. The basic syntax is as follows:
33918 .display
33919 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33920 .endd
33921 If you do not set &%av_scanner%&, it defaults to
33922 .code
33923 av_scanner = sophie:/var/run/sophie
33924 .endd
33925 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33926 before use.
33927 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33928 The following scanner types are supported in this release,
33929 though individual ones can be included or not at build time:
33930
33931 .vlist
33932 .vitem &%avast%&
33933 .cindex "virus scanners" "avast"
33934 This is the scanner daemon of Avast. It has been tested with Avast Core
33935 Security (currently at version 2.2.0).
33936 You can get a trial version at &url(https://www.avast.com) or for Linux
33937 at &url(https://www.avast.com/linux-server-antivirus).
33938 This scanner type takes one option,
33939 which can be either a full path to a UNIX socket,
33940 or host and port specifiers separated by white space.
33941 The host may be a name or an IP address; the port is either a
33942 single number or a pair of numbers with a dash between.
33943 A list of options may follow. These options are interpreted on the
33944 Exim's side of the malware scanner, or are given on separate lines to
33945 the daemon as options before the main scan command.
33946
33947 .cindex &`pass_unscanned`& "avast"
33948 If &`pass_unscanned`&
33949 is set, any files the Avast scanner can't scan (e.g.
33950 decompression bombs, or invalid archives) are considered clean. Use with
33951 care.
33952
33953 For example:
33954 .code
33955 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33956 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33957 av_scanner = avast:192.168.2.22 5036
33958 .endd
33959 If you omit the argument, the default path
33960 &_/var/run/avast/scan.sock_&
33961 is used.
33962 If you use a remote host,
33963 you need to make Exim's spool directory available to it,
33964 as the scanner is passed a file path, not file contents.
33965 For information about available commands and their options you may use
33966 .code
33967 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33968     FLAGS
33969     SENSITIVITY
33970     PACK
33971 .endd
33972
33973 If the scanner returns a temporary failure (e.g. license issues, or
33974 permission problems), the message is deferred and a paniclog entry is
33975 written.  The usual &`defer_ok`& option is available.
33976
33977 .vitem &%aveserver%&
33978 .cindex "virus scanners" "Kaspersky"
33979 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33980 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33981 which is the path to the daemon's UNIX socket. The default is shown in this
33982 example:
33983 .code
33984 av_scanner = aveserver:/var/run/aveserver
33985 .endd
33986
33987
33988 .vitem &%clamd%&
33989 .cindex "virus scanners" "clamd"
33990 This daemon-type scanner is GPL and free. You can get it at
33991 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33992 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33993 in the MIME ACL. This is no longer believed to be necessary.
33994
33995 The options are a list of server specifiers, which may be
33996 a UNIX socket specification,
33997 a TCP socket specification,
33998 or a (global) option.
33999
34000 A socket specification consists of a space-separated list.
34001 For a Unix socket the first element is a full path for the socket,
34002 for a TCP socket the first element is the IP address
34003 and the second a port number,
34004 Any further elements are per-server (non-global) options.
34005 These per-server options are supported:
34006 .code
34007 retry=<timespec>        Retry on connect fail
34008 .endd
34009
34010 The &`retry`& option specifies a time after which a single retry for
34011 a failed connect is made.  The default is to not retry.
34012
34013 If a Unix socket file is specified, only one server is supported.
34014
34015 Examples:
34016 .code
34017 av_scanner = clamd:/opt/clamd/socket
34018 av_scanner = clamd:192.0.2.3 1234
34019 av_scanner = clamd:192.0.2.3 1234:local
34020 av_scanner = clamd:192.0.2.3 1234 retry=10s
34021 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
34022 .endd
34023 If the value of av_scanner points to a UNIX socket file or contains the
34024 &`local`&
34025 option, then the ClamAV interface will pass a filename containing the data
34026 to be scanned, which should normally result in less I/O happening and be
34027 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
34028 Exim does not assume that there is a common filesystem with the remote host.
34029
34030 The final example shows that multiple TCP targets can be specified.  Exim will
34031 randomly use one for each incoming email (i.e. it load balances them).  Note
34032 that only TCP targets may be used if specifying a list of scanners; a UNIX
34033 socket cannot be mixed in with TCP targets.  If one of the servers becomes
34034 unavailable, Exim will try the remaining one(s) until it finds one that works.
34035 When a clamd server becomes unreachable, Exim will log a message.  Exim does
34036 not keep track of scanner state between multiple messages, and the scanner
34037 selection is random, so the message will get logged in the mainlog for each
34038 email that the down scanner gets chosen first (message wrapped to be readable):
34039 .code
34040 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
34041    clamd: connection to localhost, port 3310 failed
34042    (Connection refused)
34043 .endd
34044
34045 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
34046 contributing the code for this scanner.
34047
34048 .vitem &%cmdline%&
34049 .cindex "virus scanners" "command line interface"
34050 This is the keyword for the generic command line scanner interface. It can be
34051 used to attach virus scanners that are invoked from the shell. This scanner
34052 type takes 3 mandatory options:
34053
34054 .olist
34055 The full path and name of the scanner binary, with all command line options,
34056 and a placeholder (&`%s`&) for the directory to scan.
34057
34058 .next
34059 A regular expression to match against the STDOUT and STDERR output of the
34060 virus scanner. If the expression matches, a virus was found. You must make
34061 absolutely sure that this expression matches on &"virus found"&. This is called
34062 the &"trigger"& expression.
34063
34064 .next
34065 Another regular expression, containing exactly one pair of parentheses, to
34066 match the name of the virus found in the scanners output. This is called the
34067 &"name"& expression.
34068 .endlist olist
34069
34070 For example, Sophos Sweep reports a virus on a line like this:
34071 .code
34072 Virus 'W32/Magistr-B' found in file ./those.bat
34073 .endd
34074 For the trigger expression, we can match the phrase &"found in file"&. For the
34075 name expression, we want to extract the W32/Magistr-B string, so we can match
34076 for the single quotes left and right of it. Altogether, this makes the
34077 configuration setting:
34078 .code
34079 av_scanner = cmdline:\
34080              /path/to/sweep -ss -all -rec -archive %s:\
34081              found in file:'(.+)'
34082 .endd
34083 .vitem &%drweb%&
34084 .cindex "virus scanners" "DrWeb"
34085 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
34086 takes one option,
34087 either a full path to a UNIX socket,
34088 or host and port specifiers separated by white space.
34089 The host may be a name or an IP address; the port is either a
34090 single number or a pair of numbers with a dash between.
34091 For example:
34092 .code
34093 av_scanner = drweb:/var/run/drwebd.sock
34094 av_scanner = drweb:192.168.2.20 31337
34095 .endd
34096 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
34097 is used. Thanks to Alex Miller for contributing the code for this scanner.
34098
34099 .vitem &%f-protd%&
34100 .cindex "virus scanners" "f-protd"
34101 The f-protd scanner is accessed via HTTP over TCP.
34102 One argument is taken, being a space-separated hostname and port number
34103 (or port-range).
34104 For example:
34105 .code
34106 av_scanner = f-protd:localhost 10200-10204
34107 .endd
34108 If you omit the argument, the default values shown above are used.
34109
34110 .vitem &%f-prot6d%&
34111 .cindex "virus scanners" "f-prot6d"
34112 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
34113 One argument is taken, being a space-separated hostname and port number.
34114 For example:
34115 .code
34116 av_scanner = f-prot6d:localhost 10200
34117 .endd
34118 If you omit the argument, the default values show above are used.
34119
34120 .vitem &%fsecure%&
34121 .cindex "virus scanners" "F-Secure"
34122 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
34123 argument which is the path to a UNIX socket. For example:
34124 .code
34125 av_scanner = fsecure:/path/to/.fsav
34126 .endd
34127 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
34128 Thelmen for contributing the code for this scanner.
34129
34130 .vitem &%kavdaemon%&
34131 .cindex "virus scanners" "Kaspersky"
34132 This is the scanner daemon of Kaspersky Version 4. This version of the
34133 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
34134 scanner type takes one option, which is the path to the daemon's UNIX socket.
34135 For example:
34136 .code
34137 av_scanner = kavdaemon:/opt/AVP/AvpCtl
34138 .endd
34139 The default path is &_/var/run/AvpCtl_&.
34140
34141 .vitem &%mksd%&
34142 .cindex "virus scanners" "mksd"
34143 This was a daemon type scanner that is aimed mainly at Polish users,
34144 though some documentation was available in English.
34145 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
34146 and this appears to be a candidate for removal from Exim, unless
34147 we are informed of other virus scanners which use the same protocol
34148 to integrate.
34149 The only option for this scanner type is
34150 the maximum number of processes used simultaneously to scan the attachments,
34151 provided that mksd has
34152 been run with at least the same number of child processes. For example:
34153 .code
34154 av_scanner = mksd:2
34155 .endd
34156 You can safely omit this option (the default value is 1).
34157
34158 .vitem &%sock%&
34159 .cindex "virus scanners" "simple socket-connected"
34160 This is a general-purpose way of talking to simple scanner daemons
34161 running on the local machine.
34162 There are four options:
34163 an address (which may be an IP address and port, or the path of a Unix socket),
34164 a commandline to send (may include a single %s which will be replaced with
34165 the path to the mail file to be scanned),
34166 an RE to trigger on from the returned data,
34167 and an RE to extract malware_name from the returned data.
34168 For example:
34169 .code
34170 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
34171 .endd
34172 Note that surrounding whitespace is stripped from each option, meaning
34173 there is no way to specify a trailing newline.
34174 The socket specifier and both regular-expressions are required.
34175 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
34176 specify an empty element to get this.
34177
34178 .vitem &%sophie%&
34179 .cindex "virus scanners" "Sophos and Sophie"
34180 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
34181 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
34182 for this scanner type is the path to the UNIX socket that Sophie uses for
34183 client communication. For example:
34184 .code
34185 av_scanner = sophie:/tmp/sophie
34186 .endd
34187 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
34188 the option.
34189 .endlist
34190
34191 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
34192 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
34193 ACL.
34194
34195 The &%av_scanner%& option is expanded each time &%malware%& is called. This
34196 makes it possible to use different scanners. See further below for an example.
34197 The &%malware%& condition caches its results, so when you use it multiple times
34198 for the same message, the actual scanning process is only carried out once.
34199 However, using expandable items in &%av_scanner%& disables this caching, in
34200 which case each use of the &%malware%& condition causes a new scan of the
34201 message.
34202
34203 The &%malware%& condition takes a right-hand argument that is expanded before
34204 use and taken as a list, slash-separated by default.
34205 The first element can then be one of
34206
34207 .ilist
34208 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
34209 The condition succeeds if a virus was found, and fail otherwise. This is the
34210 recommended usage.
34211 .next
34212 &"false"& or &"0"& or an empty string, in which case no scanning is done and
34213 the condition fails immediately.
34214 .next
34215 A regular expression, in which case the message is scanned for viruses. The
34216 condition succeeds if a virus is found and its name matches the regular
34217 expression. This allows you to take special actions on certain types of virus.
34218 Note that &"/"& characters in the RE must be doubled due to the list-processing,
34219 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
34220 .endlist
34221
34222 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
34223 messages even if there is a problem with the virus scanner.
34224 Otherwise, such a problem causes the ACL to defer.
34225
34226 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
34227 specify a non-default timeout.  The default is two minutes.
34228 For example:
34229 .code
34230 malware = * / defer_ok / tmo=10s
34231 .endd
34232 A timeout causes the ACL to defer.
34233
34234 .vindex "&$callout_address$&"
34235 When a connection is made to the scanner the expansion variable &$callout_address$&
34236 is set to record the actual address used.
34237
34238 .vindex "&$malware_name$&"
34239 When a virus is found, the condition sets up an expansion variable called
34240 &$malware_name$& that contains the name of the virus. You can use it in a
34241 &%message%& modifier that specifies the error returned to the sender, and/or in
34242 logging data.
34243
34244 Beware the interaction of Exim's &%message_size_limit%& with any size limits
34245 imposed by your anti-virus scanner.
34246
34247 Here is a very simple scanning example:
34248 .code
34249 deny malware = *
34250      message = This message contains malware ($malware_name)
34251 .endd
34252 The next example accepts messages when there is a problem with the scanner:
34253 .code
34254 deny malware = */defer_ok
34255      message = This message contains malware ($malware_name)
34256 .endd
34257 The next example shows how to use an ACL variable to scan with both sophie and
34258 aveserver. It assumes you have set:
34259 .code
34260 av_scanner = $acl_m0
34261 .endd
34262 in the main Exim configuration.
34263 .code
34264 deny set acl_m0 = sophie
34265      malware = *
34266      message = This message contains malware ($malware_name)
34267
34268 deny set acl_m0 = aveserver
34269      malware = *
34270      message = This message contains malware ($malware_name)
34271 .endd
34272
34273
34274 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
34275 .cindex "content scanning" "for spam"
34276 .cindex "spam scanning"
34277 .cindex "SpamAssassin"
34278 .cindex "Rspamd"
34279 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
34280 score and a report for the message.
34281 Support is also provided for Rspamd.
34282
34283 For more information about installation and configuration of SpamAssassin or
34284 Rspamd refer to their respective websites at
34285 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
34286
34287 SpamAssassin can be installed with CPAN by running:
34288 .code
34289 perl -MCPAN -e 'install Mail::SpamAssassin'
34290 .endd
34291 SpamAssassin has its own set of configuration files. Please review its
34292 documentation to see how you can tweak it. The default installation should work
34293 nicely, however.
34294
34295 .oindex "&%spamd_address%&"
34296 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
34297 intend to use an instance running on the local host you do not need to set
34298 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
34299 you must set the &%spamd_address%& option in the global part of the Exim
34300 configuration as follows (example):
34301 .code
34302 spamd_address = 192.168.99.45 783
34303 .endd
34304 The SpamAssassin protocol relies on a TCP half-close from the client.
34305 If your SpamAssassin client side is running a Linux system with an
34306 iptables firewall, consider setting
34307 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
34308 timeout, Exim uses when waiting for a response from the SpamAssassin
34309 server (currently defaulting to 120s).  With a lower value the Linux
34310 connection tracking may consider your half-closed connection as dead too
34311 soon.
34312
34313
34314 To use Rspamd (which by default listens on all local addresses
34315 on TCP port 11333)
34316 you should add &%variant=rspamd%& after the address/port pair, for example:
34317 .code
34318 spamd_address = 127.0.0.1 11333 variant=rspamd
34319 .endd
34320
34321 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
34322 sockets. If you want to us these, supply &%spamd_address%& with an absolute
34323 filename instead of an address/port pair:
34324 .code
34325 spamd_address = /var/run/spamd_socket
34326 .endd
34327 You can have multiple &%spamd%& servers to improve scalability. These can
34328 reside on other hardware reachable over the network. To specify multiple
34329 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
34330 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
34331 .code
34332 spamd_address = 192.168.2.10 783 : \
34333                 192.168.2.11 783 : \
34334                 192.168.2.12 783
34335 .endd
34336 Up to 32 &%spamd%& servers are supported.
34337 When a server fails to respond to the connection attempt, all other
34338 servers are tried until one succeeds. If no server responds, the &%spam%&
34339 condition defers.
34340
34341 Unix and TCP socket specifications may be mixed in any order.
34342 Each element of the list is a list itself, space-separated by default
34343 and changeable in the usual way (&<<SECTlistsepchange>>&);
34344 take care to not double the separator.
34345
34346 For TCP socket specifications a host name or IP (v4 or v6, but
34347 subject to list-separator quoting rules) address can be used,
34348 and the port can be one or a dash-separated pair.
34349 In the latter case, the range is tried in strict order.
34350
34351 Elements after the first for Unix sockets, or second for TCP socket,
34352 are options.
34353 The supported options are:
34354 .code
34355 pri=<priority>      Selection priority
34356 weight=<value>      Selection bias
34357 time=<start>-<end>  Use only between these times of day
34358 retry=<timespec>    Retry on connect fail
34359 tmo=<timespec>      Connection time limit
34360 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
34361 .endd
34362
34363 The &`pri`& option specifies a priority for the server within the list,
34364 higher values being tried first.
34365 The default priority is 1.
34366
34367 The &`weight`& option specifies a selection bias.
34368 Within a priority set
34369 servers are queried in a random fashion, weighted by this value.
34370 The default value for selection bias is 1.
34371
34372 Time specifications for the &`time`& option are <hour>.<minute>.<second>
34373 in the local time zone; each element being one or more digits.
34374 Either the seconds or both minutes and seconds, plus the leading &`.`&
34375 characters, may be omitted and will be taken as zero.
34376
34377 Timeout specifications for the &`retry`& and &`tmo`& options
34378 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
34379
34380 The &`tmo`& option specifies an overall timeout for communication.
34381 The default value is two minutes.
34382
34383 The &`retry`& option specifies a time after which a single retry for
34384 a failed connect is made.
34385 The default is to not retry.
34386
34387 The &%spamd_address%& variable is expanded before use if it starts with
34388 a dollar sign. In this case, the expansion may return a string that is
34389 used as the list so that multiple spamd servers can be the result of an
34390 expansion.
34391
34392 .vindex "&$callout_address$&"
34393 When a connection is made to the server the expansion variable &$callout_address$&
34394 is set to record the actual address used.
34395
34396 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
34397 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
34398 .code
34399 deny spam = joe
34400      message = This message was classified as SPAM
34401 .endd
34402 The right-hand side of the &%spam%& condition specifies a name. This is
34403 relevant if you have set up multiple SpamAssassin profiles. If you do not want
34404 to scan using a specific profile, but rather use the SpamAssassin system-wide
34405 default profile, you can scan for an unknown name, or simply use &"nobody"&.
34406 Rspamd does not use this setting. However, you must put something on the
34407 right-hand side.
34408
34409 The name allows you to use per-domain or per-user antispam profiles in
34410 principle, but this is not straightforward in practice, because a message may
34411 have multiple recipients, not necessarily all in the same domain. Because the
34412 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34413 read the contents of the message, the variables &$local_part$& and &$domain$&
34414 are not set.
34415 Careful enforcement of single-recipient messages
34416 (e.g. by responding with defer in the recipient ACL for all recipients
34417 after the first),
34418 or the use of PRDR,
34419 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34420 are needed to use this feature.
34421
34422 The right-hand side of the &%spam%& condition is expanded before being used, so
34423 you can put lookups or conditions there. When the right-hand side evaluates to
34424 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34425
34426
34427 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34428 large ones may cause significant performance degradation. As most spam messages
34429 are quite small, it is recommended that you do not scan the big ones. For
34430 example:
34431 .code
34432 deny condition = ${if < {$message_size}{10K}}
34433      spam = nobody
34434      message = This message was classified as SPAM
34435 .endd
34436
34437 The &%spam%& condition returns true if the threshold specified in the user's
34438 SpamAssassin profile has been matched or exceeded. If you want to use the
34439 &%spam%& condition for its side effects (see the variables below), you can make
34440 it always return &"true"& by appending &`:true`& to the username.
34441
34442 .cindex "spam scanning" "returned variables"
34443 When the &%spam%& condition is run, it sets up a number of expansion
34444 variables.
34445 Except for &$spam_report$&,
34446 these variables are saved with the received message so are
34447 available for use at delivery time.
34448
34449 .vlist
34450 .vitem &$spam_score$&
34451 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34452 for inclusion in log or reject messages.
34453
34454 .vitem &$spam_score_int$&
34455 The spam score of the message, multiplied by ten, as an integer value. For
34456 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34457 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34458 The integer value is useful for numeric comparisons in conditions.
34459
34460 .vitem &$spam_bar$&
34461 A string consisting of a number of &"+"& or &"-"& characters, representing the
34462 integer part of the spam score value. A spam score of 4.4 would have a
34463 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34464 headers, since MUAs can match on such strings. The maximum length of the
34465 spam bar is 50 characters.
34466
34467 .vitem &$spam_report$&
34468 A multiline text table, containing the full SpamAssassin report for the
34469 message. Useful for inclusion in headers or reject messages.
34470 This variable is only usable in a DATA-time ACL.
34471 Beware that SpamAssassin may return non-ASCII characters, especially
34472 when running in country-specific locales, which are not legal
34473 unencoded in headers.
34474
34475 .vitem &$spam_action$&
34476 For SpamAssassin either 'reject' or 'no action' depending on the
34477 spam score versus threshold.
34478 For Rspamd, the recommended action.
34479
34480 .endlist
34481
34482 The &%spam%& condition caches its results unless expansion in
34483 spamd_address was used. If you call it again with the same user name, it
34484 does not scan again, but rather returns the same values as before.
34485
34486 The &%spam%& condition returns DEFER if there is any error while running
34487 the message through SpamAssassin or if the expansion of spamd_address
34488 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34489 statement block), append &`/defer_ok`& to the right-hand side of the
34490 spam condition, like this:
34491 .code
34492 deny spam    = joe/defer_ok
34493      message = This message was classified as SPAM
34494 .endd
34495 This causes messages to be accepted even if there is a problem with &%spamd%&.
34496
34497 Here is a longer, commented example of the use of the &%spam%&
34498 condition:
34499 .code
34500 # put headers in all messages (no matter if spam or not)
34501 warn  spam = nobody:true
34502       add_header = X-Spam-Score: $spam_score ($spam_bar)
34503       add_header = X-Spam-Report: $spam_report
34504
34505 # add second subject line with *SPAM* marker when message
34506 # is over threshold
34507 warn  spam = nobody
34508       add_header = Subject: *SPAM* $h_Subject:
34509
34510 # reject spam at high scores (> 12)
34511 deny  spam = nobody:true
34512       condition = ${if >{$spam_score_int}{120}{1}{0}}
34513       message = This message scored $spam_score spam points.
34514 .endd
34515
34516
34517
34518 .section "Scanning MIME parts" "SECTscanmimepart"
34519 .cindex "content scanning" "MIME parts"
34520 .cindex "MIME content scanning"
34521 .oindex "&%acl_smtp_mime%&"
34522 .oindex "&%acl_not_smtp_mime%&"
34523 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34524 each MIME part of an SMTP message, including multipart types, in the sequence
34525 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34526 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34527 options may both refer to the same ACL if you want the same processing in both
34528 cases.
34529
34530 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34531 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34532 the case of a non-SMTP message. However, a MIME ACL is called only if the
34533 message contains a &'Content-Type:'& header line. When a call to a MIME
34534 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34535 result code is sent to the client. In the case of an SMTP message, the
34536 &%acl_smtp_data%& ACL is not called when this happens.
34537
34538 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34539 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34540 condition to match against the raw MIME part. You can also use the
34541 &%mime_regex%& condition to match against the decoded MIME part (see section
34542 &<<SECTscanregex>>&).
34543
34544 At the start of a MIME ACL, a number of variables are set from the header
34545 information for the relevant MIME part. These are described below. The contents
34546 of the MIME part are not by default decoded into a disk file except for MIME
34547 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34548 part into a disk file, you can use the &%decode%& condition. The general
34549 syntax is:
34550 .display
34551 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34552 .endd
34553 The right hand side is expanded before use. After expansion,
34554 the value can be:
34555
34556 .olist
34557 &"0"& or &"false"&, in which case no decoding is done.
34558 .next
34559 The string &"default"&. In that case, the file is put in the temporary
34560 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34561 a sequential filename consisting of the message id and a sequence number. The
34562 full path and name is available in &$mime_decoded_filename$& after decoding.
34563 .next
34564 A full path name starting with a slash. If the full name is an existing
34565 directory, it is used as a replacement for the default directory. The filename
34566 is then sequentially assigned. If the path does not exist, it is used as
34567 the full path and filename.
34568 .next
34569 If the string does not start with a slash, it is used as the
34570 filename, and the default path is then used.
34571 .endlist
34572 The &%decode%& condition normally succeeds. It is only false for syntax
34573 errors or unusual circumstances such as memory shortages. You can easily decode
34574 a file with its original, proposed filename using
34575 .code
34576 decode = $mime_filename
34577 .endd
34578 However, you should keep in mind that &$mime_filename$& might contain
34579 anything. If you place files outside of the default path, they are not
34580 automatically unlinked.
34581
34582 For RFC822 attachments (these are messages attached to messages, with a
34583 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34584 as for the primary message, only that the &$mime_is_rfc822$& expansion
34585 variable is set (see below). Attached messages are always decoded to disk
34586 before being checked, and the files are unlinked once the check is done.
34587
34588 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34589 used to match regular expressions against raw and decoded MIME parts,
34590 respectively. They are described in section &<<SECTscanregex>>&.
34591
34592 .cindex "MIME content scanning" "returned variables"
34593 The following list describes all expansion variables that are
34594 available in the MIME ACL:
34595
34596 .vlist
34597 .vitem &$mime_anomaly_level$& &&&
34598        &$mime_anomaly_text$&
34599 .vindex &$mime_anomaly_level$&
34600 .vindex &$mime_anomaly_text$&
34601 If there are problems decoding, these variables contain information on
34602 the detected issue.
34603
34604 .vitem &$mime_boundary$&
34605 .vindex &$mime_boundary$&
34606 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34607 have a boundary string, which is stored in this variable. If the current part
34608 has no boundary parameter in the &'Content-Type:'& header, this variable
34609 contains the empty string.
34610
34611 .vitem &$mime_charset$&
34612 .vindex &$mime_charset$&
34613 This variable contains the character set identifier, if one was found in the
34614 &'Content-Type:'& header. Examples for charset identifiers are:
34615 .code
34616 us-ascii
34617 gb2312 (Chinese)
34618 iso-8859-1
34619 .endd
34620 Please note that this value is not normalized, so you should do matches
34621 case-insensitively.
34622
34623 .vitem &$mime_content_description$&
34624 .vindex &$mime_content_description$&
34625 This variable contains the normalized content of the &'Content-Description:'&
34626 header. It can contain a human-readable description of the parts content. Some
34627 implementations repeat the filename for attachments here, but they are usually
34628 only used for display purposes.
34629
34630 .vitem &$mime_content_disposition$&
34631 .vindex &$mime_content_disposition$&
34632 This variable contains the normalized content of the &'Content-Disposition:'&
34633 header. You can expect strings like &"attachment"& or &"inline"& here.
34634
34635 .vitem &$mime_content_id$&
34636 .vindex &$mime_content_id$&
34637 This variable contains the normalized content of the &'Content-ID:'& header.
34638 This is a unique ID that can be used to reference a part from another part.
34639
34640 .vitem &$mime_content_size$&
34641 .vindex &$mime_content_size$&
34642 This variable is set only after the &%decode%& modifier (see above) has been
34643 successfully run. It contains the size of the decoded part in kilobytes. The
34644 size is always rounded up to full kilobytes, so only a completely empty part
34645 has a &$mime_content_size$& of zero.
34646
34647 .vitem &$mime_content_transfer_encoding$&
34648 .vindex &$mime_content_transfer_encoding$&
34649 This variable contains the normalized content of the
34650 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34651 type. Typical values are &"base64"& and &"quoted-printable"&.
34652
34653 .vitem &$mime_content_type$&
34654 .vindex &$mime_content_type$&
34655 If the MIME part has a &'Content-Type:'& header, this variable contains its
34656 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34657 are some examples of popular MIME types, as they may appear in this variable:
34658 .code
34659 text/plain
34660 text/html
34661 application/octet-stream
34662 image/jpeg
34663 audio/midi
34664 .endd
34665 If the MIME part has no &'Content-Type:'& header, this variable contains the
34666 empty string.
34667
34668 .vitem &$mime_decoded_filename$&
34669 .vindex &$mime_decoded_filename$&
34670 This variable is set only after the &%decode%& modifier (see above) has been
34671 successfully run. It contains the full path and filename of the file
34672 containing the decoded data.
34673 .endlist
34674
34675 .cindex "RFC 2047"
34676 .vlist
34677 .vitem &$mime_filename$&
34678 .vindex &$mime_filename$&
34679 This is perhaps the most important of the MIME variables. It contains a
34680 proposed filename for an attachment, if one was found in either the
34681 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34682 RFC2047
34683 or RFC2231
34684 decoded, but no additional sanity checks are done.
34685  If no filename was
34686 found, this variable contains the empty string.
34687
34688 .vitem &$mime_is_coverletter$&
34689 .vindex &$mime_is_coverletter$&
34690 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34691 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34692 content in the cover letter, while not restricting attachments at all.
34693
34694 The variable contains 1 (true) for a MIME part believed to be part of the
34695 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34696 follows:
34697
34698 .olist
34699 The outermost MIME part of a message is always a cover letter.
34700
34701 .next
34702 If a multipart/alternative or multipart/related MIME part is a cover letter,
34703 so are all MIME subparts within that multipart.
34704
34705 .next
34706 If any other multipart is a cover letter, the first subpart is a cover letter,
34707 and the rest are attachments.
34708
34709 .next
34710 All parts contained within an attachment multipart are attachments.
34711 .endlist olist
34712
34713 As an example, the following will ban &"HTML mail"& (including that sent with
34714 alternative plain text), while allowing HTML files to be attached. HTML
34715 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34716 .code
34717 deny !condition = $mime_is_rfc822
34718      condition = $mime_is_coverletter
34719      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34720      message = HTML mail is not accepted here
34721 .endd
34722
34723 .vitem &$mime_is_multipart$&
34724 .vindex &$mime_is_multipart$&
34725 This variable has the value 1 (true) when the current part has the main type
34726 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34727 Since multipart entities only serve as containers for other parts, you may not
34728 want to carry out specific actions on them.
34729
34730 .vitem &$mime_is_rfc822$&
34731 .vindex &$mime_is_rfc822$&
34732 This variable has the value 1 (true) if the current part is not a part of the
34733 checked message itself, but part of an attached message. Attached message
34734 decoding is fully recursive.
34735
34736 .vitem &$mime_part_count$&
34737 .vindex &$mime_part_count$&
34738 This variable is a counter that is raised for each processed MIME part. It
34739 starts at zero for the very first part (which is usually a multipart). The
34740 counter is per-message, so it is reset when processing RFC822 attachments (see
34741 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34742 complete, so you can use it in the DATA ACL to determine the number of MIME
34743 parts of a message. For non-MIME messages, this variable contains the value -1.
34744 .endlist
34745
34746
34747
34748 .section "Scanning with regular expressions" "SECTscanregex"
34749 .cindex "content scanning" "with regular expressions"
34750 .cindex "regular expressions" "content scanning with"
34751 You can specify your own custom regular expression matches on the full body of
34752 the message, or on individual MIME parts.
34753
34754 The &%regex%& condition takes one or more regular expressions as arguments and
34755 matches them against the full message (when called in the DATA ACL) or a raw
34756 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34757 linewise, with a maximum line length of 32K characters. That means you cannot
34758 have multiline matches with the &%regex%& condition.
34759
34760 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34761 to 32K of decoded content (the whole content at once, not linewise). If the
34762 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34763 is decoded automatically when &%mime_regex%& is executed (using default path
34764 and filename values). If the decoded data is larger than  32K, only the first
34765 32K characters are checked.
34766
34767 The regular expressions are passed as a colon-separated list. To include a
34768 literal colon, you must double it. Since the whole right-hand side string is
34769 expanded before being used, you must also escape dollar signs and backslashes
34770 with more backslashes, or use the &`\N`& facility to disable expansion.
34771 Here is a simple example that contains two regular expressions:
34772 .code
34773 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34774      message = contains blacklisted regex ($regex_match_string)
34775 .endd
34776 The conditions returns true if any one of the regular expressions matches. The
34777 &$regex_match_string$& expansion variable is then set up and contains the
34778 matching regular expression.
34779 The expansion variables &$regex1$& &$regex2$& etc
34780 are set to any substrings captured by the regular expression.
34781
34782 &*Warning*&: With large messages, these conditions can be fairly
34783 CPU-intensive.
34784
34785 .ecindex IIDcosca
34786
34787
34788
34789
34790 . ////////////////////////////////////////////////////////////////////////////
34791 . ////////////////////////////////////////////////////////////////////////////
34792
34793 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34794          "Local scan function"
34795 .scindex IIDlosca "&[local_scan()]& function" "description of"
34796 .cindex "customizing" "input scan using C function"
34797 .cindex "policy control" "by local scan function"
34798 In these days of email worms, viruses, and ever-increasing spam, some sites
34799 want to apply a lot of checking to messages before accepting them.
34800
34801 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34802 passing messages to external virus and spam scanning software. You can also do
34803 a certain amount in Exim itself through string expansions and the &%condition%&
34804 condition in the ACL that runs after the SMTP DATA command or the ACL for
34805 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34806
34807 To allow for further customization to a site's own requirements, there is the
34808 possibility of linking Exim with a private message scanning function, written
34809 in C. If you want to run code that is written in something other than C, you
34810 can of course use a little C stub to call it.
34811
34812 The local scan function is run once for every incoming message, at the point
34813 when Exim is just about to accept the message.
34814 It can therefore be used to control non-SMTP messages from local processes as
34815 well as messages arriving via SMTP.
34816
34817 Exim applies a timeout to calls of the local scan function, and there is an
34818 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34819 Zero means &"no timeout"&.
34820 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34821 before calling the local scan function, so that the most common types of crash
34822 are caught. If the timeout is exceeded or one of those signals is caught, the
34823 incoming message is rejected with a temporary error if it is an SMTP message.
34824 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34825 code. The incident is logged on the main and reject logs.
34826
34827
34828
34829 .section "Building Exim to use a local scan function" "SECID207"
34830 .cindex "&[local_scan()]& function" "building Exim to use"
34831 To make use of the local scan function feature, you must tell Exim where your
34832 function is before building Exim, by setting
34833 both HAVE_LOCAL_SCAN and
34834 LOCAL_SCAN_SOURCE in your
34835 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34836 directory, so you might set
34837 .code
34838 HAVE_LOCAL_SCAN=yes
34839 LOCAL_SCAN_SOURCE=Local/local_scan.c
34840 .endd
34841 for example. The function must be called &[local_scan()]&;
34842 the source file(s) for it should first #define LOCAL_SCAN
34843 and then #include "local_scan.h".
34844 It is called by
34845 Exim after it has received a message, when the success return code is about to
34846 be sent. This is after all the ACLs have been run. The return code from your
34847 function controls whether the message is actually accepted or not. There is a
34848 commented template function (that just accepts the message) in the file
34849 _src/local_scan.c_.
34850
34851 If you want to make use of Exim's runtime configuration file to set options
34852 for your &[local_scan()]& function, you must also set
34853 .code
34854 LOCAL_SCAN_HAS_OPTIONS=yes
34855 .endd
34856 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34857
34858
34859
34860
34861 .section "API for local_scan()" "SECTapiforloc"
34862 .cindex "&[local_scan()]& function" "API description"
34863 .cindex &%dlfunc%& "API description"
34864 You must include this line near the start of your code:
34865 .code
34866 #define LOCAL_SCAN
34867 #include "local_scan.h"
34868 .endd
34869 This header file defines a number of variables and other values, and the
34870 prototype for the function itself. Exim is coded to use unsigned char values
34871 almost exclusively, and one of the things this header defines is a shorthand
34872 for &`unsigned char`& called &`uschar`&.
34873 It also makes available the following macro definitions, to simplify casting character
34874 strings and pointers to character strings:
34875 .code
34876 #define CS   (char *)
34877 #define CCS  (const char *)
34878 #define CSS  (char **)
34879 #define US   (unsigned char *)
34880 #define CUS  (const unsigned char *)
34881 #define USS  (unsigned char **)
34882 .endd
34883 The function prototype for &[local_scan()]& is:
34884 .code
34885 extern int local_scan(int fd, uschar **return_text);
34886 .endd
34887 The arguments are as follows:
34888
34889 .ilist
34890 &%fd%& is a file descriptor for the file that contains the body of the message
34891 (the -D file). The file is open for reading and writing, but updating it is not
34892 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34893
34894 The descriptor is positioned at character 19 of the file, which is the first
34895 character of the body itself, because the first 19 characters are the message
34896 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34897 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34898 case this changes in some future version.
34899 .next
34900 &%return_text%& is an address which you can use to return a pointer to a text
34901 string at the end of the function. The value it points to on entry is NULL.
34902 .endlist
34903
34904 The function must return an &%int%& value which is one of the following macros:
34905
34906 .vlist
34907 .vitem &`LOCAL_SCAN_ACCEPT`&
34908 .vindex "&$local_scan_data$&"
34909 The message is accepted. If you pass back a string of text, it is saved with
34910 the message, and made available in the variable &$local_scan_data$&. No
34911 newlines are permitted (if there are any, they are turned into spaces) and the
34912 maximum length of text is 1000 characters.
34913
34914 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34915 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34916 queued without immediate delivery, and is frozen.
34917
34918 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34919 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34920 queued without immediate delivery.
34921
34922 .vitem &`LOCAL_SCAN_REJECT`&
34923 The message is rejected; the returned text is used as an error message which is
34924 passed back to the sender and which is also logged. Newlines are permitted &--
34925 they cause a multiline response for SMTP rejections, but are converted to
34926 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34927 used.
34928
34929 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34930 The message is temporarily rejected; the returned text is used as an error
34931 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34932 problem"& is used.
34933
34934 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34935 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34936 message is not written to the reject log. It has the effect of unsetting the
34937 &%rejected_header%& log selector for just this rejection. If
34938 &%rejected_header%& is already unset (see the discussion of the
34939 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34940 same as LOCAL_SCAN_REJECT.
34941
34942 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34943 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34944 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34945 .endlist
34946
34947 If the message is not being received by interactive SMTP, rejections are
34948 reported by writing to &%stderr%& or by sending an email, as configured by the
34949 &%-oe%& command line options.
34950
34951
34952
34953 .section "Configuration options for local_scan()" "SECTconoptloc"
34954 .cindex "&[local_scan()]& function" "configuration options"
34955 It is possible to have option settings in the main configuration file
34956 that set values in static variables in the &[local_scan()]& module. If you
34957 want to do this, you must have the line
34958 .code
34959 LOCAL_SCAN_HAS_OPTIONS=yes
34960 .endd
34961 in your &_Local/Makefile_& when you build Exim. (This line is in
34962 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34963 file, you must define static variables to hold the option values, and a table
34964 to define them.
34965
34966 The table must be a vector called &%local_scan_options%&, of type
34967 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34968 and a pointer to the variable that holds the value. The entries must appear in
34969 alphabetical order. Following &%local_scan_options%& you must also define a
34970 variable called &%local_scan_options_count%& that contains the number of
34971 entries in the table. Here is a short example, showing two kinds of option:
34972 .code
34973 static int my_integer_option = 42;
34974 static uschar *my_string_option = US"a default string";
34975
34976 optionlist local_scan_options[] = {
34977   { "my_integer", opt_int,       &my_integer_option },
34978   { "my_string",  opt_stringptr, &my_string_option }
34979 };
34980
34981 int local_scan_options_count =
34982   sizeof(local_scan_options)/sizeof(optionlist);
34983 .endd
34984 The values of the variables can now be changed from Exim's runtime
34985 configuration file by including a local scan section as in this example:
34986 .code
34987 begin local_scan
34988 my_integer = 99
34989 my_string = some string of text...
34990 .endd
34991 The available types of option data are as follows:
34992
34993 .vlist
34994 .vitem &*opt_bool*&
34995 This specifies a boolean (true/false) option. The address should point to a
34996 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34997 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34998 whether such a variable has been set at all, you can initialize it to
34999 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
35000 values.)
35001
35002 .vitem &*opt_fixed*&
35003 This specifies a fixed point number, such as is used for load averages.
35004 The address should point to a variable of type &`int`&. The value is stored
35005 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
35006
35007 .vitem &*opt_int*&
35008 This specifies an integer; the address should point to a variable of type
35009 &`int`&. The value may be specified in any of the integer formats accepted by
35010 Exim.
35011
35012 .vitem &*opt_mkint*&
35013 This is the same as &%opt_int%&, except that when such a value is output in a
35014 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
35015 printed with the suffix K or M.
35016
35017 .vitem &*opt_octint*&
35018 This also specifies an integer, but the value is always interpreted as an
35019 octal integer, whether or not it starts with the digit zero, and it is
35020 always output in octal.
35021
35022 .vitem &*opt_stringptr*&
35023 This specifies a string value; the address must be a pointer to a
35024 variable that points to a string (for example, of type &`uschar *`&).
35025
35026 .vitem &*opt_time*&
35027 This specifies a time interval value. The address must point to a variable of
35028 type &`int`&. The value that is placed there is a number of seconds.
35029 .endlist
35030
35031 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
35032 out the values of all the &[local_scan()]& options.
35033
35034
35035
35036 .section "Available Exim variables" "SECID208"
35037 .cindex "&[local_scan()]& function" "available Exim variables"
35038 The header &_local_scan.h_& gives you access to a number of C variables. These
35039 are the only ones that are guaranteed to be maintained from release to release.
35040 Note, however, that you can obtain the value of any Exim expansion variable,
35041 including &$recipients$&, by calling &'expand_string()'&. The exported
35042 C variables are as follows:
35043
35044 .vlist
35045 .vitem &*int&~body_linecount*&
35046 This variable contains the number of lines in the message's body.
35047 It is not valid if the &%spool_files_wireformat%& option is used.
35048
35049 .vitem &*int&~body_zerocount*&
35050 This variable contains the number of binary zero bytes in the message's body.
35051 It is not valid if the &%spool_files_wireformat%& option is used.
35052
35053 .vitem &*unsigned&~int&~debug_selector*&
35054 This variable is set to zero when no debugging is taking place. Otherwise, it
35055 is a bitmap of debugging selectors. Two bits are identified for use in
35056 &[local_scan()]&; they are defined as macros:
35057
35058 .ilist
35059 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
35060 testing option that is not privileged &-- any caller may set it. All the
35061 other selector bits can be set only by admin users.
35062
35063 .next
35064 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
35065 by the &`+local_scan`& debug selector. It is not included in the default set
35066 of debugging bits.
35067 .endlist ilist
35068
35069 Thus, to write to the debugging output only when &`+local_scan`& has been
35070 selected, you should use code like this:
35071 .code
35072 if ((debug_selector & D_local_scan) != 0)
35073   debug_printf("xxx", ...);
35074 .endd
35075 .vitem &*uschar&~*expand_string_message*&
35076 After a failing call to &'expand_string()'& (returned value NULL), the
35077 variable &%expand_string_message%& contains the error message, zero-terminated.
35078
35079 .vitem &*header_line&~*header_list*&
35080 A pointer to a chain of header lines. The &%header_line%& structure is
35081 discussed below.
35082
35083 .vitem &*header_line&~*header_last*&
35084 A pointer to the last of the header lines.
35085
35086 .vitem &*uschar&~*headers_charset*&
35087 The value of the &%headers_charset%& configuration option.
35088
35089 .vitem &*BOOL&~host_checking*&
35090 This variable is TRUE during a host checking session that is initiated by the
35091 &%-bh%& command line option.
35092
35093 .vitem &*uschar&~*interface_address*&
35094 The IP address of the interface that received the message, as a string. This
35095 is NULL for locally submitted messages.
35096
35097 .vitem &*int&~interface_port*&
35098 The port on which this message was received. When testing with the &%-bh%&
35099 command line option, the value of this variable is -1 unless a port has been
35100 specified via the &%-oMi%& option.
35101
35102 .vitem &*uschar&~*message_id*&
35103 This variable contains Exim's message id for the incoming message (the value of
35104 &$message_exim_id$&) as a zero-terminated string.
35105
35106 .vitem &*uschar&~*received_protocol*&
35107 The name of the protocol by which the message was received.
35108
35109 .vitem &*int&~recipients_count*&
35110 The number of accepted recipients.
35111
35112 .vitem &*recipient_item&~*recipients_list*&
35113 .cindex "recipient" "adding in local scan"
35114 .cindex "recipient" "removing in local scan"
35115 The list of accepted recipients, held in a vector of length
35116 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
35117 can add additional recipients by calling &'receive_add_recipient()'& (see
35118 below). You can delete recipients by removing them from the vector and
35119 adjusting the value in &%recipients_count%&. In particular, by setting
35120 &%recipients_count%& to zero you remove all recipients. If you then return the
35121 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
35122 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
35123 and then call &'receive_add_recipient()'& as often as needed.
35124
35125 .vitem &*uschar&~*sender_address*&
35126 The envelope sender address. For bounce messages this is the empty string.
35127
35128 .vitem &*uschar&~*sender_host_address*&
35129 The IP address of the sending host, as a string. This is NULL for
35130 locally-submitted messages.
35131
35132 .vitem &*uschar&~*sender_host_authenticated*&
35133 The name of the authentication mechanism that was used, or NULL if the message
35134 was not received over an authenticated SMTP connection.
35135
35136 .vitem &*uschar&~*sender_host_name*&
35137 The name of the sending host, if known.
35138
35139 .vitem &*int&~sender_host_port*&
35140 The port on the sending host.
35141
35142 .vitem &*BOOL&~smtp_input*&
35143 This variable is TRUE for all SMTP input, including BSMTP.
35144
35145 .vitem &*BOOL&~smtp_batched_input*&
35146 This variable is TRUE for BSMTP input.
35147
35148 .vitem &*int&~store_pool*&
35149 The contents of this variable control which pool of memory is used for new
35150 requests. See section &<<SECTmemhanloc>>& for details.
35151 .endlist
35152
35153
35154 .section "Structure of header lines" "SECID209"
35155 The &%header_line%& structure contains the members listed below.
35156 You can add additional header lines by calling the &'header_add()'& function
35157 (see below). You can cause header lines to be ignored (deleted) by setting
35158 their type to *.
35159
35160
35161 .vlist
35162 .vitem &*struct&~header_line&~*next*&
35163 A pointer to the next header line, or NULL for the last line.
35164
35165 .vitem &*int&~type*&
35166 A code identifying certain headers that Exim recognizes. The codes are printing
35167 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
35168 Notice in particular that any header line whose type is * is not transmitted
35169 with the message. This flagging is used for header lines that have been
35170 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
35171 lines.) Effectively, * means &"deleted"&.
35172
35173 .vitem &*int&~slen*&
35174 The number of characters in the header line, including the terminating and any
35175 internal newlines.
35176
35177 .vitem &*uschar&~*text*&
35178 A pointer to the text of the header. It always ends with a newline, followed by
35179 a zero byte. Internal newlines are preserved.
35180 .endlist
35181
35182
35183
35184 .section "Structure of recipient items" "SECID210"
35185 The &%recipient_item%& structure contains these members:
35186
35187 .vlist
35188 .vitem &*uschar&~*address*&
35189 This is a pointer to the recipient address as it was received.
35190
35191 .vitem &*int&~pno*&
35192 This is used in later Exim processing when top level addresses are created by
35193 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
35194 and must always contain -1 at this stage.
35195
35196 .vitem &*uschar&~*errors_to*&
35197 If this value is not NULL, bounce messages caused by failing to deliver to the
35198 recipient are sent to the address it contains. In other words, it overrides the
35199 envelope sender for this one recipient. (Compare the &%errors_to%& generic
35200 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
35201 an unqualified address, Exim qualifies it using the domain from
35202 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
35203 is NULL for all recipients.
35204 .endlist
35205
35206
35207
35208 .section "Available Exim functions" "SECID211"
35209 .cindex "&[local_scan()]& function" "available Exim functions"
35210 The header &_local_scan.h_& gives you access to a number of Exim functions.
35211 These are the only ones that are guaranteed to be maintained from release to
35212 release:
35213
35214 .vlist
35215 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
35216        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
35217
35218 This function creates a child process that runs the command specified by
35219 &%argv%&. The environment for the process is specified by &%envp%&, which can
35220 be NULL if no environment variables are to be passed. A new umask is supplied
35221 for the process in &%newumask%&.
35222
35223 Pipes to the standard input and output of the new process are set up
35224 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
35225 standard error is cloned to the standard output. If there are any file
35226 descriptors &"in the way"& in the new process, they are closed. If the final
35227 argument is TRUE, the new process is made into a process group leader.
35228
35229 The function returns the pid of the new process, or -1 if things go wrong.
35230
35231 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
35232 This function waits for a child process to terminate, or for a timeout (in
35233 seconds) to expire. A timeout value of zero means wait as long as it takes. The
35234 return value is as follows:
35235
35236 .ilist
35237 >= 0
35238
35239 The process terminated by a normal exit and the value is the process
35240 ending status.
35241
35242 .next
35243 < 0 and > &--256
35244
35245 The process was terminated by a signal and the value is the negation of the
35246 signal number.
35247
35248 .next
35249 &--256
35250
35251 The process timed out.
35252 .next
35253 &--257
35254
35255 The was some other error in wait(); &%errno%& is still set.
35256 .endlist
35257
35258 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
35259 This function provide you with a means of submitting a new message to
35260 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
35261 want, but this packages it all up for you.) The function creates a pipe,
35262 forks a subprocess that is running
35263 .code
35264 exim -t -oem -oi -f <>
35265 .endd
35266 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
35267 that is connected to the standard input. The yield of the function is the PID
35268 of the subprocess. You can then write a message to the file descriptor, with
35269 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
35270
35271 When you have finished, call &'child_close()'& to wait for the process to
35272 finish and to collect its ending status. A timeout value of zero is usually
35273 fine in this circumstance. Unless you have made a mistake with the recipient
35274 addresses, you should get a return code of zero.
35275
35276
35277 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
35278        *sender_authentication)*&
35279 This function is a more sophisticated version of &'child_open()'&. The command
35280 that it runs is:
35281 .display
35282 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
35283 .endd
35284 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
35285
35286
35287 .vitem &*void&~debug_printf(char&~*,&~...)*&
35288 This is Exim's debugging function, with arguments as for &'(printf()'&. The
35289 output is written to the standard error stream. If no debugging is selected,
35290 calls to &'debug_printf()'& have no effect. Normally, you should make calls
35291 conditional on the &`local_scan`& debug selector by coding like this:
35292 .code
35293 if ((debug_selector & D_local_scan) != 0)
35294   debug_printf("xxx", ...);
35295 .endd
35296
35297 .vitem &*uschar&~*expand_string(uschar&~*string)*&
35298 This is an interface to Exim's string expansion code. The return value is the
35299 expanded string, or NULL if there was an expansion failure.
35300 The C variable &%expand_string_message%& contains an error message after an
35301 expansion failure. If expansion does not change the string, the return value is
35302 the pointer to the input string. Otherwise, the return value points to a new
35303 block of memory that was obtained by a call to &'store_get()'&. See section
35304 &<<SECTmemhanloc>>& below for a discussion of memory handling.
35305
35306 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
35307 This function allows you to an add additional header line at the end of the
35308 existing ones. The first argument is the type, and should normally be a space
35309 character. The second argument is a format string and any number of
35310 substitution arguments as for &[sprintf()]&. You may include internal newlines
35311 if you want, and you must ensure that the string ends with a newline.
35312
35313 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
35314         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
35315 This function adds a new header line at a specified point in the header
35316 chain. The header itself is specified as for &'header_add()'&.
35317
35318 If &%name%& is NULL, the new header is added at the end of the chain if
35319 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
35320 NULL, the header lines are searched for the first non-deleted header that
35321 matches the name. If one is found, the new header is added before it if
35322 &%after%& is false. If &%after%& is true, the new header is added after the
35323 found header and any adjacent subsequent ones with the same name (even if
35324 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
35325 option controls where the header is added. If it is true, addition is at the
35326 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
35327 headers, or at the top if there are no &'Received:'& headers, you could use
35328 .code
35329 header_add_at_position(TRUE, US"Received", TRUE,
35330   ' ', "X-xxx: ...");
35331 .endd
35332 Normally, there is always at least one non-deleted &'Received:'& header, but
35333 there may not be if &%received_header_text%& expands to an empty string.
35334
35335
35336 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
35337 This function removes header lines. If &%occurrence%& is zero or negative, all
35338 occurrences of the header are removed. If occurrence is greater than zero, that
35339 particular instance of the header is removed. If no header(s) can be found that
35340 match the specification, the function does nothing.
35341
35342
35343 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
35344         int&~length,&~BOOL&~notdel)*&"
35345 This function tests whether the given header has the given name. It is not just
35346 a string comparison, because white space is permitted between the name and the
35347 colon. If the &%notdel%& argument is true, a false return is forced for all
35348 &"deleted"& headers; otherwise they are not treated specially. For example:
35349 .code
35350 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
35351 .endd
35352 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
35353 .cindex "base64 encoding" "functions for &[local_scan()]& use"
35354 This function base64-encodes a string, which is passed by address and length.
35355 The text may contain bytes of any value, including zero. The result is passed
35356 back in dynamic memory that is obtained by calling &'store_get()'&. It is
35357 zero-terminated.
35358
35359 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
35360 This function decodes a base64-encoded string. Its arguments are a
35361 zero-terminated base64-encoded string and the address of a variable that is set
35362 to point to the result, which is in dynamic memory. The length of the decoded
35363 string is the yield of the function. If the input is invalid base64 data, the
35364 yield is -1. A zero byte is added to the end of the output string to make it
35365 easy to interpret as a C string (assuming it contains no zeros of its own). The
35366 added zero byte is not included in the returned count.
35367
35368 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
35369 This function checks for a match in a domain list. Domains are always
35370 matched caselessly. The return value is one of the following:
35371 .display
35372 &`OK     `& match succeeded
35373 &`FAIL   `& match failed
35374 &`DEFER  `& match deferred
35375 .endd
35376 DEFER is usually caused by some kind of lookup defer, such as the
35377 inability to contact a database.
35378
35379 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
35380         BOOL&~caseless)*&"
35381 This function checks for a match in a local part list. The third argument
35382 controls case-sensitivity. The return values are as for
35383 &'lss_match_domain()'&.
35384
35385 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
35386         BOOL&~caseless)*&"
35387 This function checks for a match in an address list. The third argument
35388 controls the case-sensitivity of the local part match. The domain is always
35389 matched caselessly. The return values are as for &'lss_match_domain()'&.
35390
35391 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
35392         uschar&~*list)*&"
35393 This function checks for a match in a host list. The most common usage is
35394 expected to be
35395 .code
35396 lss_match_host(sender_host_name, sender_host_address, ...)
35397 .endd
35398 .vindex "&$sender_host_address$&"
35399 An empty address field matches an empty item in the host list. If the host name
35400 is NULL, the name corresponding to &$sender_host_address$& is automatically
35401 looked up if a host name is required to match an item in the list. The return
35402 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
35403 returns ERROR in the case when it had to look up a host name, but the lookup
35404 failed.
35405
35406 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
35407         *format,&~...)*&"
35408 This function writes to Exim's log files. The first argument should be zero (it
35409 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35410 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35411 them. It specifies to which log or logs the message is written. The remaining
35412 arguments are a format and relevant insertion arguments. The string should not
35413 contain any newlines, not even at the end.
35414
35415
35416 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35417 This function adds an additional recipient to the message. The first argument
35418 is the recipient address. If it is unqualified (has no domain), it is qualified
35419 with the &%qualify_recipient%& domain. The second argument must always be -1.
35420
35421 This function does not allow you to specify a private &%errors_to%& address (as
35422 described with the structure of &%recipient_item%& above), because it pre-dates
35423 the addition of that field to the structure. However, it is easy to add such a
35424 value afterwards. For example:
35425 .code
35426  receive_add_recipient(US"monitor@mydom.example", -1);
35427  recipients_list[recipients_count-1].errors_to =
35428    US"postmaster@mydom.example";
35429 .endd
35430
35431 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35432 This is a convenience function to remove a named recipient from the list of
35433 recipients. It returns true if a recipient was removed, and false if no
35434 matching recipient could be found. The argument must be a complete email
35435 address.
35436 .endlist
35437
35438
35439 .cindex "RFC 2047"
35440 .vlist
35441 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35442   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35443 This function decodes strings that are encoded according to RFC 2047. Typically
35444 these are the contents of header lines. First, each &"encoded word"& is decoded
35445 from the Q or B encoding into a byte-string. Then, if provided with the name of
35446 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35447 made  to translate the result to the named character set. If this fails, the
35448 binary string is returned with an error message.
35449
35450 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35451 maximum MIME word length is enforced. The third argument is the target
35452 encoding, or NULL if no translation is wanted.
35453
35454 .cindex "binary zero" "in RFC 2047 decoding"
35455 .cindex "RFC 2047" "binary zero in"
35456 If a binary zero is encountered in the decoded string, it is replaced by the
35457 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35458 not be 0 because header lines are handled as zero-terminated strings.
35459
35460 The function returns the result of processing the string, zero-terminated; if
35461 &%lenptr%& is not NULL, the length of the result is set in the variable to
35462 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35463
35464 If an error is encountered, the function returns NULL and uses the &%error%&
35465 argument to return an error message. The variable pointed to by &%error%& is
35466 set to NULL if there is no error; it may be set non-NULL even when the function
35467 returns a non-NULL value if decoding was successful, but there was a problem
35468 with translation.
35469
35470
35471 .vitem &*int&~smtp_fflush(void)*&
35472 This function is used in conjunction with &'smtp_printf()'&, as described
35473 below.
35474
35475 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35476 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35477 output stream. You should use this function only when there is an SMTP output
35478 stream, that is, when the incoming message is being received via interactive
35479 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35480 is FALSE. If you want to test for an incoming message from another host (as
35481 opposed to a local process that used the &%-bs%& command line option), you can
35482 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35483 is involved.
35484
35485 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35486 output function, so it can be used for all forms of SMTP connection.
35487
35488 The second argument is used to request that the data be buffered
35489 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35490 This is advisory only, but likely to save on system-calls and packets
35491 sent when a sequence of calls to the function are made.
35492
35493 The argument was added in Exim version 4.90 - changing the API/ABI.
35494 Nobody noticed until 4.93 was imminent, at which point the
35495 ABI version number was incremented.
35496
35497 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35498 must start with an appropriate response code: 550 if you are going to return
35499 LOCAL_SCAN_REJECT, 451 if you are going to return
35500 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35501 initial lines of a multi-line response, the code must be followed by a hyphen
35502 to indicate that the line is not the final response line. You must also ensure
35503 that the lines you write terminate with CRLF. For example:
35504 .code
35505 smtp_printf("550-this is some extra info\r\n");
35506 return LOCAL_SCAN_REJECT;
35507 .endd
35508 Note that you can also create multi-line responses by including newlines in
35509 the data returned via the &%return_text%& argument. The added value of using
35510 &'smtp_printf()'& is that, for instance, you could introduce delays between
35511 multiple output lines.
35512
35513 The &'smtp_printf()'& function does not return any error indication, because it
35514 does not
35515 guarantee a flush of
35516 pending output, and therefore does not test
35517 the state of the stream. (In the main code of Exim, flushing and error
35518 detection is done when Exim is ready for the next SMTP input command.) If
35519 you want to flush the output and check for an error (for example, the
35520 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35521 arguments. It flushes the output stream, and returns a non-zero value if there
35522 is an error.
35523
35524 .vitem &*void&~*store_get(int,BOOL)*&
35525 This function accesses Exim's internal store (memory) manager. It gets a new
35526 chunk of memory whose size is given by the first argument.
35527 The second argument should be given as TRUE if the memory will be used for
35528 data possibly coming from an attacker (eg. the message content),
35529 FALSE if it is locally-sourced.
35530 Exim bombs out if it ever
35531 runs out of memory. See the next section for a discussion of memory handling.
35532
35533 .vitem &*void&~*store_get_perm(int,BOOL)*&
35534 This function is like &'store_get()'&, but it always gets memory from the
35535 permanent pool. See the next section for a discussion of memory handling.
35536
35537 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35538 See below.
35539
35540 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35541 See below.
35542
35543 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35544 These three functions create strings using Exim's dynamic memory facilities.
35545 The first makes a copy of an entire string. The second copies up to a maximum
35546 number of characters, indicated by the second argument. The third uses a format
35547 and insertion arguments to create a new string. In each case, the result is a
35548 pointer to a new string in the current memory pool. See the next section for
35549 more discussion.
35550 .endlist
35551
35552
35553
35554 .section "More about Exim's memory handling" "SECTmemhanloc"
35555 .cindex "&[local_scan()]& function" "memory handling"
35556 No function is provided for freeing memory, because that is never needed.
35557 The dynamic memory that Exim uses when receiving a message is automatically
35558 recycled if another message is received by the same process (this applies only
35559 to incoming SMTP connections &-- other input methods can supply only one
35560 message at a time). After receiving the last message, a reception process
35561 terminates.
35562
35563 Because it is recycled, the normal dynamic memory cannot be used for holding
35564 data that must be preserved over a number of incoming messages on the same SMTP
35565 connection. However, Exim in fact uses two pools of dynamic memory; the second
35566 one is not recycled, and can be used for this purpose.
35567
35568 If you want to allocate memory that remains available for subsequent messages
35569 in the same SMTP connection, you should set
35570 .code
35571 store_pool = POOL_PERM
35572 .endd
35573 before calling the function that does the allocation. There is no need to
35574 restore the value if you do not need to; however, if you do want to revert to
35575 the normal pool, you can either restore the previous value of &%store_pool%& or
35576 set it explicitly to POOL_MAIN.
35577
35578 The pool setting applies to all functions that get dynamic memory, including
35579 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35580 There is also a convenience function called &'store_get_perm()'& that gets a
35581 block of memory from the permanent pool while preserving the value of
35582 &%store_pool%&.
35583 .ecindex IIDlosca
35584
35585
35586
35587
35588 . ////////////////////////////////////////////////////////////////////////////
35589 . ////////////////////////////////////////////////////////////////////////////
35590
35591 .chapter "System-wide message filtering" "CHAPsystemfilter"
35592 .scindex IIDsysfil1 "filter" "system filter"
35593 .scindex IIDsysfil2 "filtering all mail"
35594 .scindex IIDsysfil3 "system filter"
35595 The previous chapters (on ACLs and the local scan function) describe checks
35596 that can be applied to messages before they are accepted by a host. There is
35597 also a mechanism for checking messages once they have been received, but before
35598 they are delivered. This is called the &'system filter'&.
35599
35600 The system filter operates in a similar manner to users' filter files, but it
35601 is run just once per message (however many recipients the message has).
35602 It should not normally be used as a substitute for routing, because &%deliver%&
35603 commands in a system router provide new envelope recipient addresses.
35604 The system filter must be an Exim filter. It cannot be a Sieve filter.
35605
35606 The system filter is run at the start of a delivery attempt, before any routing
35607 is done. If a message fails to be completely delivered at the first attempt,
35608 the system filter is run again at the start of every retry.
35609 If you want your filter to do something only once per message, you can make use
35610 of the &%first_delivery%& condition in an &%if%& command in the filter to
35611 prevent it happening on retries.
35612
35613 .vindex "&$domain$&"
35614 .vindex "&$local_part$&"
35615 &*Warning*&: Because the system filter runs just once, variables that are
35616 specific to individual recipient addresses, such as &$local_part$& and
35617 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35618 you want to run a centrally-specified filter for each recipient address
35619 independently, you can do so by setting up a suitable &(redirect)& router, as
35620 described in section &<<SECTperaddfil>>& below.
35621
35622
35623 .section "Specifying a system filter" "SECID212"
35624 .cindex "uid (user id)" "system filter"
35625 .cindex "gid (group id)" "system filter"
35626 The name of the file that contains the system filter must be specified by
35627 setting &%system_filter%&. If you want the filter to run under a uid and gid
35628 other than root, you must also set &%system_filter_user%& and
35629 &%system_filter_group%& as appropriate. For example:
35630 .code
35631 system_filter = /etc/mail/exim.filter
35632 system_filter_user = exim
35633 .endd
35634 If a system filter generates any deliveries directly to files or pipes (via the
35635 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35636 specified by setting &%system_filter_file_transport%& and
35637 &%system_filter_pipe_transport%&, respectively. Similarly,
35638 &%system_filter_reply_transport%& must be set to handle any messages generated
35639 by the &%reply%& command.
35640
35641
35642 .section "Testing a system filter" "SECID213"
35643 You can run simple tests of a system filter in the same way as for a user
35644 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35645 are permitted only in system filters are recognized.
35646
35647 If you want to test the combined effect of a system filter and a user filter,
35648 you can use both &%-bF%& and &%-bf%& on the same command line.
35649
35650
35651
35652 .section "Contents of a system filter" "SECID214"
35653 The language used to specify system filters is the same as for users' filter
35654 files. It is described in the separate end-user document &'Exim's interface to
35655 mail filtering'&. However, there are some additional features that are
35656 available only in system filters; these are described in subsequent sections.
35657 If they are encountered in a user's filter file or when testing with &%-bf%&,
35658 they cause errors.
35659
35660 .cindex "frozen messages" "manual thaw; testing in filter"
35661 There are two special conditions which, though available in users' filter
35662 files, are designed for use in system filters. The condition &%first_delivery%&
35663 is true only for the first attempt at delivering a message, and
35664 &%manually_thawed%& is true only if the message has been frozen, and
35665 subsequently thawed by an admin user. An explicit forced delivery counts as a
35666 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35667
35668 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35669 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35670 succeed, it will not be tried again.
35671 If you want Exim to retry an unseen delivery until it succeeds, you should
35672 arrange to set it up every time the filter runs.
35673
35674 When a system filter finishes running, the values of the variables &$n0$& &--
35675 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35676 users' filter files. Thus a system filter can, for example, set up &"scores"&
35677 to which users' filter files can refer.
35678
35679
35680
35681 .section "Additional variable for system filters" "SECID215"
35682 .vindex "&$recipients$&"
35683 The expansion variable &$recipients$&, containing a list of all the recipients
35684 of the message (separated by commas and white space), is available in system
35685 filters. It is not available in users' filters for privacy reasons.
35686
35687
35688
35689 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35690 .cindex "freezing messages"
35691 .cindex "message" "freezing"
35692 .cindex "message" "forced failure"
35693 .cindex "&%fail%&" "in system filter"
35694 .cindex "&%freeze%& in system filter"
35695 .cindex "&%defer%& in system filter"
35696 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35697 always available in system filters, but are not normally enabled in users'
35698 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35699 for the &(redirect)& router.) These commands can optionally be followed by the
35700 word &%text%& and a string containing an error message, for example:
35701 .code
35702 fail text "this message looks like spam to me"
35703 .endd
35704 The keyword &%text%& is optional if the next character is a double quote.
35705
35706 The &%defer%& command defers delivery of the original recipients of the
35707 message. The &%fail%& command causes all the original recipients to be failed,
35708 and a bounce message to be created. The &%freeze%& command suspends all
35709 delivery attempts for the original recipients. In all cases, any new deliveries
35710 that are specified by the filter are attempted as normal after the filter has
35711 run.
35712
35713 The &%freeze%& command is ignored if the message has been manually unfrozen and
35714 not manually frozen since. This means that automatic freezing by a system
35715 filter can be used as a way of checking out suspicious messages. If a message
35716 is found to be all right, manually unfreezing it allows it to be delivered.
35717
35718 .cindex "log" "&%fail%& command log line"
35719 .cindex "&%fail%&" "log line; reducing"
35720 The text given with a fail command is used as part of the bounce message as
35721 well as being written to the log. If the message is quite long, this can fill
35722 up a lot of log space when such failures are common. To reduce the size of the
35723 log message, Exim interprets the text in a special way if it starts with the
35724 two characters &`<<`& and contains &`>>`& later. The text between these two
35725 strings is written to the log, and the rest of the text is used in the bounce
35726 message. For example:
35727 .code
35728 fail "<<filter test 1>>Your message is rejected \
35729      because it contains attachments that we are \
35730      not prepared to receive."
35731 .endd
35732
35733 .cindex "loop" "caused by &%fail%&"
35734 Take great care with the &%fail%& command when basing the decision to fail on
35735 the contents of the message, because the bounce message will of course include
35736 the contents of the original message and will therefore trigger the &%fail%&
35737 command again (causing a mail loop) unless steps are taken to prevent this.
35738 Testing the &%error_message%& condition is one way to prevent this. You could
35739 use, for example
35740 .code
35741 if $message_body contains "this is spam" and not error_message
35742 then fail text "spam is not wanted here" endif
35743 .endd
35744 though of course that might let through unwanted bounce messages. The
35745 alternative is clever checking of the body and/or headers to detect bounces
35746 generated by the filter.
35747
35748 The interpretation of a system filter file ceases after a
35749 &%defer%&,
35750 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35751 set up earlier in the filter file are honoured, so you can use a sequence such
35752 as
35753 .code
35754 mail ...
35755 freeze
35756 .endd
35757 to send a specified message when the system filter is freezing (or deferring or
35758 failing) a message. The normal deliveries for the message do not, of course,
35759 take place.
35760
35761
35762
35763 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35764 .cindex "header lines" "adding; in system filter"
35765 .cindex "header lines" "removing; in system filter"
35766 .cindex "filter" "header lines; adding/removing"
35767 Two filter commands that are available only in system filters are:
35768 .code
35769 headers add <string>
35770 headers remove <string>
35771 .endd
35772 The argument for the &%headers add%& is a string that is expanded and then
35773 added to the end of the message's headers. It is the responsibility of the
35774 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35775 space is ignored, and if the string is otherwise empty, or if the expansion is
35776 forced to fail, the command has no effect.
35777
35778 You can use &"\n"& within the string, followed by white space, to specify
35779 continued header lines. More than one header may be added in one command by
35780 including &"\n"& within the string without any following white space. For
35781 example:
35782 .code
35783 headers add "X-header-1: ....\n  \
35784              continuation of X-header-1 ...\n\
35785              X-header-2: ...."
35786 .endd
35787 Note that the header line continuation white space after the first newline must
35788 be placed before the backslash that continues the input string, because white
35789 space after input continuations is ignored.
35790
35791 The argument for &%headers remove%& is a colon-separated list of header names.
35792 This command applies only to those headers that are stored with the message;
35793 those that are added at delivery time (such as &'Envelope-To:'& and
35794 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35795 header with the same name, they are all removed.
35796
35797 The &%headers%& command in a system filter makes an immediate change to the set
35798 of header lines that was received with the message (with possible additions
35799 from ACL processing). Subsequent commands in the system filter operate on the
35800 modified set, which also forms the basis for subsequent message delivery.
35801 Unless further modified during routing or transporting, this set of headers is
35802 used for all recipients of the message.
35803
35804 During routing and transporting, the variables that refer to the contents of
35805 header lines refer only to those lines that are in this set. Thus, header lines
35806 that are added by a system filter are visible to users' filter files and to all
35807 routers and transports. This contrasts with the manipulation of header lines by
35808 routers and transports, which is not immediate, but which instead is saved up
35809 until the message is actually being written (see section
35810 &<<SECTheadersaddrem>>&).
35811
35812 If the message is not delivered at the first attempt, header lines that were
35813 added by the system filter are stored with the message, and so are still
35814 present at the next delivery attempt. Header lines that were removed are still
35815 present, but marked &"deleted"& so that they are not transported with the
35816 message. For this reason, it is usual to make the &%headers%& command
35817 conditional on &%first_delivery%& so that the set of header lines is not
35818 modified more than once.
35819
35820 Because header modification in a system filter acts immediately, you have to
35821 use an indirect approach if you want to modify the contents of a header line.
35822 For example:
35823 .code
35824 headers add "Old-Subject: $h_subject:"
35825 headers remove "Subject"
35826 headers add "Subject: new subject (was: $h_old-subject:)"
35827 headers remove "Old-Subject"
35828 .endd
35829
35830
35831
35832 .section "Setting an errors address in a system filter" "SECID217"
35833 .cindex "envelope from"
35834 .cindex "envelope sender"
35835 In a system filter, if a &%deliver%& command is followed by
35836 .code
35837 errors_to <some address>
35838 .endd
35839 in order to change the envelope sender (and hence the error reporting) for that
35840 delivery, any address may be specified. (In a user filter, only the current
35841 user's address can be set.) For example, if some mail is being monitored, you
35842 might use
35843 .code
35844 unseen deliver monitor@spying.example errors_to root@local.example
35845 .endd
35846 to take a copy which would not be sent back to the normal error reporting
35847 address if its delivery failed.
35848
35849
35850
35851 .section "Per-address filtering" "SECTperaddfil"
35852 .vindex "&$domain_data$&"
35853 .vindex "&$local_part_data$&"
35854 In contrast to the system filter, which is run just once per message for each
35855 delivery attempt, it is also possible to set up a system-wide filtering
35856 operation that runs once for each recipient address. In this case, variables
35857 such as &$local_part_data$& and &$domain_data$& can be used,
35858 and indeed, the choice of filter file could be made dependent on them.
35859 This is an example of a router which implements such a filter:
35860 .code
35861 central_filter:
35862   check_local_user
35863   driver = redirect
35864   domains = +local_domains
35865   file = /central/filters/$local_part_data
35866   no_verify
35867   allow_filter
35868   allow_freeze
35869 .endd
35870 The filter is run in a separate process under its own uid. Therefore, either
35871 &%check_local_user%& must be set (as above), in which case the filter is run as
35872 the local user, or the &%user%& option must be used to specify which user to
35873 use. If both are set, &%user%& overrides.
35874
35875 Care should be taken to ensure that none of the commands in the filter file
35876 specify a significant delivery if the message is to go on to be delivered to
35877 its intended recipient. The router will not then claim to have dealt with the
35878 address, so it will be passed on to subsequent routers to be delivered in the
35879 normal way.
35880 .ecindex IIDsysfil1
35881 .ecindex IIDsysfil2
35882 .ecindex IIDsysfil3
35883
35884
35885
35886
35887
35888
35889 . ////////////////////////////////////////////////////////////////////////////
35890 . ////////////////////////////////////////////////////////////////////////////
35891
35892 .chapter "Message processing" "CHAPmsgproc"
35893 .scindex IIDmesproc "message" "general processing"
35894 Exim performs various transformations on the sender and recipient addresses of
35895 all messages that it handles, and also on the messages' header lines. Some of
35896 these are optional and configurable, while others always take place. All of
35897 this processing, except rewriting as a result of routing, and the addition or
35898 removal of header lines while delivering, happens when a message is received,
35899 before it is placed on Exim's queue.
35900
35901 Some of the automatic processing takes place by default only for
35902 &"locally-originated"& messages. This adjective is used to describe messages
35903 that are not received over TCP/IP, but instead are passed to an Exim process on
35904 its standard input. This includes the interactive &"local SMTP"& case that is
35905 set up by the &%-bs%& command line option.
35906
35907 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35908 or ::1) are not considered to be locally-originated. Exim does not treat the
35909 loopback interface specially in any way.
35910
35911 If you want the loopback interface to be treated specially, you must ensure
35912 that there are appropriate entries in your ACLs.
35913
35914
35915
35916
35917 .section "Submission mode for non-local messages" "SECTsubmodnon"
35918 .cindex "message" "submission"
35919 .cindex "submission mode"
35920 Processing that happens automatically for locally-originated messages (unless
35921 &%suppress_local_fixups%& is set) can also be requested for messages that are
35922 received over TCP/IP. The term &"submission mode"& is used to describe this
35923 state. Submission mode is set by the modifier
35924 .code
35925 control = submission
35926 .endd
35927 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35928 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35929 a local submission, and is normally used when the source of the message is
35930 known to be an MUA running on a client host (as opposed to an MTA). For
35931 example, to set submission mode for messages originating on the IPv4 loopback
35932 interface, you could include the following in the MAIL ACL:
35933 .code
35934 warn  hosts = 127.0.0.1
35935       control = submission
35936 .endd
35937 .cindex "&%sender_retain%& submission option"
35938 There are some options that can be used when setting submission mode. A slash
35939 is used to separate options. For example:
35940 .code
35941 control = submission/sender_retain
35942 .endd
35943 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35944 true and &%local_from_check%& false for the current incoming message. The first
35945 of these allows an existing &'Sender:'& header in the message to remain, and
35946 the second suppresses the check to ensure that &'From:'& matches the
35947 authenticated sender. With this setting, Exim still fixes up messages by adding
35948 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35949 attempt to check sender authenticity in header lines.
35950
35951 When &%sender_retain%& is not set, a submission mode setting may specify a
35952 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35953 example:
35954 .code
35955 control = submission/domain=some.domain
35956 .endd
35957 The domain may be empty. How this value is used is described in sections
35958 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35959 that allows you to specify the user's full name for inclusion in a created
35960 &'Sender:'& or &'From:'& header line. For example:
35961 .code
35962 accept authenticated = *
35963        control = submission/domain=wonderland.example/\
35964                             name=${lookup {$authenticated_id} \
35965                                    lsearch {/etc/exim/namelist}}
35966 .endd
35967 Because the name may contain any characters, including slashes, the &%name%&
35968 option must be given last. The remainder of the string is used as the name. For
35969 the example above, if &_/etc/exim/namelist_& contains:
35970 .code
35971 bigegg:  Humpty Dumpty
35972 .endd
35973 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35974 line would be:
35975 .code
35976 Sender: Humpty Dumpty <bigegg@wonderland.example>
35977 .endd
35978 .cindex "return path" "in submission mode"
35979 By default, submission mode forces the return path to the same address as is
35980 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35981 specified, the return path is also left unchanged.
35982
35983 &*Note*&: The changes caused by submission mode take effect after the predata
35984 ACL. This means that any sender checks performed before the fix-ups use the
35985 untrusted sender address specified by the user, not the trusted sender address
35986 specified by submission mode. Although this might be slightly unexpected, it
35987 does mean that you can configure ACL checks to spot that a user is trying to
35988 spoof another's address.
35989
35990 .section "Line endings" "SECTlineendings"
35991 .cindex "line endings"
35992 .cindex "carriage return"
35993 .cindex "linefeed"
35994 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35995 linefeed) is the line ending for messages transmitted over the Internet using
35996 SMTP over TCP/IP. However, within individual operating systems, different
35997 conventions are used. For example, Unix-like systems use just LF, but others
35998 use CRLF or just CR.
35999
36000 Exim was designed for Unix-like systems, and internally, it stores messages
36001 using the system's convention of a single LF as a line terminator. When
36002 receiving a message, all line endings are translated to this standard format.
36003 Originally, it was thought that programs that passed messages directly to an
36004 MTA within an operating system would use that system's convention. Experience
36005 has shown that this is not the case; for example, there are Unix applications
36006 that use CRLF in this circumstance. For this reason, and for compatibility with
36007 other MTAs, the way Exim handles line endings for all messages is now as
36008 follows:
36009
36010 .ilist
36011 LF not preceded by CR is treated as a line ending.
36012 .next
36013 CR is treated as a line ending; if it is immediately followed by LF, the LF
36014 is ignored.
36015 .next
36016 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
36017 nor a local message in the state where a line containing only a dot is a
36018 terminator.
36019 .next
36020 If a bare CR is encountered within a header line, an extra space is added after
36021 the line terminator so as not to end the header line. The reasoning behind this
36022 is that bare CRs in header lines are most likely either to be mistakes, or
36023 people trying to play silly games.
36024 .next
36025 If the first header line received in a message ends with CRLF, a subsequent
36026 bare LF in a header line is treated in the same way as a bare CR in a header
36027 line.
36028 .endlist
36029
36030
36031
36032
36033
36034 .section "Unqualified addresses" "SECID218"
36035 .cindex "unqualified addresses"
36036 .cindex "address" "qualification"
36037 By default, Exim expects every envelope address it receives from an external
36038 host to be fully qualified. Unqualified addresses cause negative responses to
36039 SMTP commands. However, because SMTP is used as a means of transporting
36040 messages from MUAs running on personal workstations, there is sometimes a
36041 requirement to accept unqualified addresses from specific hosts or IP networks.
36042
36043 Exim has two options that separately control which hosts may send unqualified
36044 sender or recipient addresses in SMTP commands, namely
36045 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
36046 cases, if an unqualified address is accepted, it is qualified by adding the
36047 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
36048
36049 .oindex "&%qualify_domain%&"
36050 .oindex "&%qualify_recipient%&"
36051 Unqualified addresses in header lines are automatically qualified for messages
36052 that are locally originated, unless the &%-bnq%& option is given on the command
36053 line. For messages received over SMTP, unqualified addresses in header lines
36054 are qualified only if unqualified addresses are permitted in SMTP commands. In
36055 other words, such qualification is also controlled by
36056 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
36057
36058
36059
36060
36061 .section "The UUCP From line" "SECID219"
36062 .cindex "&""From""& line"
36063 .cindex "UUCP" "&""From""& line"
36064 .cindex "sender" "address"
36065 .oindex "&%uucp_from_pattern%&"
36066 .oindex "&%uucp_from_sender%&"
36067 .cindex "envelope from"
36068 .cindex "envelope sender"
36069 .cindex "Sendmail compatibility" "&""From""& line"
36070 Messages that have come from UUCP (and some other applications) often begin
36071 with a line containing the envelope sender and a timestamp, following the word
36072 &"From"&. Examples of two common formats are:
36073 .code
36074 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
36075 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
36076 .endd
36077 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
36078 Exim recognizes such lines at the start of messages that are submitted to it
36079 via the command line (that is, on the standard input). It does not recognize
36080 such lines in incoming SMTP messages, unless the sending host matches
36081 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
36082 and &%ignore_fromline_local%& is set. The recognition is controlled by a
36083 regular expression that is defined by the &%uucp_from_pattern%& option, whose
36084 default value matches the two common cases shown above and puts the address
36085 that follows &"From"& into &$1$&.
36086
36087 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
36088 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
36089 a trusted user, the message's sender address is constructed by expanding the
36090 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
36091 then parsed as an RFC 2822 address. If there is no domain, the local part is
36092 qualified with &%qualify_domain%& unless it is the empty string. However, if
36093 the command line &%-f%& option is used, it overrides the &"From"& line.
36094
36095 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
36096 sender address is not changed. This is also the case for incoming SMTP messages
36097 that are permitted to contain &"From"& lines.
36098
36099 Only one &"From"& line is recognized. If there is more than one, the second is
36100 treated as a data line that starts the body of the message, as it is not valid
36101 as a header line. This also happens if a &"From"& line is present in an
36102 incoming SMTP message from a source that is not permitted to send them.
36103
36104
36105
36106 .section "Resent- header lines" "SECID220"
36107 .chindex Resent-
36108 RFC 2822 makes provision for sets of header lines starting with the string
36109 &`Resent-`& to be added to a message when it is resent by the original
36110 recipient to somebody else. These headers are &'Resent-Date:'&,
36111 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
36112 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
36113
36114 .blockquote
36115 &'Resent fields are strictly informational. They MUST NOT be used in the normal
36116 processing of replies or other such automatic actions on messages.'&
36117 .endblockquote
36118
36119 This leaves things a bit vague as far as other processing actions such as
36120 address rewriting are concerned. Exim treats &%Resent-%& header lines as
36121 follows:
36122
36123 .ilist
36124 A &'Resent-From:'& line that just contains the login id of the submitting user
36125 is automatically rewritten in the same way as &'From:'& (see below).
36126 .next
36127 If there's a rewriting rule for a particular header line, it is also applied to
36128 &%Resent-%& header lines of the same type. For example, a rule that rewrites
36129 &'From:'& also rewrites &'Resent-From:'&.
36130 .next
36131 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
36132 also removed.
36133 .next
36134 For a locally-submitted message,
36135 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
36136 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
36137 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
36138 included in log lines in this case.
36139 .next
36140 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
36141 &%Resent-%& header lines are present.
36142 .endlist
36143
36144
36145
36146
36147 .section "The Auto-Submitted: header line" "SECID221"
36148 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
36149 includes the header line:
36150 .code
36151 Auto-Submitted: auto-replied
36152 .endd
36153
36154 .section "The Bcc: header line" "SECID222"
36155 .cindex "&'Bcc:'& header line"
36156 If Exim is called with the &%-t%& option, to take recipient addresses from a
36157 message's header, it removes any &'Bcc:'& header line that may exist (after
36158 extracting its addresses). If &%-t%& is not present on the command line, any
36159 existing &'Bcc:'& is not removed.
36160
36161
36162 .section "The Date: header line" "SECID223"
36163 .cindex Date:
36164 If a locally-generated or submission-mode message has no &'Date:'& header line,
36165 Exim adds one, using the current date and time, unless the
36166 &%suppress_local_fixups%& control has been specified.
36167
36168 .section "The Delivery-date: header line" "SECID224"
36169 .cindex "&'Delivery-date:'& header line"
36170 .oindex "&%delivery_date_remove%&"
36171 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
36172 set. Exim can be configured to add them to the final delivery of messages. (See
36173 the generic &%delivery_date_add%& transport option.) They should not be present
36174 in messages in transit. If the &%delivery_date_remove%& configuration option is
36175 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
36176 messages.
36177
36178
36179 .section "The Envelope-to: header line" "SECID225"
36180 .chindex Envelope-to:
36181 .oindex "&%envelope_to_remove%&"
36182 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
36183 Exim can be configured to add them to the final delivery of messages. (See the
36184 generic &%envelope_to_add%& transport option.) They should not be present in
36185 messages in transit. If the &%envelope_to_remove%& configuration option is set
36186 (the default), Exim removes &'Envelope-to:'& header lines from incoming
36187 messages.
36188
36189
36190 .section "The From: header line" "SECTthefrohea"
36191 .chindex From:
36192 .cindex "Sendmail compatibility" "&""From""& line"
36193 .cindex "message" "submission"
36194 .cindex "submission mode"
36195 If a submission-mode message does not contain a &'From:'& header line, Exim
36196 adds one if either of the following conditions is true:
36197
36198 .ilist
36199 The envelope sender address is not empty (that is, this is not a bounce
36200 message). The added header line copies the envelope sender address.
36201 .next
36202 .vindex "&$authenticated_id$&"
36203 The SMTP session is authenticated and &$authenticated_id$& is not empty.
36204 .olist
36205 .vindex "&$qualify_domain$&"
36206 If no domain is specified by the submission control, the local part is
36207 &$authenticated_id$& and the domain is &$qualify_domain$&.
36208 .next
36209 If a non-empty domain is specified by the submission control, the local
36210 part is &$authenticated_id$&, and the domain is the specified domain.
36211 .next
36212 If an empty domain is specified by the submission control,
36213 &$authenticated_id$& is assumed to be the complete address.
36214 .endlist
36215 .endlist
36216
36217 A non-empty envelope sender takes precedence.
36218
36219 If a locally-generated incoming message does not contain a &'From:'& header
36220 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
36221 containing the sender's address. The calling user's login name and full name
36222 are used to construct the address, as described in section &<<SECTconstr>>&.
36223 They are obtained from the password data by calling &[getpwuid()]& (but see the
36224 &%unknown_login%& configuration option). The address is qualified with
36225 &%qualify_domain%&.
36226
36227 For compatibility with Sendmail, if an incoming, non-SMTP message has a
36228 &'From:'& header line containing just the unqualified login name of the calling
36229 user, this is replaced by an address containing the user's login name and full
36230 name as described in section &<<SECTconstr>>&.
36231
36232
36233 .section "The Message-ID: header line" "SECID226"
36234 .chindex Message-ID:
36235 .cindex "message" "submission"
36236 .oindex "&%message_id_header_text%&"
36237 If a locally-generated or submission-mode incoming message does not contain a
36238 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
36239 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
36240 to the message. If there are any &'Resent-:'& headers in the message, it
36241 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
36242 message id, preceded by the letter E to ensure it starts with a letter, and
36243 followed by @ and the primary host name. Additional information can be included
36244 in this header line by setting the &%message_id_header_text%& and/or
36245 &%message_id_header_domain%& options.
36246
36247
36248 .section "The Received: header line" "SECID227"
36249 .chindex Received:
36250 A &'Received:'& header line is added at the start of every message. The
36251 contents are defined by the &%received_header_text%& configuration option, and
36252 Exim automatically adds a semicolon and a timestamp to the configured string.
36253
36254 The &'Received:'& header is generated as soon as the message's header lines
36255 have been received. At this stage, the timestamp in the &'Received:'& header
36256 line is the time that the message started to be received. This is the value
36257 that is seen by the DATA ACL and by the &[local_scan()]& function.
36258
36259 Once a message is accepted, the timestamp in the &'Received:'& header line is
36260 changed to the time of acceptance, which is (apart from a small delay while the
36261 -H spool file is written) the earliest time at which delivery could start.
36262
36263
36264 .section "The References: header line" "SECID228"
36265 .chindex References:
36266 Messages created by the &(autoreply)& transport include a &'References:'&
36267 header line. This is constructed according to the rules that are described in
36268 section 3.64 of RFC 2822 (which states that replies should contain such a
36269 header line), and section 3.14 of RFC 3834 (which states that automatic
36270 responses are not different in this respect). However, because some mail
36271 processing software does not cope well with very long header lines, no more
36272 than 12 message IDs are copied from the &'References:'& header line in the
36273 incoming message. If there are more than 12, the first one and then the final
36274 11 are copied, before adding the message ID of the incoming message.
36275
36276
36277
36278 .section "The Return-path: header line" "SECID229"
36279 .chindex Return-path:
36280 .oindex "&%return_path_remove%&"
36281 &'Return-path:'& header lines are defined as something an MTA may insert when
36282 it does the final delivery of messages. (See the generic &%return_path_add%&
36283 transport option.) Therefore, they should not be present in messages in
36284 transit. If the &%return_path_remove%& configuration option is set (the
36285 default), Exim removes &'Return-path:'& header lines from incoming messages.
36286
36287
36288
36289 .section "The Sender: header line" "SECTthesenhea"
36290 .cindex "&'Sender:'& header line"
36291 .cindex "message" "submission"
36292 .chindex Sender:
36293 For a locally-originated message from an untrusted user, Exim may remove an
36294 existing &'Sender:'& header line, and it may add a new one. You can modify
36295 these actions by setting the &%local_sender_retain%& option true, the
36296 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
36297 control setting.
36298
36299 When a local message is received from an untrusted user and
36300 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
36301 control has not been set, a check is made to see if the address given in the
36302 &'From:'& header line is the correct (local) sender of the message. The address
36303 that is expected has the login name as the local part and the value of
36304 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
36305 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
36306 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
36307 line is added to the message.
36308
36309 If you set &%local_from_check%& false, this checking does not occur. However,
36310 the removal of an existing &'Sender:'& line still happens, unless you also set
36311 &%local_sender_retain%& to be true. It is not possible to set both of these
36312 options true at the same time.
36313
36314 .cindex "submission mode"
36315 By default, no processing of &'Sender:'& header lines is done for messages
36316 received over TCP/IP or for messages submitted by trusted users. However, when
36317 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
36318 not specified on the submission control, the following processing takes place:
36319
36320 .vindex "&$authenticated_id$&"
36321 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
36322 authenticated, and &$authenticated_id$& is not empty, a sender address is
36323 created as follows:
36324
36325 .ilist
36326 .vindex "&$qualify_domain$&"
36327 If no domain is specified by the submission control, the local part is
36328 &$authenticated_id$& and the domain is &$qualify_domain$&.
36329 .next
36330 If a non-empty domain is specified by the submission control, the local part
36331 is &$authenticated_id$&, and the domain is the specified domain.
36332 .next
36333 If an empty domain is specified by the submission control,
36334 &$authenticated_id$& is assumed to be the complete address.
36335 .endlist
36336
36337 This address is compared with the address in the &'From:'& header line. If they
36338 are different, a &'Sender:'& header line containing the created address is
36339 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
36340 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
36341
36342 .cindex "return path" "created from &'Sender:'&"
36343 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
36344 the message (the envelope sender address) is changed to be the same address,
36345 except in the case of submission mode when &%sender_retain%& is specified.
36346
36347
36348
36349 .section "Adding and removing header lines in routers and transports" &&&
36350          "SECTheadersaddrem"
36351 .cindex "header lines" "adding; in router or transport"
36352 .cindex "header lines" "removing; in router or transport"
36353 When a message is delivered, the addition and removal of header lines can be
36354 specified in a system filter, or on any of the routers and transports that
36355 process the message. Section &<<SECTaddremheasys>>& contains details about
36356 modifying headers in a system filter. Header lines can also be added in an ACL
36357 as a message is received (see section &<<SECTaddheadacl>>&).
36358
36359 In contrast to what happens in a system filter, header modifications that are
36360 specified on routers and transports apply only to the particular recipient
36361 addresses that are being processed by those routers and transports. These
36362 changes do not actually take place until a copy of the message is being
36363 transported. Therefore, they do not affect the basic set of header lines, and
36364 they do not affect the values of the variables that refer to header lines.
36365
36366 &*Note*&: In particular, this means that any expansions in the configuration of
36367 the transport cannot refer to the modified header lines, because such
36368 expansions all occur before the message is actually transported.
36369
36370 For both routers and transports, the argument of a &%headers_add%&
36371 option must be in the form of one or more RFC 2822 header lines, separated by
36372 newlines (coded as &"\n"&). For example:
36373 .code
36374 headers_add = X-added-header: added by $primary_hostname\n\
36375               X-added-second: another added header line
36376 .endd
36377 Exim does not check the syntax of these added header lines.
36378
36379 Multiple &%headers_add%& options for a single router or transport can be
36380 specified; the values will append to a single list of header lines.
36381 Each header-line is separately expanded.
36382
36383 The argument of a &%headers_remove%& option must consist of a colon-separated
36384 list of header names. This is confusing, because header names themselves are
36385 often terminated by colons. In this case, the colons are the list separators,
36386 not part of the names. For example:
36387 .code
36388 headers_remove = return-receipt-to:acknowledge-to
36389 .endd
36390
36391 Multiple &%headers_remove%& options for a single router or transport can be
36392 specified; the arguments will append to a single header-names list.
36393 Each item is separately expanded.
36394 Note that colons in complex expansions which are used to
36395 form all or part of a &%headers_remove%& list
36396 will act as list separators.
36397
36398 When &%headers_add%& or &%headers_remove%& is specified on a router,
36399 items are expanded at routing time,
36400 and then associated with all addresses that are
36401 accepted by that router, and also with any new addresses that it generates. If
36402 an address passes through several routers as a result of aliasing or
36403 forwarding, the changes are cumulative.
36404
36405 .oindex "&%unseen%&"
36406 However, this does not apply to multiple routers that result from the use of
36407 the &%unseen%& option. Any header modifications that were specified by the
36408 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36409
36410 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36411 settings cannot be delivered together in a batch, so a transport is always
36412 dealing with a set of addresses that have the same header-processing
36413 requirements.
36414
36415 The transport starts by writing the original set of header lines that arrived
36416 with the message, possibly modified by the system filter. As it writes out
36417 these lines, it consults the list of header names that were attached to the
36418 recipient address(es) by &%headers_remove%& options in routers, and it also
36419 consults the transport's own &%headers_remove%& option. Header lines whose
36420 names are on either of these lists are not written out. If there are multiple
36421 instances of any listed header, they are all skipped.
36422
36423 After the remaining original header lines have been written, new header
36424 lines that were specified by routers' &%headers_add%& options are written, in
36425 the order in which they were attached to the address. These are followed by any
36426 header lines specified by the transport's &%headers_add%& option.
36427
36428 This way of handling header line modifications in routers and transports has
36429 the following consequences:
36430
36431 .ilist
36432 The original set of header lines, possibly modified by the system filter,
36433 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36434 to it, at all times.
36435 .next
36436 Header lines that are added by a router's
36437 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36438 expansion syntax in subsequent routers or the transport.
36439 .next
36440 Conversely, header lines that are specified for removal by &%headers_remove%&
36441 in a router remain visible to subsequent routers and the transport.
36442 .next
36443 Headers added to an address by &%headers_add%& in a router cannot be removed by
36444 a later router or by a transport.
36445 .next
36446 An added header can refer to the contents of an original header that is to be
36447 removed, even it has the same name as the added header. For example:
36448 .code
36449 headers_remove = subject
36450 headers_add = Subject: new subject (was: $h_subject:)
36451 .endd
36452 .endlist
36453
36454 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36455 for a &(redirect)& router that has the &%one_time%& option set.
36456
36457
36458
36459
36460
36461 .section "Constructed addresses" "SECTconstr"
36462 .cindex "address" "constructed"
36463 .cindex "constructed address"
36464 When Exim constructs a sender address for a locally-generated message, it uses
36465 the form
36466 .display
36467 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36468 .endd
36469 For example:
36470 .code
36471 Zaphod Beeblebrox <zaphod@end.univ.example>
36472 .endd
36473 The user name is obtained from the &%-F%& command line option if set, or
36474 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36475 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36476 ampersand character, this is replaced by the login name with the first letter
36477 upper cased, as is conventional in a number of operating systems. See the
36478 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36479 The &%unknown_username%& option can be used to specify user names in cases when
36480 there is no password file entry.
36481
36482 .cindex "RFC 2047"
36483 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36484 parts of it if necessary. In addition, if it contains any non-printing
36485 characters, it is encoded as described in RFC 2047, which defines a way of
36486 including non-ASCII characters in header lines. The value of the
36487 &%headers_charset%& option specifies the name of the encoding that is used (the
36488 characters are assumed to be in this encoding). The setting of
36489 &%print_topbitchars%& controls whether characters with the top bit set (that
36490 is, with codes greater than 127) count as printing characters or not.
36491
36492
36493
36494 .section "Case of local parts" "SECID230"
36495 .cindex "case of local parts"
36496 .cindex "local part" "case of"
36497 RFC 2822 states that the case of letters in the local parts of addresses cannot
36498 be assumed to be non-significant. Exim preserves the case of local parts of
36499 addresses, but by default it uses a lower-cased form when it is routing,
36500 because on most Unix systems, usernames are in lower case and case-insensitive
36501 routing is required. However, any particular router can be made to use the
36502 original case for local parts by setting the &%caseful_local_part%& generic
36503 router option.
36504
36505 .cindex "mixed-case login names"
36506 If you must have mixed-case user names on your system, the best way to proceed,
36507 assuming you want case-independent handling of incoming email, is to set up
36508 your first router to convert incoming local parts in your domains to the
36509 correct case by means of a file lookup. For example:
36510 .code
36511 correct_case:
36512   driver = redirect
36513   domains = +local_domains
36514   data = ${lookup{$local_part}cdb\
36515               {/etc/usercased.cdb}{$value}fail}\
36516               @$domain
36517 .endd
36518 For this router, the local part is forced to lower case by the default action
36519 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36520 up a new local part in the correct case. If you then set &%caseful_local_part%&
36521 on any subsequent routers which process your domains, they will operate on
36522 local parts with the correct case in a case-sensitive manner.
36523
36524
36525
36526 .section "Dots in local parts" "SECID231"
36527 .cindex "dot" "in local part"
36528 .cindex "local part" "dots in"
36529 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36530 part may not begin or end with a dot, nor have two consecutive dots in the
36531 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36532 empty components for compatibility.
36533
36534
36535
36536 .section "Rewriting addresses" "SECID232"
36537 .cindex "rewriting" "addresses"
36538 Rewriting of sender and recipient addresses, and addresses in headers, can
36539 happen automatically, or as the result of configuration options, as described
36540 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36541 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36542
36543 Automatic rewriting includes qualification, as mentioned above. The other case
36544 in which it can happen is when an incomplete non-local domain is given. The
36545 routing process may cause this to be expanded into the full domain name. For
36546 example, a header such as
36547 .code
36548 To: hare@teaparty
36549 .endd
36550 might get rewritten as
36551 .code
36552 To: hare@teaparty.wonderland.fict.example
36553 .endd
36554 Rewriting as a result of routing is the one kind of message processing that
36555 does not happen at input time, as it cannot be done until the address has
36556 been routed.
36557
36558 Strictly, one should not do &'any'& deliveries of a message until all its
36559 addresses have been routed, in case any of the headers get changed as a
36560 result of routing. However, doing this in practice would hold up many
36561 deliveries for unreasonable amounts of time, just because one address could not
36562 immediately be routed. Exim therefore does not delay other deliveries when
36563 routing of one or more addresses is deferred.
36564 .ecindex IIDmesproc
36565
36566
36567
36568 . ////////////////////////////////////////////////////////////////////////////
36569 . ////////////////////////////////////////////////////////////////////////////
36570
36571 .chapter "SMTP processing" "CHAPSMTP"
36572 .scindex IIDsmtpproc1 "SMTP" "processing details"
36573 .scindex IIDsmtpproc2 "LMTP" "processing details"
36574 Exim supports a number of different ways of using the SMTP protocol, and its
36575 LMTP variant, which is an interactive protocol for transferring messages into a
36576 closed mail store application. This chapter contains details of how SMTP is
36577 processed. For incoming mail, the following are available:
36578
36579 .ilist
36580 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36581 .next
36582 SMTP over the standard input and output (the &%-bs%& option);
36583 .next
36584 Batched SMTP on the standard input (the &%-bS%& option).
36585 .endlist
36586
36587 For mail delivery, the following are available:
36588
36589 .ilist
36590 SMTP over TCP/IP (the &(smtp)& transport);
36591 .next
36592 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36593 &"lmtp"&);
36594 .next
36595 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36596 transport);
36597 .next
36598 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36599 the &%use_bsmtp%& option set).
36600 .endlist
36601
36602 &'Batched SMTP'& is the name for a process in which batches of messages are
36603 stored in or read from files (or pipes), in a format in which SMTP commands are
36604 used to contain the envelope information.
36605
36606
36607
36608 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36609 .cindex "SMTP" "outgoing over TCP/IP"
36610 .cindex "outgoing SMTP over TCP/IP"
36611 .cindex "LMTP" "over TCP/IP"
36612 .cindex "outgoing LMTP over TCP/IP"
36613 .cindex "EHLO"
36614 .cindex "HELO"
36615 .cindex "SIZE" "option on MAIL command"
36616 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36617 The &%protocol%& option selects which protocol is to be used, but the actual
36618 processing is the same in both cases.
36619
36620 .cindex "ESMTP extensions" SIZE
36621 If, in response to its EHLO command, Exim is told that the SIZE
36622 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36623 command. The value of <&'n'&> is the message size plus the value of the
36624 &%size_addition%& option (default 1024) to allow for additions to the message
36625 such as per-transport header lines, or changes made in a
36626 .cindex "transport" "filter"
36627 .cindex "filter" "transport filter"
36628 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36629 suppressed.
36630
36631 If the remote server advertises support for PIPELINING, Exim uses the
36632 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36633 required for the transaction.
36634
36635 If the remote server advertises support for the STARTTLS command, and Exim
36636 was built to support TLS encryption, it tries to start a TLS session unless the
36637 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36638 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36639 is called for verification.
36640
36641 If the remote server advertises support for the AUTH command, Exim scans
36642 the authenticators configuration for any suitable client settings, as described
36643 in chapter &<<CHAPSMTPAUTH>>&.
36644
36645 .cindex "carriage return"
36646 .cindex "linefeed"
36647 Responses from the remote host are supposed to be terminated by CR followed by
36648 LF. However, there are known to be hosts that do not send CR characters, so in
36649 order to be able to interwork with such hosts, Exim treats LF on its own as a
36650 line terminator.
36651
36652 If a message contains a number of different addresses, all those with the same
36653 characteristics (for example, the same envelope sender) that resolve to the
36654 same set of hosts, in the same order, are sent in a single SMTP transaction,
36655 even if they are for different domains, unless there are more than the setting
36656 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36657 they are split into groups containing no more than &%max_rcpt%&s addresses
36658 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36659 in parallel sessions. The order of hosts with identical MX values is not
36660 significant when checking whether addresses can be batched in this way.
36661
36662 When the &(smtp)& transport suffers a temporary failure that is not
36663 message-related, Exim updates its transport-specific database, which contains
36664 records indexed by host name that remember which messages are waiting for each
36665 particular host. It also updates the retry database with new retry times.
36666
36667 .cindex "hints database" "retry keys"
36668 Exim's retry hints are based on host name plus IP address, so if one address of
36669 a multi-homed host is broken, it will soon be skipped most of the time.
36670 See the next section for more detail about error handling.
36671
36672 .cindex "SMTP" "passed connection"
36673 .cindex "SMTP" "batching over TCP/IP"
36674 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36675 looks in the hints database for the transport to see if there are any queued
36676 messages waiting for the host to which it is connected. If it finds one, it
36677 creates a new Exim process using the &%-MC%& option (which can only be used by
36678 a process running as root or the Exim user) and passes the TCP/IP socket to it
36679 so that it can deliver another message using the same socket. The new process
36680 does only those deliveries that are routed to the connected host, and may in
36681 turn pass the socket on to a third process, and so on.
36682
36683 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36684 limit the number of messages sent down a single TCP/IP connection.
36685
36686 .cindex "asterisk" "after IP address"
36687 The second and subsequent messages delivered down an existing connection are
36688 identified in the main log by the addition of an asterisk after the closing
36689 square bracket of the IP address.
36690
36691
36692
36693
36694 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36695 .cindex "error" "in outgoing SMTP"
36696 .cindex "SMTP" "errors in outgoing"
36697 .cindex "host" "error"
36698 Three different kinds of error are recognized for outgoing SMTP: host errors,
36699 message errors, and recipient errors.
36700
36701 .vlist
36702 .vitem "&*Host errors*&"
36703 A host error is not associated with a particular message or with a
36704 particular recipient of a message. The host errors are:
36705
36706 .ilist
36707 Connection refused or timed out,
36708 .next
36709 Any error response code on connection,
36710 .next
36711 Any error response code to EHLO or HELO,
36712 .next
36713 Loss of connection at any time, except after &"."&,
36714 .next
36715 I/O errors at any time,
36716 .next
36717 Timeouts during the session, other than in response to MAIL, RCPT or
36718 the &"."& at the end of the data.
36719 .endlist ilist
36720
36721 For a host error, a permanent error response on connection, or in response to
36722 EHLO, causes all addresses routed to the host to be failed. Any other host
36723 error causes all addresses to be deferred, and retry data to be created for the
36724 host. It is not tried again, for any message, until its retry time arrives. If
36725 the current set of addresses are not all delivered in this run (to some
36726 alternative host), the message is added to the list of those waiting for this
36727 host, so if it is still undelivered when a subsequent successful delivery is
36728 made to the host, it will be sent down the same SMTP connection.
36729
36730 .vitem "&*Message errors*&"
36731 .cindex "message" "error"
36732 A message error is associated with a particular message when sent to a
36733 particular host, but not with a particular recipient of the message. The
36734 message errors are:
36735
36736 .ilist
36737 Any error response code to MAIL, DATA, or the &"."& that terminates
36738 the data,
36739 .next
36740 Timeout after MAIL,
36741 .next
36742 Timeout or loss of connection after the &"."& that terminates the data. A
36743 timeout after the DATA command itself is treated as a host error, as is loss of
36744 connection at any other time.
36745 .endlist ilist
36746
36747 For a message error, a permanent error response (5&'xx'&) causes all addresses
36748 to be failed, and a delivery error report to be returned to the sender. A
36749 temporary error response (4&'xx'&), or one of the timeouts, causes all
36750 addresses to be deferred. Retry data is not created for the host, but instead,
36751 a retry record for the combination of host plus message id is created. The
36752 message is not added to the list of those waiting for this host. This ensures
36753 that the failing message will not be sent to this host again until the retry
36754 time arrives. However, other messages that are routed to the host are not
36755 affected, so if it is some property of the message that is causing the error,
36756 it will not stop the delivery of other mail.
36757
36758 If the remote host specified support for the SIZE parameter in its response
36759 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36760 over-large message will cause a message error because the error arrives as a
36761 response to MAIL.
36762
36763 .vitem "&*Recipient errors*&"
36764 .cindex "recipient" "error"
36765 A recipient error is associated with a particular recipient of a message. The
36766 recipient errors are:
36767
36768 .ilist
36769 Any error response to RCPT,
36770 .next
36771 Timeout after RCPT.
36772 .endlist
36773
36774 For a recipient error, a permanent error response (5&'xx'&) causes the
36775 recipient address to be failed, and a bounce message to be returned to the
36776 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36777 address to be deferred, and routing retry data to be created for it. This is
36778 used to delay processing of the address in subsequent queue runs, until its
36779 routing retry time arrives. This applies to all messages, but because it
36780 operates only in queue runs, one attempt will be made to deliver a new message
36781 to the failing address before the delay starts to operate. This ensures that,
36782 if the failure is really related to the message rather than the recipient
36783 (&"message too big for this recipient"& is a possible example), other messages
36784 have a chance of getting delivered. If a delivery to the address does succeed,
36785 the retry information gets cleared, so all stuck messages get tried again, and
36786 the retry clock is reset.
36787
36788 The message is not added to the list of those waiting for this host. Use of the
36789 host for other messages is unaffected, and except in the case of a timeout,
36790 other recipients are processed independently, and may be successfully delivered
36791 in the current SMTP session. After a timeout it is of course impossible to
36792 proceed with the session, so all addresses get deferred. However, those other
36793 than the one that failed do not suffer any subsequent retry delays. Therefore,
36794 if one recipient is causing trouble, the others have a chance of getting
36795 through when a subsequent delivery attempt occurs before the failing
36796 recipient's retry time.
36797 .endlist
36798
36799 In all cases, if there are other hosts (or IP addresses) available for the
36800 current set of addresses (for example, from multiple MX records), they are
36801 tried in this run for any undelivered addresses, subject of course to their
36802 own retry data. In other words, recipient error retry data does not take effect
36803 until the next delivery attempt.
36804
36805 Some hosts have been observed to give temporary error responses to every
36806 MAIL command at certain times (&"insufficient space"& has been seen). It
36807 would be nice if such circumstances could be recognized, and defer data for the
36808 host itself created, but this is not possible within the current Exim design.
36809 What actually happens is that retry data for every (host, message) combination
36810 is created.
36811
36812 The reason that timeouts after MAIL and RCPT are treated specially is that
36813 these can sometimes arise as a result of the remote host's verification
36814 procedures. Exim makes this assumption, and treats them as if a temporary error
36815 response had been received. A timeout after &"."& is treated specially because
36816 it is known that some broken implementations fail to recognize the end of the
36817 message if the last character of the last line is a binary zero. Thus, it is
36818 helpful to treat this case as a message error.
36819
36820 Timeouts at other times are treated as host errors, assuming a problem with the
36821 host, or the connection to it. If a timeout after MAIL, RCPT,
36822 or &"."& is really a connection problem, the assumption is that at the next try
36823 the timeout is likely to occur at some other point in the dialogue, causing it
36824 then to be treated as a host error.
36825
36826 There is experimental evidence that some MTAs drop the connection after the
36827 terminating &"."& if they do not like the contents of the message for some
36828 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36829 should be given. That is why Exim treats this case as a message rather than a
36830 host error, in order not to delay other messages to the same host.
36831
36832
36833
36834
36835 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36836 .cindex "SMTP" "incoming over TCP/IP"
36837 .cindex "incoming SMTP over TCP/IP"
36838 .cindex "inetd"
36839 .cindex "daemon"
36840 Incoming SMTP messages can be accepted in one of two ways: by running a
36841 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36842 &_/etc/inetd.conf_& should be like this:
36843 .code
36844 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36845 .endd
36846 Exim distinguishes between this case and the case of a locally running user
36847 agent using the &%-bs%& option by checking whether or not the standard input is
36848 a socket. When it is, either the port must be privileged (less than 1024), or
36849 the caller must be root or the Exim user. If any other user passes a socket
36850 with an unprivileged port number, Exim prints a message on the standard error
36851 stream and exits with an error code.
36852
36853 By default, Exim does not make a log entry when a remote host connects or
36854 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36855 unexpected. It can be made to write such log entries by setting the
36856 &%smtp_connection%& log selector.
36857
36858 .cindex "carriage return"
36859 .cindex "linefeed"
36860 Commands from the remote host are supposed to be terminated by CR followed by
36861 LF. However, there are known to be hosts that do not send CR characters. In
36862 order to be able to interwork with such hosts, Exim treats LF on its own as a
36863 line terminator.
36864 Furthermore, because common code is used for receiving messages from all
36865 sources, a CR on its own is also interpreted as a line terminator. However, the
36866 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36867
36868 .cindex "EHLO" "invalid data"
36869 .cindex "HELO" "invalid data"
36870 One area that sometimes gives rise to problems concerns the EHLO or
36871 HELO commands. Some clients send syntactically invalid versions of these
36872 commands, which Exim rejects by default. (This is nothing to do with verifying
36873 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36874 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36875 match the broken hosts that send invalid commands.
36876
36877 .cindex "SIZE option on MAIL command"
36878 .cindex "MAIL" "SIZE option"
36879 The amount of disk space available is checked whenever SIZE is received on
36880 a MAIL command, independently of whether &%message_size_limit%& or
36881 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36882 false. A temporary error is given if there is not enough space. If
36883 &%check_spool_space%& is set, the check is for that amount of space plus the
36884 value given with SIZE, that is, it checks that the addition of the incoming
36885 message will not reduce the space below the threshold.
36886
36887 When a message is successfully received, Exim includes the local message id in
36888 its response to the final &"."& that terminates the data. If the remote host
36889 logs this text it can help with tracing what has happened to a message.
36890
36891 The Exim daemon can limit the number of simultaneous incoming connections it is
36892 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36893 number of simultaneous incoming connections from a single remote host (see the
36894 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36895 rejected using the SMTP temporary error code 421.
36896
36897 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36898 subprocess has finished, as this can get lost at busy times. Instead, it looks
36899 for completed subprocesses every time it wakes up. Provided there are other
36900 things happening (new incoming calls, starts of queue runs), completed
36901 processes will be noticed and tidied away. On very quiet systems you may
36902 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36903 it will be noticed when the daemon next wakes up.
36904
36905 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36906 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36907 high system load &-- for details see the &%smtp_accept_reserve%&,
36908 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36909 applies in both the daemon and &'inetd'& cases.
36910
36911 Exim normally starts a delivery process for each message received, though this
36912 can be varied by means of the &%-odq%& command line option and the
36913 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36914 number of simultaneously running delivery processes started in this way from
36915 SMTP input can be limited by the &%smtp_accept_queue%& and
36916 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36917 subsequently received messages are just put on the input queue without starting
36918 a delivery process.
36919
36920 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36921 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36922 started up from the &'inetd'& daemon, because in that case each connection is
36923 handled by an entirely independent Exim process. Control by load average is,
36924 however, available with &'inetd'&.
36925
36926 Exim can be configured to verify addresses in incoming SMTP commands as they
36927 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36928 to rewrite addresses at this time &-- before any syntax checking is done. See
36929 section &<<SECTrewriteS>>&.
36930
36931 Exim can also be configured to limit the rate at which a client host submits
36932 MAIL and RCPT commands in a single SMTP session. See the
36933 &%smtp_ratelimit_hosts%& option.
36934
36935
36936
36937 .section "Unrecognized SMTP commands" "SECID234"
36938 .cindex "SMTP" "unrecognized commands"
36939 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36940 commands during a single SMTP connection, it drops the connection after sending
36941 the error response to the last command. The default value for
36942 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36943 abuse that subvert web servers into making connections to SMTP ports; in these
36944 circumstances, a number of non-SMTP lines are sent first.
36945
36946
36947 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36948 .cindex "SMTP" "syntax errors"
36949 .cindex "SMTP" "protocol errors"
36950 A syntax error is detected if an SMTP command is recognized, but there is
36951 something syntactically wrong with its data, for example, a malformed email
36952 address in a RCPT command. Protocol errors include invalid command
36953 sequencing such as RCPT before MAIL. If Exim receives more than
36954 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36955 drops the connection after sending the error response to the last command. The
36956 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36957 broken clients that loop sending bad commands (yes, it has been seen).
36958
36959
36960
36961 .section "Use of non-mail SMTP commands" "SECID236"
36962 .cindex "SMTP" "non-mail commands"
36963 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36964 DATA. Exim counts such commands, and drops the connection if there are too
36965 many of them in a single SMTP session. This action catches some
36966 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36967 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36968 defines what &"too many"& means. Its default value is 10.
36969
36970 When a new message is expected, one occurrence of RSET is not counted. This
36971 allows a client to send one RSET between messages (this is not necessary,
36972 but some clients do it). Exim also allows one uncounted occurrence of HELO
36973 or EHLO, and one occurrence of STARTTLS between messages. After
36974 starting up a TLS session, another EHLO is expected, and so it too is not
36975 counted.
36976
36977 The first occurrence of AUTH in a connection, or immediately following
36978 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36979 RCPT, DATA, and QUIT are counted.
36980
36981 You can control which hosts are subject to the limit set by
36982 &%smtp_accept_max_nonmail%& by setting
36983 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36984 the limit apply to all hosts. This option means that you can exclude any
36985 specific badly-behaved hosts that you have to live with.
36986
36987
36988
36989
36990 .section "The VRFY and EXPN commands" "SECID237"
36991 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36992 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36993 appropriate) in order to decide whether the command should be accepted or not.
36994
36995 .cindex "VRFY" "processing"
36996 When no ACL is defined for VRFY, or if it rejects without
36997 setting an explicit response code, the command is accepted
36998 (with a 252 SMTP response code)
36999 in order to support awkward clients that do a VRFY before every RCPT.
37000 When VRFY is accepted, it runs exactly the same code as when Exim is
37001 called with the &%-bv%& option, and returns 250/451/550
37002 SMTP response codes.
37003
37004 .cindex "EXPN" "processing"
37005 If no ACL for EXPN is defined, the command is rejected.
37006 When EXPN is accepted, a single-level expansion of the address is done.
37007 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
37008 than a verification (the &%-bv%& option). If an unqualified local part is given
37009 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
37010 of VRFY and EXPN commands are logged on the main and reject logs, and
37011 VRFY verification failures are logged on the main log for consistency with
37012 RCPT failures.
37013
37014
37015
37016 .section "The ETRN command" "SECTETRN"
37017 .cindex "ETRN" "processing"
37018 .cindex "ESMTP extensions" ETRN
37019 RFC 1985 describes an ESMTP command called ETRN that is designed to
37020 overcome the security problems of the TURN command (which has fallen into
37021 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
37022 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
37023 should be accepted or not. If no ACL is defined, the command is rejected.
37024
37025 The ETRN command is concerned with &"releasing"& messages that are awaiting
37026 delivery to certain hosts. As Exim does not organize its message queue by host,
37027 the only form of ETRN that is supported by default is the one where the
37028 text starts with the &"#"& prefix, in which case the remainder of the text is
37029 specific to the SMTP server. A valid ETRN command causes a run of Exim with
37030 the &%-R%& option to happen, with the remainder of the ETRN text as its
37031 argument. For example,
37032 .code
37033 ETRN #brigadoon
37034 .endd
37035 runs the command
37036 .code
37037 exim -R brigadoon
37038 .endd
37039 which causes a delivery attempt on all messages with undelivered addresses
37040 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
37041 default), Exim prevents the simultaneous execution of more than one queue run
37042 for the same argument string as a result of an ETRN command. This stops
37043 a misbehaving client from starting more than one queue runner at once.
37044
37045 .cindex "hints database" "ETRN serialization"
37046 Exim implements the serialization by means of a hints database in which a
37047 record is written whenever a process is started by ETRN, and deleted when
37048 the process completes. However, Exim does not keep the SMTP session waiting for
37049 the ETRN process to complete. Once ETRN is accepted, the client is sent
37050 a &"success"& return code. Obviously there is scope for hints records to get
37051 left lying around if there is a system or program crash. To guard against this,
37052 Exim ignores any records that are more than six hours old.
37053
37054 .oindex "&%smtp_etrn_command%&"
37055 For more control over what ETRN does, the &%smtp_etrn_command%& option can
37056 used. This specifies a command that is run whenever ETRN is received,
37057 whatever the form of its argument. For
37058 example:
37059 .code
37060 smtp_etrn_command = /etc/etrn_command $domain \
37061                     $sender_host_address
37062 .endd
37063 .vindex "&$domain$&"
37064 The string is split up into arguments which are independently expanded. The
37065 expansion variable &$domain$& is set to the argument of the ETRN command,
37066 and no syntax checking is done on the contents of this argument. Exim does not
37067 wait for the command to complete, so its status code is not checked. Exim runs
37068 under its own uid and gid when receiving incoming SMTP, so it is not possible
37069 for it to change them before running the command.
37070
37071
37072
37073 .section "Incoming local SMTP" "SECID238"
37074 .cindex "SMTP" "local incoming"
37075 Some user agents use SMTP to pass messages to their local MTA using the
37076 standard input and output, as opposed to passing the envelope on the command
37077 line and writing the message to the standard input. This is supported by the
37078 &%-bs%& option. This form of SMTP is handled in the same way as incoming
37079 messages over TCP/IP (including the use of ACLs), except that the envelope
37080 sender given in a MAIL command is ignored unless the caller is trusted. In
37081 an ACL you can detect this form of SMTP input by testing for an empty host
37082 identification. It is common to have this as the first line in the ACL that
37083 runs for RCPT commands:
37084 .code
37085 accept hosts = :
37086 .endd
37087 This accepts SMTP messages from local processes without doing any other tests.
37088
37089
37090
37091 .section "Outgoing batched SMTP" "SECTbatchSMTP"
37092 .cindex "SMTP" "batched outgoing"
37093 .cindex "batched SMTP output"
37094 Both the &(appendfile)& and &(pipe)& transports can be used for handling
37095 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
37096 be output in BSMTP format. No SMTP responses are possible for this form of
37097 delivery. All it is doing is using SMTP commands as a way of transmitting the
37098 envelope along with the message.
37099
37100 The message is written to the file or pipe preceded by the SMTP commands
37101 MAIL and RCPT, and followed by a line containing a single dot. Lines in
37102 the message that start with a dot have an extra dot added. The SMTP command
37103 HELO is not normally used. If it is required, the &%message_prefix%& option
37104 can be used to specify it.
37105
37106 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
37107 one recipient address at a time by default. However, you can arrange for them
37108 to handle several addresses at once by setting the &%batch_max%& option. When
37109 this is done for BSMTP, messages may contain multiple RCPT commands. See
37110 chapter &<<CHAPbatching>>& for more details.
37111
37112 .vindex "&$host$&"
37113 When one or more addresses are routed to a BSMTP transport by a router that
37114 sets up a host list, the name of the first host on the list is available to the
37115 transport in the variable &$host$&. Here is an example of such a transport and
37116 router:
37117 .code
37118 begin routers
37119 route_append:
37120   driver = manualroute
37121   transport = smtp_appendfile
37122   route_list = domain.example  batch.host.example
37123
37124 begin transports
37125 smtp_appendfile:
37126   driver = appendfile
37127   directory = /var/bsmtp/$host
37128   batch_max = 1000
37129   use_bsmtp
37130   user = exim
37131 .endd
37132 This causes messages addressed to &'domain.example'& to be written in BSMTP
37133 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
37134 message (unless there are more than 1000 recipients).
37135
37136
37137
37138 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
37139 .cindex "SMTP" "batched incoming"
37140 .cindex "batched SMTP input"
37141 The &%-bS%& command line option causes Exim to accept one or more messages by
37142 reading SMTP on the standard input, but to generate no responses. If the caller
37143 is trusted, the senders in the MAIL commands are believed; otherwise the
37144 sender is always the caller of Exim. Unqualified senders and receivers are not
37145 rejected (there seems little point) but instead just get qualified. HELO
37146 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
37147 as NOOP; QUIT quits.
37148
37149 Minimal policy checking is done for BSMTP input. Only the non-SMTP
37150 ACL is run in the same way as for non-SMTP local input.
37151
37152 If an error is detected while reading a message, including a missing &"."& at
37153 the end, Exim gives up immediately. It writes details of the error to the
37154 standard output in a stylized way that the calling program should be able to
37155 make some use of automatically, for example:
37156 .code
37157 554 Unexpected end of file
37158 Transaction started in line 10
37159 Error detected in line 14
37160 .endd
37161 It writes a more verbose version, for human consumption, to the standard error
37162 file, for example:
37163 .code
37164 An error was detected while processing a file of BSMTP input.
37165 The error message was:
37166
37167 501 '>' missing at end of address
37168
37169 The SMTP transaction started in line 10.
37170 The error was detected in line 12.
37171 The SMTP command at fault was:
37172
37173 rcpt to:<malformed@in.com.plete
37174
37175 1 previous message was successfully processed.
37176 The rest of the batch was abandoned.
37177 .endd
37178 The return code from Exim is zero only if there were no errors. It is 1 if some
37179 messages were accepted before an error was detected, and 2 if no messages were
37180 accepted.
37181 .ecindex IIDsmtpproc1
37182 .ecindex IIDsmtpproc2
37183
37184
37185
37186 . ////////////////////////////////////////////////////////////////////////////
37187 . ////////////////////////////////////////////////////////////////////////////
37188
37189 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
37190          "Customizing messages"
37191 When a message fails to be delivered, or remains in the queue for more than a
37192 configured amount of time, Exim sends a message to the original sender, or
37193 to an alternative configured address. The text of these messages is built into
37194 the code of Exim, but it is possible to change it, either by adding a single
37195 string, or by replacing each of the paragraphs by text supplied in a file.
37196
37197 The &'From:'& and &'To:'& header lines are automatically generated; you can
37198 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
37199 option. Exim also adds the line
37200 .code
37201 Auto-Submitted: auto-generated
37202 .endd
37203 to all warning and bounce messages,
37204
37205
37206 .section "Customizing bounce messages" "SECID239"
37207 .cindex "customizing" "bounce message"
37208 .cindex "bounce message" "customizing"
37209 If &%bounce_message_text%& is set, its contents are included in the default
37210 message immediately after &"This message was created automatically by mail
37211 delivery software."& The string is not expanded. It is not used if
37212 &%bounce_message_file%& is set.
37213
37214 When &%bounce_message_file%& is set, it must point to a template file for
37215 constructing error messages. The file consists of a series of text items,
37216 separated by lines consisting of exactly four asterisks. If the file cannot be
37217 opened, default text is used and a message is written to the main and panic
37218 logs. If any text item in the file is empty, default text is used for that
37219 item.
37220
37221 .vindex "&$bounce_recipient$&"
37222 .vindex "&$bounce_return_size_limit$&"
37223 Each item of text that is read from the file is expanded, and there are two
37224 expansion variables which can be of use here: &$bounce_recipient$& is set to
37225 the recipient of an error message while it is being created, and
37226 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
37227 option, rounded to a whole number.
37228
37229 The items must appear in the file in the following order:
37230
37231 .ilist
37232 The first item is included in the headers, and should include at least a
37233 &'Subject:'& header. Exim does not check the syntax of these headers.
37234 .next
37235 The second item forms the start of the error message. After it, Exim lists the
37236 failing addresses with their error messages.
37237 .next
37238 The third item is used to introduce any text from pipe transports that is to be
37239 returned to the sender. It is omitted if there is no such text.
37240 .next
37241 The fourth, fifth and sixth items will be ignored and may be empty.
37242 The fields exist for back-compatibility
37243 .endlist
37244
37245 The default state (&%bounce_message_file%& unset) is equivalent to the
37246 following file, in which the sixth item is empty. The &'Subject:'& and some
37247 other lines have been split in order to fit them on the page:
37248 .code
37249 Subject: Mail delivery failed
37250   ${if eq{$sender_address}{$bounce_recipient}
37251   {: returning message to sender}}
37252 ****
37253 This message was created automatically by mail delivery software.
37254
37255 A message ${if eq{$sender_address}{$bounce_recipient}
37256   {that you sent }{sent by
37257
37258 <$sender_address>
37259
37260 }}could not be delivered to all of its recipients.
37261 This is a permanent error. The following address(es) failed:
37262 ****
37263 The following text was generated during the delivery attempt(s):
37264 ****
37265 ------ This is a copy of the message, including all the headers.
37266   ------
37267 ****
37268 ------ The body of the message is $message_size characters long;
37269   only the first
37270 ------ $bounce_return_size_limit or so are included here.
37271 ****
37272 .endd
37273 .section "Customizing warning messages" "SECTcustwarn"
37274 .cindex "customizing" "warning message"
37275 .cindex "warning of delay" "customizing the message"
37276 The option &%warn_message_file%& can be pointed at a template file for use when
37277 warnings about message delays are created. In this case there are only three
37278 text sections:
37279
37280 .ilist
37281 The first item is included in the headers, and should include at least a
37282 &'Subject:'& header. Exim does not check the syntax of these headers.
37283 .next
37284 The second item forms the start of the warning message. After it, Exim lists
37285 the delayed addresses.
37286 .next
37287 The third item then ends the message.
37288 .endlist
37289
37290 The default state is equivalent to the following file, except that some lines
37291 have been split here, in order to fit them on the page:
37292 .code
37293 Subject: Warning: message $message_exim_id delayed
37294   $warn_message_delay
37295 ****
37296 This message was created automatically by mail delivery software.
37297
37298 A message ${if eq{$sender_address}{$warn_message_recipients}
37299 {that you sent }{sent by
37300
37301 <$sender_address>
37302
37303 }}has not been delivered to all of its recipients after
37304 more than $warn_message_delay in the queue on $primary_hostname.
37305
37306 The message identifier is:     $message_exim_id
37307 The subject of the message is: $h_subject
37308 The date of the message is:    $h_date
37309
37310 The following address(es) have not yet been delivered:
37311 ****
37312 No action is required on your part. Delivery attempts will
37313 continue for some time, and this warning may be repeated at
37314 intervals if the message remains undelivered. Eventually the
37315 mail delivery software will give up, and when that happens,
37316 the message will be returned to you.
37317 .endd
37318 .vindex "&$warn_message_delay$&"
37319 .vindex "&$warn_message_recipients$&"
37320 However, in the default state the subject and date lines are omitted if no
37321 appropriate headers exist. During the expansion of this file,
37322 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
37323 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
37324 of recipients for the warning message. There may be more than one if there are
37325 multiple addresses with different &%errors_to%& settings on the routers that
37326 handled them.
37327
37328
37329
37330
37331 . ////////////////////////////////////////////////////////////////////////////
37332 . ////////////////////////////////////////////////////////////////////////////
37333
37334 .chapter "Some common configuration settings" "CHAPcomconreq"
37335 This chapter discusses some configuration settings that seem to be fairly
37336 common. More examples and discussion can be found in the Exim book.
37337
37338
37339
37340 .section "Sending mail to a smart host" "SECID240"
37341 .cindex "smart host" "example router"
37342 If you want to send all mail for non-local domains to a &"smart host"&, you
37343 should replace the default &(dnslookup)& router with a router which does the
37344 routing explicitly:
37345 .code
37346 send_to_smart_host:
37347   driver = manualroute
37348   route_list = !+local_domains smart.host.name
37349   transport = remote_smtp
37350 .endd
37351 You can use the smart host's IP address instead of the name if you wish.
37352 If you are using Exim only to submit messages to a smart host, and not for
37353 receiving incoming messages, you can arrange for it to do the submission
37354 synchronously by setting the &%mua_wrapper%& option (see chapter
37355 &<<CHAPnonqueueing>>&).
37356
37357
37358
37359
37360 .section "Using Exim to handle mailing lists" "SECTmailinglists"
37361 .cindex "mailing lists"
37362 Exim can be used to run simple mailing lists, but for large and/or complicated
37363 requirements, the use of additional specialized mailing list software such as
37364 Majordomo or Mailman is recommended.
37365
37366 The &(redirect)& router can be used to handle mailing lists where each list
37367 is maintained in a separate file, which can therefore be managed by an
37368 independent manager. The &%domains%& router option can be used to run these
37369 lists in a separate domain from normal mail. For example:
37370 .code
37371 lists:
37372   driver = redirect
37373   domains = lists.example
37374   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37375   forbid_pipe
37376   forbid_file
37377   errors_to = ${quote_local_part:$local_part-request}@lists.example
37378   no_more
37379 .endd
37380 This router is skipped for domains other than &'lists.example'&. For addresses
37381 in that domain, it looks for a file that matches the local part. If there is no
37382 such file, the router declines, but because &%no_more%& is set, no subsequent
37383 routers are tried, and so the whole delivery fails.
37384
37385 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
37386 expanded into a filename or a pipe delivery, which is usually inappropriate in
37387 a mailing list.
37388
37389 .oindex "&%errors_to%&"
37390 The &%errors_to%& option specifies that any delivery errors caused by addresses
37391 taken from a mailing list are to be sent to the given address rather than the
37392 original sender of the message. However, before acting on this, Exim verifies
37393 the error address, and ignores it if verification fails.
37394
37395 For example, using the configuration above, mail sent to
37396 &'dicts@lists.example'& is passed on to those addresses contained in
37397 &_/usr/lists/dicts_&, with error reports directed to
37398 &'dicts-request@lists.example'&, provided that this address can be verified.
37399 There could be a file called &_/usr/lists/dicts-request_& containing
37400 the address(es) of this particular list's manager(s), but other approaches,
37401 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37402 or &%local_part_suffix%& options) to handle addresses of the form
37403 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37404
37405
37406
37407 .section "Syntax errors in mailing lists" "SECID241"
37408 .cindex "mailing lists" "syntax errors in"
37409 If an entry in redirection data contains a syntax error, Exim normally defers
37410 delivery of the original address. That means that a syntax error in a mailing
37411 list holds up all deliveries to the list. This may not be appropriate when a
37412 list is being maintained automatically from data supplied by users, and the
37413 addresses are not rigorously checked.
37414
37415 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37416 entries that fail to parse, noting the incident in the log. If in addition
37417 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37418 whenever a broken address is skipped. It is usually appropriate to set
37419 &%syntax_errors_to%& to the same address as &%errors_to%&.
37420
37421
37422
37423 .section "Re-expansion of mailing lists" "SECID242"
37424 .cindex "mailing lists" "re-expansion of"
37425 Exim remembers every individual address to which a message has been delivered,
37426 in order to avoid duplication, but it normally stores only the original
37427 recipient addresses with a message. If all the deliveries to a mailing list
37428 cannot be done at the first attempt, the mailing list is re-expanded when the
37429 delivery is next tried. This means that alterations to the list are taken into
37430 account at each delivery attempt, so addresses that have been added to
37431 the list since the message arrived will therefore receive a copy of the
37432 message, even though it pre-dates their subscription.
37433
37434 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37435 on the &(redirect)& router. If this is done, any addresses generated by the
37436 router that fail to deliver at the first attempt are added to the message as
37437 &"top level"& addresses, and the parent address that generated them is marked
37438 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37439 subsequent delivery attempts. The disadvantage of this is that if any of the
37440 failing addresses are incorrect, correcting them in the file has no effect on
37441 pre-existing messages.
37442
37443 The original top-level address is remembered with each of the generated
37444 addresses, and is output in any log messages. However, any intermediate parent
37445 addresses are not recorded. This makes a difference to the log only if the
37446 &%all_parents%& selector is set, but for mailing lists there is normally only
37447 one level of expansion anyway.
37448
37449
37450
37451 .section "Closed mailing lists" "SECID243"
37452 .cindex "mailing lists" "closed"
37453 The examples so far have assumed open mailing lists, to which anybody may
37454 send mail. It is also possible to set up closed lists, where mail is accepted
37455 from specified senders only. This is done by making use of the generic
37456 &%senders%& option to restrict the router that handles the list.
37457
37458 The following example uses the same file as a list of recipients and as a list
37459 of permitted senders. It requires three routers:
37460 .code
37461 lists_request:
37462   driver = redirect
37463   domains = lists.example
37464   local_part_suffix = -request
37465   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37466   file = /usr/lists/${local_part_data}-request
37467   no_more
37468
37469 lists_post:
37470   driver = redirect
37471   domains = lists.example
37472   senders = ${if exists {/usr/lists/$local_part}\
37473              {lsearch;/usr/lists/$local_part}{*}}
37474   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37475   forbid_pipe
37476   forbid_file
37477   errors_to = ${quote_local_part:$local_part-request}@lists.example
37478   no_more
37479
37480 lists_closed:
37481   driver = redirect
37482   domains = lists.example
37483   allow_fail
37484   data = :fail: $local_part@lists.example is a closed mailing list
37485 .endd
37486 All three routers have the same &%domains%& setting, so for any other domains,
37487 they are all skipped. The first router runs only if the local part ends in
37488 &%-request%&. It handles messages to the list manager(s) by means of an open
37489 mailing list.
37490
37491 The second router runs only if the &%senders%& precondition is satisfied. It
37492 checks for the existence of a list that corresponds to the local part, and then
37493 checks that the sender is on the list by means of a linear search. It is
37494 necessary to check for the existence of the file before trying to search it,
37495 because otherwise Exim thinks there is a configuration error. If the file does
37496 not exist, the expansion of &%senders%& is *, which matches all senders. This
37497 means that the router runs, but because there is no list, declines, and
37498 &%no_more%& ensures that no further routers are run. The address fails with an
37499 &"unrouteable address"& error.
37500
37501 The third router runs only if the second router is skipped, which happens when
37502 a mailing list exists, but the sender is not on it. This router forcibly fails
37503 the address, giving a suitable error message.
37504
37505
37506
37507
37508 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37509 .cindex "VERP"
37510 .cindex "Variable Envelope Return Paths"
37511 .cindex "envelope from"
37512 .cindex "envelope sender"
37513 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37514 are a way of helping mailing list administrators discover which subscription
37515 address is the cause of a particular delivery failure. The idea is to encode
37516 the original recipient address in the outgoing envelope sender address, so that
37517 if the message is forwarded by another host and then subsequently bounces, the
37518 original recipient can be extracted from the recipient address of the bounce.
37519
37520 .oindex &%errors_to%&
37521 .oindex &%return_path%&
37522 Envelope sender addresses can be modified by Exim using two different
37523 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37524 list examples), or the &%return_path%& option on a transport. The second of
37525 these is effective only if the message is successfully delivered to another
37526 host; it is not used for errors detected on the local host (see the description
37527 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37528 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37529 .code
37530 verp_smtp:
37531   driver = smtp
37532   max_rcpt = 1
37533   return_path = \
37534     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37535       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37536 .endd
37537 This has the effect of rewriting the return path (envelope sender) on outgoing
37538 SMTP messages, if the local part of the original return path ends in
37539 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37540 local part and domain of the recipient into the return path. Suppose, for
37541 example, that a message whose return path has been set to
37542 &'somelist-request@your.dom.example'& is sent to
37543 &'subscriber@other.dom.example'&. In the transport, the return path is
37544 rewritten as
37545 .code
37546 somelist-request+subscriber=other.dom.example@your.dom.example
37547 .endd
37548 .vindex "&$local_part$&"
37549 For this to work, you must tell Exim to send multiple copies of messages that
37550 have more than one recipient, so that each copy has just one recipient. This is
37551 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37552 might be sent to several different recipients in the same domain, in which case
37553 &$local_part$& is not available in the transport, because it is not unique.
37554
37555 Unless your host is doing nothing but mailing list deliveries, you should
37556 probably use a separate transport for the VERP deliveries, so as not to use
37557 extra resources in making one-per-recipient copies for other deliveries. This
37558 can easily be done by expanding the &%transport%& option in the router:
37559 .code
37560 dnslookup:
37561   driver = dnslookup
37562   domains = ! +local_domains
37563   transport = \
37564     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37565       {verp_smtp}{remote_smtp}}
37566   no_more
37567 .endd
37568 If you want to change the return path using &%errors_to%& in a router instead
37569 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37570 routers that handle mailing list addresses. This will ensure that all delivery
37571 errors, including those detected on the local host, are sent to the VERP
37572 address.
37573
37574 On a host that does no local deliveries and has no manual routing, only the
37575 &(dnslookup)& router needs to be changed. A special transport is not needed for
37576 SMTP deliveries. Every mailing list recipient has its own return path value,
37577 and so Exim must hand them to the transport one at a time. Here is an example
37578 of a &(dnslookup)& router that implements VERP:
37579 .code
37580 verp_dnslookup:
37581   driver = dnslookup
37582   domains = ! +local_domains
37583   transport = remote_smtp
37584   errors_to = \
37585     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37586      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37587   no_more
37588 .endd
37589 Before you start sending out messages with VERPed return paths, you must also
37590 configure Exim to accept the bounce messages that come back to those paths.
37591 Typically this is done by setting a &%local_part_suffix%& option for a
37592 router, and using this to route the messages to wherever you want to handle
37593 them.
37594
37595 The overhead incurred in using VERP depends very much on the size of the
37596 message, the number of recipient addresses that resolve to the same remote
37597 host, and the speed of the connection over which the message is being sent. If
37598 a lot of addresses resolve to the same host and the connection is slow, sending
37599 a separate copy of the message for each address may take substantially longer
37600 than sending a single copy with many recipients (for which VERP cannot be
37601 used).
37602
37603
37604
37605
37606
37607
37608 .section "Virtual domains" "SECTvirtualdomains"
37609 .cindex "virtual domains"
37610 .cindex "domain" "virtual"
37611 The phrase &'virtual domain'& is unfortunately used with two rather different
37612 meanings:
37613
37614 .ilist
37615 A domain for which there are no real mailboxes; all valid local parts are
37616 aliases for other email addresses. Common examples are organizational
37617 top-level domains and &"vanity"& domains.
37618 .next
37619 One of a number of independent domains that are all handled by the same host,
37620 with mailboxes on that host, but where the mailbox owners do not necessarily
37621 have login accounts on that host.
37622 .endlist
37623
37624 The first usage is probably more common, and does seem more &"virtual"& than
37625 the second. This kind of domain can be handled in Exim with a straightforward
37626 aliasing router. One approach is to create a separate alias file for each
37627 virtual domain. Exim can test for the existence of the alias file to determine
37628 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37629 to a router of this form:
37630 .code
37631 virtual:
37632   driver = redirect
37633   domains = dsearch;/etc/mail/virtual
37634   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37635   no_more
37636 .endd
37637 The &%domains%& option specifies that the router is to be skipped, unless there
37638 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37639 domain that is being processed.
37640 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37641 being placed into the &$domain_data$& variable.
37642
37643 When the router runs, it looks up the local
37644 part in the file to find a new address (or list of addresses). The &%no_more%&
37645 setting ensures that if the lookup fails (leading to &%data%& being an empty
37646 string), Exim gives up on the address without trying any subsequent routers.
37647
37648 This one router can handle all the virtual domains because the alias filenames
37649 follow a fixed pattern. Permissions can be arranged so that appropriate people
37650 can edit the different alias files. A successful aliasing operation results in
37651 a new envelope recipient address, which is then routed from scratch.
37652
37653 The other kind of &"virtual"& domain can also be handled in a straightforward
37654 way. One approach is to create a file for each domain containing a list of
37655 valid local parts, and use it in a router like this:
37656 .code
37657 my_domains:
37658   driver = accept
37659   domains = dsearch;/etc/mail/domains
37660   local_parts = lsearch;/etc/mail/domains/$domain
37661   transport = my_mailboxes
37662 .endd
37663 The address is accepted if there is a file for the domain, and the local part
37664 can be found in the file. The &%domains%& option is used to check for the
37665 file's existence because &%domains%& is tested before the &%local_parts%&
37666 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37667 because that option is tested after &%local_parts%&. The transport is as
37668 follows:
37669 .code
37670 my_mailboxes:
37671   driver = appendfile
37672   file = /var/mail/$domain_data/$local_part_data
37673   user = mail
37674 .endd
37675 This uses a directory of mailboxes for each domain. The &%user%& setting is
37676 required, to specify which uid is to be used for writing to the mailboxes.
37677
37678 The configuration shown here is just one example of how you might support this
37679 requirement. There are many other ways this kind of configuration can be set
37680 up, for example, by using a database instead of separate files to hold all the
37681 information about the domains.
37682
37683
37684
37685 .section "Multiple user mailboxes" "SECTmulbox"
37686 .cindex "multiple mailboxes"
37687 .cindex "mailbox" "multiple"
37688 .cindex "local part" "prefix"
37689 .cindex "local part" "suffix"
37690 Heavy email users often want to operate with multiple mailboxes, into which
37691 incoming mail is automatically sorted. A popular way of handling this is to
37692 allow users to use multiple sender addresses, so that replies can easily be
37693 identified. Users are permitted to add prefixes or suffixes to their local
37694 parts for this purpose. The wildcard facility of the generic router options
37695 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37696 example, consider this router:
37697 .code
37698 userforward:
37699   driver = redirect
37700   check_local_user
37701   file = $home/.forward
37702   local_part_suffix = -*
37703   local_part_suffix_optional
37704   allow_filter
37705 .endd
37706 .vindex "&$local_part_suffix$&"
37707 It runs a user's &_.forward_& file for all local parts of the form
37708 &'username-*'&. Within the filter file the user can distinguish different
37709 cases by testing the variable &$local_part_suffix$&. For example:
37710 .code
37711 if $local_part_suffix contains -special then
37712 save /home/$local_part_data/Mail/special
37713 endif
37714 .endd
37715 If the filter file does not exist, or does not deal with such addresses, they
37716 fall through to subsequent routers, and, assuming no subsequent use of the
37717 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37718 control over which suffixes are valid.
37719
37720 Alternatively, a suffix can be used to trigger the use of a different
37721 &_.forward_& file &-- which is the way a similar facility is implemented in
37722 another MTA:
37723 .code
37724 userforward:
37725   driver = redirect
37726   check_local_user
37727   local_part_suffix = -*
37728   local_part_suffix_optional
37729   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37730   allow_filter
37731 .endd
37732 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37733 example, &_.forward-special_& is used. Once again, if the appropriate file
37734 does not exist, or does not deal with the address, it is passed on to
37735 subsequent routers, which could, if required, look for an unqualified
37736 &_.forward_& file to use as a default.
37737
37738
37739
37740 .section "Simplified vacation processing" "SECID244"
37741 .cindex "vacation processing"
37742 The traditional way of running the &'vacation'& program is for a user to set up
37743 a pipe command in a &_.forward_& file
37744 (see section &<<SECTspecitredli>>& for syntax details).
37745 This is prone to error by inexperienced users. There are two features of Exim
37746 that can be used to make this process simpler for users:
37747
37748 .ilist
37749 A local part prefix such as &"vacation-"& can be specified on a router which
37750 can cause the message to be delivered directly to the &'vacation'& program, or
37751 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37752 &_.forward_& file are then much simpler. For example:
37753 .code
37754 spqr, vacation-spqr
37755 .endd
37756 .next
37757 The &%require_files%& generic router option can be used to trigger a
37758 vacation delivery by checking for the existence of a certain file in the
37759 user's home directory. The &%unseen%& generic option should also be used, to
37760 ensure that the original delivery also proceeds. In this case, all the user has
37761 to do is to create a file called, say, &_.vacation_&, containing a vacation
37762 message.
37763 .endlist
37764
37765 Another advantage of both these methods is that they both work even when the
37766 use of arbitrary pipes by users is locked out.
37767
37768
37769
37770 .section "Taking copies of mail" "SECID245"
37771 .cindex "message" "copying every"
37772 Some installations have policies that require archive copies of all messages to
37773 be made. A single copy of each message can easily be taken by an appropriate
37774 command in a system filter, which could, for example, use a different file for
37775 each day's messages.
37776
37777 There is also a shadow transport mechanism that can be used to take copies of
37778 messages that are successfully delivered by local transports, one copy per
37779 delivery. This could be used, &'inter alia'&, to implement automatic
37780 notification of delivery by sites that insist on doing such things.
37781
37782
37783
37784 .section "Intermittently connected hosts" "SECID246"
37785 .cindex "intermittently connected hosts"
37786 It has become quite common (because it is cheaper) for hosts to connect to the
37787 Internet periodically rather than remain connected all the time. The normal
37788 arrangement is that mail for such hosts accumulates on a system that is
37789 permanently connected.
37790
37791 Exim was designed for use on permanently connected hosts, and so it is not
37792 particularly well-suited to use in an intermittently connected environment.
37793 Nevertheless there are some features that can be used.
37794
37795
37796 .section "Exim on the upstream server host" "SECID247"
37797 It is tempting to arrange for incoming mail for the intermittently connected
37798 host to remain in Exim's queue until the client connects. However, this
37799 approach does not scale very well. Two different kinds of waiting message are
37800 being mixed up in the same queue &-- those that cannot be delivered because of
37801 some temporary problem, and those that are waiting for their destination host
37802 to connect. This makes it hard to manage the queue, as well as wasting
37803 resources, because each queue runner scans the entire queue.
37804
37805 A better approach is to separate off those messages that are waiting for an
37806 intermittently connected host. This can be done by delivering these messages
37807 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37808 format, from where they are transmitted by other software when their
37809 destination connects. This makes it easy to collect all the mail for one host
37810 in a single directory, and to apply local timeout rules on a per-message basis
37811 if required.
37812
37813 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37814 you are doing this, you should configure Exim with a long retry period for the
37815 intermittent host. For example:
37816 .code
37817 cheshire.wonderland.fict.example    *   F,5d,24h
37818 .endd
37819 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37820 which messages it has queued up for that host. Once the intermittent host comes
37821 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37822 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37823 causes all the queued up messages to be delivered, often down a single SMTP
37824 connection. While the host remains connected, any new messages get delivered
37825 immediately.
37826
37827 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37828 issued with a different IP address each time it connects, Exim's retry
37829 mechanisms on the holding host get confused, because the IP address is normally
37830 used as part of the key string for holding retry information. This can be
37831 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37832 Since this has disadvantages for permanently connected hosts, it is best to
37833 arrange a separate transport for the intermittently connected ones.
37834
37835
37836
37837 .section "Exim on the intermittently connected client host" "SECID248"
37838 The value of &%smtp_accept_queue_per_connection%& should probably be
37839 increased, or even set to zero (that is, disabled) on the intermittently
37840 connected host, so that all incoming messages down a single connection get
37841 delivered immediately.
37842
37843 .cindex "SMTP" "passed connection"
37844 .cindex "SMTP" "multiple deliveries"
37845 .cindex "multiple SMTP deliveries"
37846 .cindex "first pass routing"
37847 Mail waiting to be sent from an intermittently connected host will probably
37848 not have been routed, because without a connection DNS lookups are not
37849 possible. This means that if a normal queue run is done at connection time,
37850 each message is likely to be sent in a separate SMTP session. This can be
37851 avoided by starting the queue run with a command line option beginning with
37852 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37853 first pass, routing is done but no deliveries take place. The second pass is a
37854 normal queue run; since all the messages have been previously routed, those
37855 destined for the same host are likely to get sent as multiple deliveries in a
37856 single SMTP connection.
37857
37858
37859
37860 . ////////////////////////////////////////////////////////////////////////////
37861 . ////////////////////////////////////////////////////////////////////////////
37862
37863 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37864          "Exim as a non-queueing client"
37865 .cindex "client, non-queueing"
37866 .cindex "smart host" "suppressing queueing"
37867 On a personal computer, it is a common requirement for all
37868 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37869 configured to operate that way, for all the popular operating systems.
37870 However, there are some MUAs for Unix-like systems that cannot be so
37871 configured: they submit messages using the command line interface of
37872 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37873 messages this way.
37874
37875 If the personal computer runs continuously, there is no problem, because it can
37876 run a conventional MTA that handles delivery to the smart host, and deal with
37877 any delays via its queueing mechanism. However, if the computer does not run
37878 continuously or runs different operating systems at different times, queueing
37879 email is not desirable.
37880
37881 There is therefore a requirement for something that can provide the
37882 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37883 any queueing or retrying facilities. Furthermore, the delivery to the smart
37884 host should be synchronous, so that if it fails, the sending MUA is immediately
37885 informed. In other words, we want something that extends an MUA that submits
37886 to a local MTA via the command line so that it behaves like one that submits
37887 to a remote smart host using TCP/SMTP.
37888
37889 There are a number of applications (for example, there is one called &'ssmtp'&)
37890 that do this job. However, people have found them to be lacking in various
37891 ways. For instance, you might want to allow aliasing and forwarding to be done
37892 before sending a message to the smart host.
37893
37894 Exim already had the necessary infrastructure for doing this job. Just a few
37895 tweaks were needed to make it behave as required, though it is somewhat of an
37896 overkill to use a fully-featured MTA for this purpose.
37897
37898 .oindex "&%mua_wrapper%&"
37899 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37900 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37901 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37902 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37903 compatible router and transport configuration. Typically there will be just one
37904 router and one transport, sending everything to a smart host.
37905
37906 When run in MUA wrapping mode, the behaviour of Exim changes in the
37907 following ways:
37908
37909 .ilist
37910 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37911 In other words, the only way to submit messages is via the command line.
37912 .next
37913 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37914 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37915 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37916 does not finish until the delivery attempt is complete. If the delivery is
37917 successful, a zero return code is given.
37918 .next
37919 Address redirection is permitted, but the final routing for all addresses must
37920 be to the same remote transport, and to the same list of hosts. Furthermore,
37921 the return address (envelope sender) must be the same for all recipients, as
37922 must any added or deleted header lines. In other words, it must be possible to
37923 deliver the message in a single SMTP transaction, however many recipients there
37924 are.
37925 .next
37926 If these conditions are not met, or if routing any address results in a
37927 failure or defer status, or if Exim is unable to deliver all the recipients
37928 successfully to one of the smart hosts, delivery of the entire message fails.
37929 .next
37930 Because no queueing is allowed, all failures are treated as permanent; there
37931 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37932 smart host. Furthermore, because only a single yes/no response can be given to
37933 the caller, it is not possible to deliver to some recipients and not others. If
37934 there is an error (temporary or permanent) for any recipient, all are failed.
37935 .next
37936 If more than one smart host is listed, Exim will try another host after a
37937 connection failure or a timeout, in the normal way. However, if this kind of
37938 failure happens for all the hosts, the delivery fails.
37939 .next
37940 When delivery fails, an error message is written to the standard error stream
37941 (as well as to Exim's log), and Exim exits to the caller with a return code
37942 value 1. The message is expunged from Exim's spool files. No bounce messages
37943 are ever generated.
37944 .next
37945 No retry data is maintained, and any retry rules are ignored.
37946 .next
37947 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37948 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37949 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37950 .endlist
37951
37952 The overall effect is that Exim makes a single synchronous attempt to deliver
37953 the message, failing if there is any kind of problem. Because no local
37954 deliveries are done and no daemon can be run, Exim does not need root
37955 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37956 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37957 the advantages and disadvantages of running without root privilege.
37958
37959
37960
37961
37962 . ////////////////////////////////////////////////////////////////////////////
37963 . ////////////////////////////////////////////////////////////////////////////
37964
37965 .chapter "Log files" "CHAPlog"
37966 .scindex IIDloggen "log" "general description"
37967 .cindex "log" "types of"
37968 Exim writes three different logs, referred to as the main log, the reject log,
37969 and the panic log:
37970
37971 .ilist
37972 .cindex "main log"
37973 The main log records the arrival of each message and each delivery in a single
37974 line in each case. The format is as compact as possible, in an attempt to keep
37975 down the size of log files. Two-character flag sequences make it easy to pick
37976 out these lines. A number of other events are recorded in the main log. Some of
37977 them are optional, in which case the &%log_selector%& option controls whether
37978 they are included or not. A Perl script called &'eximstats'&, which does simple
37979 analysis of main log files, is provided in the Exim distribution (see section
37980 &<<SECTmailstat>>&).
37981 .next
37982 .cindex "reject log"
37983 The reject log records information from messages that are rejected as a result
37984 of a configuration option (that is, for policy reasons).
37985 The first line of each rejection is a copy of the line that is also written to
37986 the main log. Then, if the message's header has been read at the time the log
37987 is written, its contents are written to this log. Only the original header
37988 lines are available; header lines added by ACLs are not logged. You can use the
37989 reject log to check that your policy controls are working correctly; on a busy
37990 host this may be easier than scanning the main log for rejection messages. You
37991 can suppress the writing of the reject log by setting &%write_rejectlog%&
37992 false.
37993 .next
37994 .cindex "panic log"
37995 .cindex "system log"
37996 When certain serious errors occur, Exim writes entries to its panic log. If the
37997 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37998 are usually written to the main log as well, but can get lost amid the mass of
37999 other entries. The panic log should be empty under normal circumstances. It is
38000 therefore a good idea to check it (or to have a &'cron'& script check it)
38001 regularly, in order to become aware of any problems. When Exim cannot open its
38002 panic log, it tries as a last resort to write to the system log (syslog). This
38003 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
38004 message itself is written at priority LOG_CRIT.
38005 .endlist
38006
38007 Every log line starts with a timestamp, in the format shown in the following
38008 example. Note that many of the examples shown in this chapter are line-wrapped.
38009 In the log file, this would be all on one line:
38010 .code
38011 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
38012   by QUIT
38013 .endd
38014 By default, the timestamps are in the local timezone. There are two
38015 ways of changing this:
38016
38017 .ilist
38018 You can set the &%timezone%& option to a different time zone; in particular, if
38019 you set
38020 .code
38021 timezone = UTC
38022 .endd
38023 the timestamps will be in UTC (aka GMT).
38024 .next
38025 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
38026 example:
38027 .code
38028 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
38029 .endd
38030 .endlist
38031
38032 .cindex "log" "process ids in"
38033 .cindex "pid (process id)" "in log lines"
38034 Exim does not include its process id in log lines by default, but you can
38035 request that it does so by specifying the &`pid`& log selector (see section
38036 &<<SECTlogselector>>&). When this is set, the process id is output, in square
38037 brackets, immediately after the time and date.
38038
38039
38040
38041
38042 .section "Where the logs are written" "SECTwhelogwri"
38043 .cindex "log" "destination"
38044 .cindex "log" "to file"
38045 .cindex "log" "to syslog"
38046 .cindex "syslog"
38047 The logs may be written to local files, or to syslog, or both. However, it
38048 should be noted that many syslog implementations use UDP as a transport, and
38049 are therefore unreliable in the sense that messages are not guaranteed to
38050 arrive at the loghost, nor is the ordering of messages necessarily maintained.
38051 It has also been reported that on large log files (tens of megabytes) you may
38052 need to tweak syslog to prevent it syncing the file with each write &-- on
38053 Linux this has been seen to make syslog take 90% plus of CPU time.
38054
38055 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
38056 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
38057 configuration. This latter string is expanded, so it can contain, for example,
38058 references to the host name:
38059 .code
38060 log_file_path = /var/log/$primary_hostname/exim_%slog
38061 .endd
38062 It is generally advisable, however, to set the string in &_Local/Makefile_&
38063 rather than at runtime, because then the setting is available right from the
38064 start of Exim's execution. Otherwise, if there's something it wants to log
38065 before it has read the configuration file (for example, an error in the
38066 configuration file) it will not use the path you want, and may not be able to
38067 log at all.
38068
38069 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
38070 list, currently limited to at most two items. This is one option where the
38071 facility for changing a list separator may not be used. The list must always be
38072 colon-separated. If an item in the list is &"syslog"& then syslog is used;
38073 otherwise the item must either be an absolute path, containing &`%s`& at the
38074 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
38075 implying the use of a default path.
38076
38077 When Exim encounters an empty item in the list, it searches the list defined by
38078 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
38079 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
38080 mean &"use the path specified at build time"&. It no such item exists, log
38081 files are written in the &_log_& subdirectory of the spool directory. This is
38082 equivalent to the setting:
38083 .code
38084 log_file_path = $spool_directory/log/%slog
38085 .endd
38086 If you do not specify anything at build time or runtime,
38087 or if you unset the option at runtime (i.e. &`log_file_path = `&),
38088 that is where the logs are written.
38089
38090 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
38091 are in use &-- see section &<<SECTdatlogfil>>& below.
38092
38093 Here are some examples of possible settings:
38094 .display
38095 &`LOG_FILE_PATH=syslog                    `& syslog only
38096 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
38097 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
38098 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
38099 .endd
38100 If there are more than two paths in the list, the first is used and a panic
38101 error is logged.
38102
38103
38104
38105 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
38106 .cindex "log" "cycling local files"
38107 .cindex "cycling logs"
38108 .cindex "&'exicyclog'&"
38109 .cindex "log" "local files; writing to"
38110 Some operating systems provide centralized and standardized methods for cycling
38111 log files. For those that do not, a utility script called &'exicyclog'& is
38112 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
38113 main and reject logs each time it is called. The maximum number of old logs to
38114 keep can be set. It is suggested this script is run as a daily &'cron'& job.
38115
38116 An Exim delivery process opens the main log when it first needs to write to it,
38117 and it keeps the file open in case subsequent entries are required &-- for
38118 example, if a number of different deliveries are being done for the same
38119 message. However, remote SMTP deliveries can take a long time, and this means
38120 that the file may be kept open long after it is renamed if &'exicyclog'& or
38121 something similar is being used to rename log files on a regular basis. To
38122 ensure that a switch of log files is noticed as soon as possible, Exim calls
38123 &[stat()]& on the main log's name before reusing an open file, and if the file
38124 does not exist, or its inode has changed, the old file is closed and Exim
38125 tries to open the main log from scratch. Thus, an old log file may remain open
38126 for quite some time, but no Exim processes should write to it once it has been
38127 renamed.
38128
38129
38130
38131 .section "Datestamped log files" "SECTdatlogfil"
38132 .cindex "log" "datestamped files"
38133 Instead of cycling the main and reject log files by renaming them
38134 periodically, some sites like to use files whose names contain a datestamp,
38135 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
38136 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
38137 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
38138 point where the datestamp is required. For example:
38139 .code
38140 log_file_path = /var/spool/exim/log/%slog-%D
38141 log_file_path = /var/log/exim-%s-%D.log
38142 log_file_path = /var/spool/exim/log/%D-%slog
38143 log_file_path = /var/log/exim/%s.%M
38144 .endd
38145 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
38146 examples of names generated by the above examples:
38147 .code
38148 /var/spool/exim/log/mainlog-20021225
38149 /var/log/exim-reject-20021225.log
38150 /var/spool/exim/log/20021225-mainlog
38151 /var/log/exim/main.200212
38152 .endd
38153 When this form of log file is specified, Exim automatically switches to new
38154 files at midnight. It does not make any attempt to compress old logs; you
38155 will need to write your own script if you require this. You should not
38156 run &'exicyclog'& with this form of logging.
38157
38158 The location of the panic log is also determined by &%log_file_path%&, but it
38159 is not datestamped, because rotation of the panic log does not make sense.
38160 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
38161 the string. In addition, if it immediately follows a slash, a following
38162 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
38163 character is removed. Thus, the four examples above would give these panic
38164 log names:
38165 .code
38166 /var/spool/exim/log/paniclog
38167 /var/log/exim-panic.log
38168 /var/spool/exim/log/paniclog
38169 /var/log/exim/panic
38170 .endd
38171
38172
38173 .section "Logging to syslog" "SECID249"
38174 .cindex "log" "syslog; writing to"
38175 The use of syslog does not change what Exim logs or the format of its messages,
38176 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
38177 Exim's log lines are omitted when these lines are sent to syslog. Apart from
38178 that, the same strings are written to syslog as to log files. The syslog
38179 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
38180 by default, but you can change these by setting the &%syslog_facility%& and
38181 &%syslog_processname%& options, respectively. If Exim was compiled with
38182 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
38183 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
38184 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
38185 the time and host name to each line.
38186 The three log streams are mapped onto syslog priorities as follows:
38187
38188 .ilist
38189 &'mainlog'& is mapped to LOG_INFO
38190 .next
38191 &'rejectlog'& is mapped to LOG_NOTICE
38192 .next
38193 &'paniclog'& is mapped to LOG_ALERT
38194 .endlist
38195
38196 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
38197 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
38198 these are routed by syslog to the same place. You can suppress this duplication
38199 by setting &%syslog_duplication%& false.
38200
38201 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
38202 entries contain multiple lines when headers are included. To cope with both
38203 these cases, entries written to syslog are split into separate &[syslog()]&
38204 calls at each internal newline, and also after a maximum of
38205 870 data characters. (This allows for a total syslog line length of 1024, when
38206 additions such as timestamps are added.) If you are running a syslog
38207 replacement that can handle lines longer than the 1024 characters allowed by
38208 RFC 3164, you should set
38209 .code
38210 SYSLOG_LONG_LINES=yes
38211 .endd
38212 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
38213 lines, but it still splits at internal newlines in &'reject'& log entries.
38214
38215 To make it easy to re-assemble split lines later, each component of a split
38216 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
38217 where <&'n'&> is the component number and <&'m'&> is the total number of
38218 components in the entry. The / delimiter is used when the line was split
38219 because it was too long; if it was split because of an internal newline, the \
38220 delimiter is used. For example, supposing the length limit to be 50 instead of
38221 870, the following would be the result of a typical rejection message to
38222 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
38223 name, and pid as added by syslog:
38224 .code
38225 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
38226 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
38227 [3/5]  when scanning for sender: missing or malformed lo
38228 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
38229 [5/5] mple>)
38230 .endd
38231 The same error might cause the following lines to be written to &"rejectlog"&
38232 (LOG_NOTICE):
38233 .code
38234 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
38235 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
38236 [3/18] er when scanning for sender: missing or malformed
38237 [4/18]  local part in "<>" (envelope sender is <ph10@cam
38238 [5\18] .example>)
38239 [6\18] Recipients: ph10@some.domain.cam.example
38240 [7\18] P Received: from [127.0.0.1] (ident=ph10)
38241 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
38242 [9\18]        id 16RdAL-0006pc-00
38243 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
38244 [11\18] 09:43 +0100
38245 [12\18] F From: <>
38246 [13\18]   Subject: this is a test header
38247 [18\18]   X-something: this is another header
38248 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
38249 [16\18] le>
38250 [17\18] B Bcc:
38251 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
38252 .endd
38253 Log lines that are neither too long nor contain newlines are written to syslog
38254 without modification.
38255
38256 If only syslog is being used, the Exim monitor is unable to provide a log tail
38257 display, unless syslog is routing &'mainlog'& to a file on the local host and
38258 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
38259 where it is.
38260
38261
38262
38263 .section "Log line flags" "SECID250"
38264 One line is written to the main log for each message received, and for each
38265 successful, unsuccessful, and delayed delivery. These lines can readily be
38266 picked out by the distinctive two-character flags that immediately follow the
38267 timestamp. The flags are:
38268 .display
38269 &`<=`&     message arrival
38270 &`(=`&     message fakereject
38271 &`=>`&     normal message delivery
38272 &`->`&     additional address in same delivery
38273 &`>>`&     cutthrough message delivery
38274 &`*>`&     delivery suppressed by &%-N%&
38275 &`**`&     delivery failed; address bounced
38276 &`==`&     delivery deferred; temporary problem
38277 .endd
38278
38279
38280 .section "Logging message reception" "SECID251"
38281 .cindex "log" "reception line"
38282 The format of the single-line entry in the main log that is written for every
38283 message received is shown in the basic example below, which is split over
38284 several lines in order to fit it on the page:
38285 .code
38286 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
38287   H=mailer.fict.example [192.168.123.123] U=exim
38288   P=smtp S=5678 id=<incoming message id>
38289 .endd
38290 The address immediately following &"<="& is the envelope sender address. A
38291 bounce message is shown with the sender address &"<>"&, and if it is locally
38292 generated, this is followed by an item of the form
38293 .code
38294 R=<message id>
38295 .endd
38296 which is a reference to the message that caused the bounce to be sent.
38297
38298 .cindex "HELO"
38299 .cindex "EHLO"
38300 For messages from other hosts, the H and U fields identify the remote host and
38301 record the RFC 1413 identity of the user that sent the message, if one was
38302 received. The number given in square brackets is the IP address of the sending
38303 host. If there is a single, unparenthesized  host name in the H field, as
38304 above, it has been verified to correspond to the IP address (see the
38305 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
38306 by the remote host in the SMTP HELO or EHLO command, and has not been
38307 verified. If verification yields a different name to that given for HELO or
38308 EHLO, the verified name appears first, followed by the HELO or EHLO
38309 name in parentheses.
38310
38311 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
38312 without brackets, in the HELO or EHLO command, leading to entries in
38313 the log containing text like these examples:
38314 .code
38315 H=(10.21.32.43) [192.168.8.34]
38316 H=([10.21.32.43]) [192.168.8.34]
38317 .endd
38318 This can be confusing. Only the final address in square brackets can be relied
38319 on.
38320
38321 For locally generated messages (that is, messages not received over TCP/IP),
38322 the H field is omitted, and the U field contains the login name of the caller
38323 of Exim.
38324
38325 .cindex "authentication" "logging"
38326 .cindex "AUTH" "logging"
38327 For all messages, the P field specifies the protocol used to receive the
38328 message. This is the value that is stored in &$received_protocol$&. In the case
38329 of incoming SMTP messages, the value indicates whether or not any SMTP
38330 extensions (ESMTP), encryption, or authentication were used. If the SMTP
38331 session was encrypted, there is an additional X field that records the cipher
38332 suite that was used.
38333
38334 .cindex log protocol
38335 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
38336 hosts that have authenticated themselves using the SMTP AUTH command. The first
38337 value is used when the SMTP connection was encrypted (&"secure"&). In this case
38338 there is an additional item A= followed by the name of the authenticator that
38339 was used. If an authenticated identification was set up by the authenticator's
38340 &%server_set_id%& option, this is logged too, separated by a colon from the
38341 authenticator name.
38342
38343 .cindex "size" "of message"
38344 The id field records the existing message id, if present. The size of the
38345 received message is given by the S field. When the message is delivered,
38346 headers may be removed or added, so that the size of delivered copies of the
38347 message may not correspond with this value (and indeed may be different to each
38348 other).
38349
38350 The &%log_selector%& option can be used to request the logging of additional
38351 data when a message is received. See section &<<SECTlogselector>>& below.
38352
38353
38354
38355 .section "Logging deliveries" "SECID252"
38356 .cindex "log" "delivery line"
38357 The format of the single-line entry in the main log that is written for every
38358 delivery is shown in one of the examples below, for local and remote
38359 deliveries, respectively. Each example has been split into multiple lines in order
38360 to fit it on the page:
38361 .code
38362 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
38363   <marv@hitch.fict.example> R=localuser T=local_delivery
38364 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
38365   monk@holistic.fict.example R=dnslookup T=remote_smtp
38366   H=holistic.fict.example [192.168.234.234]
38367 .endd
38368 For ordinary local deliveries, the original address is given in angle brackets
38369 after the final delivery address, which might be a pipe or a file. If
38370 intermediate address(es) exist between the original and the final address, the
38371 last of these is given in parentheses after the final address. The R and T
38372 fields record the router and transport that were used to process the address.
38373
38374 If SMTP AUTH was used for the delivery there is an additional item A=
38375 followed by the name of the authenticator that was used.
38376 If an authenticated identification was set up by the authenticator's &%client_set_id%&
38377 option, this is logged too, as a second colon-separated list item.
38378 Optionally (see the &%smtp_mailauth%& &%log_selector%&) there may be a third list item.
38379
38380 If a shadow transport was run after a successful local delivery, the log line
38381 for the successful delivery has an item added on the end, of the form
38382 .display
38383 &`ST=<`&&'shadow transport name'&&`>`&
38384 .endd
38385 If the shadow transport did not succeed, the error message is put in
38386 parentheses afterwards.
38387
38388 .cindex "asterisk" "after IP address"
38389 When more than one address is included in a single delivery (for example, two
38390 SMTP RCPT commands in one transaction) the second and subsequent addresses are
38391 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
38392 down a single SMTP connection, an asterisk follows the
38393 .new
38394 remote IP address (and port if enabled)
38395 .wen
38396 in the log lines for the second and subsequent messages.
38397 When two or more messages are delivered down a single TLS connection, the
38398 DNS and some TLS-related information logged for the first message delivered
38399 will not be present in the log lines for the second and subsequent messages.
38400 TLS cipher information is still available.
38401
38402 .cindex "delivery" "cutthrough; logging"
38403 .cindex "cutthrough" "logging"
38404 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
38405 line precedes the reception line, since cutthrough waits for a possible
38406 rejection from the destination in case it can reject the sourced item.
38407
38408 The generation of a reply message by a filter file gets logged as a
38409 &"delivery"& to the addressee, preceded by &">"&.
38410
38411 The &%log_selector%& option can be used to request the logging of additional
38412 data when a message is delivered. See section &<<SECTlogselector>>& below.
38413
38414
38415 .section "Discarded deliveries" "SECID253"
38416 .cindex "discarded messages"
38417 .cindex "message" "discarded"
38418 .cindex "delivery" "discarded; logging"
38419 When a message is discarded as a result of the command &"seen finish"& being
38420 obeyed in a filter file which generates no deliveries, a log entry of the form
38421 .code
38422 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38423   <low.club@bridge.example> R=userforward
38424 .endd
38425 is written, to record why no deliveries are logged. When a message is discarded
38426 because it is aliased to &":blackhole:"& the log line is like this:
38427 .code
38428 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38429   <hole@nowhere.example> R=blackhole_router
38430 .endd
38431
38432
38433 .section "Deferred deliveries" "SECID254"
38434 When a delivery is deferred, a line of the following form is logged:
38435 .code
38436 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38437   R=dnslookup T=smtp defer (146): Connection refused
38438 .endd
38439 In the case of remote deliveries, the error is the one that was given for the
38440 last IP address that was tried. Details of individual SMTP failures are also
38441 written to the log, so the above line would be preceded by something like
38442 .code
38443 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38444   mail1.endrest.example [192.168.239.239]: Connection refused
38445 .endd
38446 When a deferred address is skipped because its retry time has not been reached,
38447 a message is written to the log, but this can be suppressed by setting an
38448 appropriate value in &%log_selector%&.
38449
38450
38451
38452 .section "Delivery failures" "SECID255"
38453 .cindex "delivery" "failure; logging"
38454 If a delivery fails because an address cannot be routed, a line of the
38455 following form is logged:
38456 .code
38457 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38458   <jim@trek99.example>: unknown mail domain
38459 .endd
38460 If a delivery fails at transport time, the router and transport are shown, and
38461 the response from the remote host is included, as in this example:
38462 .code
38463 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38464   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38465   after pipelined RCPT TO:<ace400@pb.example>: host
38466   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38467   <ace400@pb.example>...Addressee unknown
38468 .endd
38469 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38470 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38471 disabling PIPELINING. The log lines for all forms of delivery failure are
38472 flagged with &`**`&.
38473
38474
38475
38476 .section "Fake deliveries" "SECID256"
38477 .cindex "delivery" "fake; logging"
38478 If a delivery does not actually take place because the &%-N%& option has been
38479 used to suppress it, a normal delivery line is written to the log, except that
38480 &"=>"& is replaced by &"*>"&.
38481
38482
38483
38484 .section "Completion" "SECID257"
38485 A line of the form
38486 .code
38487 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38488 .endd
38489 is written to the main log when a message is about to be removed from the spool
38490 at the end of its processing.
38491
38492
38493
38494
38495 .section "Summary of Fields in Log Lines" "SECID258"
38496 .cindex "log" "summary of fields"
38497 A summary of the field identifiers that are used in log lines is shown in
38498 the following table:
38499 .display
38500 &`A   `&        authenticator name (and optional id and sender)
38501 &`C   `&        SMTP confirmation on delivery
38502 &`    `&        command list for &"no mail in SMTP session"&
38503 &`CV  `&        certificate verification status
38504 &`D   `&        duration of &"no mail in SMTP session"&
38505 &`DKIM`&        domain verified in incoming message
38506 &`DN  `&        distinguished name from peer certificate
38507 &`DS  `&        DNSSEC secured lookups
38508 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38509 &`F   `&        sender address (on delivery lines)
38510 &`H   `&        host name and IP address
38511 &`I   `&        local interface used
38512 &`id  `&        message id (from header) for incoming message
38513 &`K   `&        CHUNKING extension used
38514 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38515 &`M8S `&        8BITMIME status for incoming message
38516 &`P   `&        on &`<=`& lines: protocol used
38517 &`    `&        on &`=>`& and &`**`& lines: return path
38518 &`PRDR`&        PRDR extension used
38519 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38520 &`Q   `&        alternate queue name
38521 &`QT  `&        on &`=>`& lines: time spent on queue so far
38522 &`    `&        on &"Completed"& lines: time spent on queue
38523 &`R   `&        on &`<=`& lines: reference for local bounce
38524 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38525 &`RT  `&        on &`<=`& lines: time taken for reception
38526 &`S   `&        size of message in bytes
38527 &`SNI `&        server name indication from TLS client hello
38528 &`ST  `&        shadow transport name
38529 &`T   `&        on &`<=`& lines: message subject (topic)
38530 &`TFO `&        connection took advantage of TCP Fast Open
38531 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38532 &`U   `&        local user or RFC 1413 identity
38533 &`X   `&        TLS cipher suite
38534 .endd
38535
38536
38537 .section "Other log entries" "SECID259"
38538 Various other types of log entry are written from time to time. Most should be
38539 self-explanatory. Among the more common are:
38540
38541 .ilist
38542 .cindex "retry" "time not reached"
38543 &'retry time not reached'&&~&~An address previously suffered a temporary error
38544 during routing or local delivery, and the time to retry has not yet arrived.
38545 This message is not written to an individual message log file unless it happens
38546 during the first delivery attempt.
38547 .next
38548 &'retry time not reached for any host'&&~&~An address previously suffered
38549 temporary errors during remote delivery, and the retry time has not yet arrived
38550 for any of the hosts to which it is routed.
38551 .next
38552 .cindex "spool directory" "file locked"
38553 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38554 some other Exim process is already working on the message. This can be quite
38555 common if queue running processes are started at frequent intervals. The
38556 &'exiwhat'& utility script can be used to find out what Exim processes are
38557 doing.
38558 .next
38559 .cindex "error" "ignored"
38560 &'error ignored'&&~&~There are several circumstances that give rise to this
38561 message:
38562 .olist
38563 Exim failed to deliver a bounce message whose age was greater than
38564 &%ignore_bounce_errors_after%&. The bounce was discarded.
38565 .next
38566 A filter file set up a delivery using the &"noerror"& option, and the delivery
38567 failed. The delivery was discarded.
38568 .next
38569 A delivery set up by a router configured with
38570 . ==== As this is a nested list, any displays it contains must be indented
38571 . ==== as otherwise they are too far to the left.
38572 .code
38573     errors_to = <>
38574 .endd
38575 failed. The delivery was discarded.
38576 .endlist olist
38577 .next
38578 .cindex DKIM "log line"
38579 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38580 logging and the message has a DKIM signature header.
38581 .endlist ilist
38582
38583
38584
38585
38586
38587 .section "Reducing or increasing what is logged" "SECTlogselector"
38588 .cindex "log" "selectors"
38589 By setting the &%log_selector%& global option, you can disable some of Exim's
38590 default logging, or you can request additional logging. The value of
38591 &%log_selector%& is made up of names preceded by plus or minus characters. For
38592 example:
38593 .code
38594 log_selector = +arguments -retry_defer
38595 .endd
38596 The list of optional log items is in the following table, with the default
38597 selection marked by asterisks:
38598 .display
38599 &` 8bitmime                   `&  received 8BITMIME status
38600 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38601 &` address_rewrite            `&  address rewriting
38602 &` all_parents                `&  all parents in => lines
38603 &` arguments                  `&  command line arguments
38604 &`*connection_reject          `&  connection rejections
38605 &`*delay_delivery             `&  immediate delivery delayed
38606 &` deliver_time               `&  time taken to attempt delivery
38607 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38608 &`*dkim                       `&  DKIM verified domain on <= lines
38609 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38610 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38611 &` dnssec                     `&  DNSSEC secured lookups
38612 &`*etrn                       `&  ETRN commands
38613 &`*host_lookup_failed         `&  as it says
38614 &` ident_timeout              `&  timeout for ident connection
38615 &` incoming_interface         `&  local interface on <= and => lines
38616 &` incoming_port              `&  remote port on <= lines
38617 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38618 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38619 &`*msg_id                     `&  on <= lines, Message-ID: header value
38620 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38621 &` outgoing_interface         `&  local interface on => lines
38622 &` outgoing_port              `&  add remote port to => lines
38623 &`*queue_run                  `&  start and end queue runs
38624 &` queue_time                 `&  time on queue for one recipient
38625 &` queue_time_overall         `&  time on queue for whole message
38626 &` pid                        `&  Exim process id
38627 &` pipelining                 `&  PIPELINING use, on <= and => lines
38628 &` proxy                      `&  proxy address on <= and => lines
38629 &` receive_time               `&  time taken to receive message
38630 &` received_recipients        `&  recipients on <= lines
38631 &` received_sender            `&  sender on <= lines
38632 &`*rejected_header            `&  header contents on reject log
38633 &`*retry_defer                `&  &"retry time not reached"&
38634 &` return_path_on_delivery    `&  put return path on => and ** lines
38635 &` sender_on_delivery         `&  add sender to => lines
38636 &`*sender_verify_fail         `&  sender verification failures
38637 &`*size_reject                `&  rejection because too big
38638 &`*skip_delivery              `&  delivery skipped in a queue run
38639 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38640 &` smtp_connection            `&  incoming SMTP connections
38641 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38642 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38643 &` smtp_no_mail               `&  session with no MAIL commands
38644 &` smtp_protocol_error        `&  SMTP protocol errors
38645 &` smtp_syntax_error          `&  SMTP syntax errors
38646 &` subject                    `&  contents of &'Subject:'& on <= lines
38647 &`*tls_certificate_verified   `&  certificate verification status
38648 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38649 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38650 &` tls_resumption             `&  append * to cipher field
38651 &` tls_sni                    `&  TLS SNI on <= lines
38652 &` unknown_in_list            `&  DNS lookup failed in list match
38653
38654 &` all                        `&  all of the above
38655 .endd
38656 See also the &%slow_lookup_log%& main configuration option,
38657 section &<<SECID99>>&
38658
38659 More details on each of these items follows:
38660
38661 .ilist
38662 .cindex "8BITMIME"
38663 .cindex "log" "8BITMIME"
38664 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38665 which may help in tracking down interoperability issues with ancient MTAs
38666 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38667 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38668 &`7BIT`& and &`8BITMIME`& respectively.
38669 .next
38670 .cindex "&%warn%& ACL verb" "log when skipping"
38671 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38672 its conditions cannot be evaluated, a log line to this effect is written if
38673 this log selector is set.
38674 .next
38675 .cindex "log" "rewriting"
38676 .cindex "rewriting" "logging"
38677 &%address_rewrite%&: This applies both to global rewrites and per-transport
38678 rewrites, but not to rewrites in filters run as an unprivileged user (because
38679 such users cannot access the log).
38680 .next
38681 .cindex "log" "full parentage"
38682 &%all_parents%&: Normally only the original and final addresses are logged on
38683 delivery lines; with this selector, intermediate parents are given in
38684 parentheses between them.
38685 .next
38686 .cindex "log" "Exim arguments"
38687 .cindex "Exim arguments, logging"
38688 &%arguments%&: This causes Exim to write the arguments with which it was called
38689 to the main log, preceded by the current working directory. This is a debugging
38690 feature, added to make it easier to find out how certain MUAs call
38691 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38692 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38693 that are empty or that contain white space are quoted. Non-printing characters
38694 are shown as escape sequences. This facility cannot log unrecognized arguments,
38695 because the arguments are checked before the configuration file is read. The
38696 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38697 between the caller and Exim.
38698 .next
38699 .cindex "log" "connection rejections"
38700 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38701 connection is rejected, for whatever reason.
38702 .next
38703 .cindex "log" "delayed delivery"
38704 .cindex "delayed delivery, logging"
38705 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38706 started for an incoming message because the load is too high or too many
38707 messages were received on one connection. Logging does not occur if no delivery
38708 process is started because &%queue_only%& is set or &%-odq%& was used.
38709 .next
38710 .cindex "log" "delivery duration"
38711 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38712 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38713 If millisecond logging is enabled, short times will be shown with greater
38714 precision, eg. &`DT=0.304s`&.
38715 .next
38716 .cindex "log" "message size on delivery"
38717 .cindex "size" "of message"
38718 &%delivery_size%&: For each delivery, the size of message delivered is added to
38719 the &"=>"& line, tagged with S=.
38720 .next
38721 .cindex log "DKIM verification"
38722 .cindex DKIM "verification logging"
38723 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38724 verifies successfully a tag of DKIM is added, with one of the verified domains.
38725 .next
38726 .cindex log "DKIM verification"
38727 .cindex DKIM "verification logging"
38728 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38729 .next
38730 .cindex "log" "dnslist defer"
38731 .cindex "DNS list" "logging defer"
38732 .cindex "black list (DNS)"
38733 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38734 DNS black list suffers a temporary error.
38735 .next
38736 .cindex log dnssec
38737 .cindex dnssec logging
38738 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38739 dns lookups gave secure results a tag of DS is added.
38740 For acceptance this covers the reverse and forward lookups for host name verification.
38741 It does not cover helo-name verification.
38742 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38743 .next
38744 .cindex "log" "ETRN commands"
38745 .cindex "ETRN" "logging"
38746 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38747 is run to determine whether or not it is actually accepted. An invalid ETRN
38748 command, or one received within a message transaction is not logged by this
38749 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38750 .next
38751 .cindex "log" "host lookup failure"
38752 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38753 any addresses, or when a lookup of an IP address fails to find a host name, a
38754 log line is written. This logging does not apply to direct DNS lookups when
38755 routing email addresses, but it does apply to &"byname"& lookups.
38756 .next
38757 .cindex "log" "ident timeout"
38758 .cindex "RFC 1413" "logging timeout"
38759 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38760 client's ident port times out.
38761 .next
38762 .cindex "log" "incoming interface"
38763 .cindex "log" "outgoing interface"
38764 .cindex "log" "local interface"
38765 .cindex "log" "local address and port"
38766 .cindex "TCP/IP" "logging local address and port"
38767 .cindex "interface" "logging"
38768 &%incoming_interface%&: The interface on which a message was received is added
38769 to the &"<="& line as an IP address in square brackets, tagged by I= and
38770 followed by a colon and the port number. The local interface and port are also
38771 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38772 rejection lines, and (despite the name) to outgoing
38773 .new
38774 &"=>"&, &"->"&, &"=="& and &"**"& lines.
38775 .wen
38776 The latter can be disabled by turning off the &%outgoing_interface%& option.
38777 .next
38778 .cindex log "incoming proxy address"
38779 .cindex proxy "logging proxy address"
38780 .cindex "TCP/IP" "logging proxy address"
38781 &%proxy%&: The internal (closest to the system running Exim) IP address
38782 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38783 on a proxied connection
38784 or the &"=>"& line for a message delivered on a proxied connection.
38785 See &<<SECTproxyInbound>>& for more information.
38786 .next
38787 .cindex "log" "incoming remote port"
38788 .cindex "port" "logging remote"
38789 .cindex "TCP/IP" "logging incoming remote port"
38790 .vindex "&$sender_fullhost$&"
38791 .vindex "&$sender_rcvhost$&"
38792 &%incoming_port%&: The remote port number from which a message was received is
38793 added to log entries and &'Received:'& header lines, following the IP address
38794 in square brackets, and separated from it by a colon. This is implemented by
38795 changing the value that is put in the &$sender_fullhost$& and
38796 &$sender_rcvhost$& variables. Recording the remote port number has become more
38797 important with the widening use of NAT (see RFC 2505).
38798 .next
38799 .cindex "log" "dropped connection"
38800 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38801 connection is unexpectedly dropped.
38802 .next
38803 .cindex "log" "millisecond timestamps"
38804 .cindex millisecond logging
38805 .cindex timestamps "millisecond, in logs"
38806 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38807 appended to the seconds value.
38808 .next
38809 .cindex "log" "message id"
38810 &%msg_id%&: The value of the Message-ID: header.
38811 .next
38812 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38813 This will be either because the message is a bounce, or was submitted locally
38814 (submission mode) without one.
38815 The field identifier will have an asterix appended: &"id*="&.
38816 .next
38817 .cindex "log" "outgoing interface"
38818 .cindex "log" "local interface"
38819 .cindex "log" "local address and port"
38820 .cindex "TCP/IP" "logging local address and port"
38821 .cindex "interface" "logging"
38822 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38823 interface on which a message was sent is added to delivery lines as an I= tag
38824 followed by IP address in square brackets. You can disable this by turning
38825 off the &%outgoing_interface%& option.
38826 .next
38827 .cindex "log" "outgoing remote port"
38828 .cindex "port" "logging outgoing remote"
38829 .cindex "TCP/IP" "logging outgoing remote port"
38830 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38831 containing => tags) following the IP address.
38832 The local port is also added if &%incoming_interface%& and
38833 &%outgoing_interface%& are both enabled.
38834 This option is not included in the default setting, because for most ordinary
38835 configurations, the remote port number is always 25 (the SMTP port), and the
38836 local port is a random ephemeral port.
38837 .next
38838 .cindex "log" "process ids in"
38839 .cindex "pid (process id)" "in log lines"
38840 &%pid%&: The current process id is added to every log line, in square brackets,
38841 immediately after the time and date.
38842 .next
38843 .cindex log pipelining
38844 .cindex pipelining "logging outgoing"
38845 &%pipelining%&: A field is added to delivery and accept
38846 log lines when the ESMTP PIPELINING extension was used.
38847 The field is a single "L".
38848
38849 On accept lines, where PIPELINING was offered but not used by the client,
38850 the field has a minus appended.
38851
38852 .cindex "pipelining" "early connection"
38853 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38854 accept "L" fields have a period appended if the feature was
38855 offered but not used, or an asterisk appended if used.
38856 Delivery "L" fields have an asterisk appended if used.
38857
38858 .next
38859 .cindex "log" "queue run"
38860 .cindex "queue runner" "logging"
38861 &%queue_run%&: The start and end of every queue run are logged.
38862 .next
38863 .cindex "log" "queue time"
38864 &%queue_time%&: The amount of time the message has been in the queue on the
38865 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38866 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38867 includes reception time as well as the delivery time for the current address.
38868 This means that it may be longer than the difference between the arrival and
38869 delivery log line times, because the arrival log line is not written until the
38870 message has been successfully received.
38871 If millisecond logging is enabled, short times will be shown with greater
38872 precision, eg. &`QT=1.578s`&.
38873 .next
38874 &%queue_time_overall%&: The amount of time the message has been in the queue on
38875 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38876 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38877 message, so it includes reception time as well as the total delivery time.
38878 .next
38879 .cindex "log" "receive duration"
38880 &%receive_time%&: For each message, the amount of real time it has taken to
38881 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38882 If millisecond logging is enabled, short times will be shown with greater
38883 precision, eg. &`RT=0.204s`&.
38884 .next
38885 .cindex "log" "recipients"
38886 &%received_recipients%&: The recipients of a message are listed in the main log
38887 as soon as the message is received. The list appears at the end of the log line
38888 that is written when a message is received, preceded by the word &"for"&. The
38889 addresses are listed after they have been qualified, but before any rewriting
38890 has taken place.
38891 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38892 in the list.
38893 .next
38894 .cindex "log" "sender reception"
38895 &%received_sender%&: The unrewritten original sender of a message is added to
38896 the end of the log line that records the message's arrival, after the word
38897 &"from"& (before the recipients if &%received_recipients%& is also set).
38898 .next
38899 .cindex "log" "header lines for rejection"
38900 &%rejected_header%&: If a message's header has been received at the time a
38901 rejection is written to the reject log, the complete header is added to the
38902 log. Header logging can be turned off individually for messages that are
38903 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38904 .next
38905 .cindex "log" "retry defer"
38906 &%retry_defer%&: A log line is written if a delivery is deferred because a
38907 retry time has not yet been reached. However, this &"retry time not reached"&
38908 message is always omitted from individual message logs after the first delivery
38909 attempt.
38910 .next
38911 .cindex "log" "return path"
38912 &%return_path_on_delivery%&: The return path that is being transmitted with
38913 the message is included in delivery and bounce lines, using the tag P=.
38914 This is omitted if no delivery actually happens, for example, if routing fails,
38915 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38916 .next
38917 .cindex "log" "sender on delivery"
38918 &%sender_on_delivery%&: The message's sender address is added to every delivery
38919 and bounce line, tagged by F= (for &"from"&).
38920 This is the original sender that was received with the message; it is not
38921 necessarily the same as the outgoing return path.
38922 .next
38923 .cindex "log" "sender verify failure"
38924 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38925 gives details of a sender verification failure is not written. Log lines for
38926 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38927 detail is lost.
38928 .next
38929 .cindex "log" "size rejection"
38930 &%size_reject%&: A log line is written whenever a message is rejected because
38931 it is too big.
38932 .next
38933 .cindex "log" "frozen messages; skipped"
38934 .cindex "frozen messages" "logging skipping"
38935 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38936 queue run because it is frozen or because another process is already delivering
38937 it.
38938 .cindex "&""spool file is locked""&"
38939 The message that is written is &"spool file is locked"&.
38940 .next
38941 .cindex "log" "smtp confirmation"
38942 .cindex "SMTP" "logging confirmation"
38943 .cindex "LMTP" "logging confirmation"
38944 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38945 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38946 A number of MTAs (including Exim) return an identifying string in this
38947 response.
38948 .next
38949 .cindex "log" "SMTP connections"
38950 .cindex "SMTP" "logging connections"
38951 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38952 established or closed, unless the connection is from a host that matches
38953 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38954 only when the closure is unexpected.) This applies to connections from local
38955 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38956 dropped in the middle of a message, a log line is always written, whether or
38957 not this selector is set, but otherwise nothing is written at the start and end
38958 of connections unless this selector is enabled.
38959
38960 For TCP/IP connections to an Exim daemon, the current number of connections is
38961 included in the log message for each new connection, but note that the count is
38962 reset if the daemon is restarted.
38963 Also, because connections are closed (and the closure is logged) in
38964 subprocesses, the count may not include connections that have been closed but
38965 whose termination the daemon has not yet noticed. Thus, while it is possible to
38966 match up the opening and closing of connections in the log, the value of the
38967 logged counts may not be entirely accurate.
38968 .next
38969 .cindex "log" "SMTP transaction; incomplete"
38970 .cindex "SMTP" "logging incomplete transactions"
38971 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38972 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38973 and the message sender plus any accepted recipients are included in the log
38974 line. This can provide evidence of dictionary attacks.
38975 .next
38976 .cindex "log" "non-MAIL SMTP sessions"
38977 .cindex "MAIL" "logging session without"
38978 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38979 connection terminates without having issued a MAIL command. This includes both
38980 the case when the connection is dropped, and the case when QUIT is used. It
38981 does not include cases where the connection is rejected right at the start (by
38982 an ACL, or because there are too many connections, or whatever). These cases
38983 already have their own log lines.
38984
38985 The log line that is written contains the identity of the client in the usual
38986 way, followed by D= and a time, which records the duration of the connection.
38987 If the connection was authenticated, this fact is logged exactly as it is for
38988 an incoming message, with an A= item. If the connection was encrypted, CV=,
38989 DN=, and X= items may appear as they do for an incoming message, controlled by
38990 the same logging options.
38991
38992 Finally, if any SMTP commands were issued during the connection, a C= item
38993 is added to the line, listing the commands that were used. For example,
38994 .code
38995 C=EHLO,QUIT
38996 .endd
38997 shows that the client issued QUIT straight after EHLO. If there were fewer
38998 than 20 commands, they are all listed. If there were more than 20 commands,
38999 the last 20 are listed, preceded by &"..."&. However, with the default
39000 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
39001 have been aborted before 20 non-mail commands are processed.
39002 .next
39003 &%smtp_mailauth%&: A third subfield with the authenticated sender,
39004 colon-separated, is appended to the A= item for a message arrival or delivery
39005 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
39006 was accepted or used.
39007 .next
39008 .cindex "log" "SMTP protocol error"
39009 .cindex "SMTP" "logging protocol error"
39010 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
39011 encountered. Exim does not have perfect detection of all protocol errors
39012 because of transmission delays and the use of pipelining. If PIPELINING has
39013 been advertised to a client, an Exim server assumes that the client will use
39014 it, and therefore it does not count &"expected"& errors (for example, RCPT
39015 received after rejecting MAIL) as protocol errors.
39016 .next
39017 .cindex "SMTP" "logging syntax errors"
39018 .cindex "SMTP" "syntax errors; logging"
39019 .cindex "SMTP" "unknown command; logging"
39020 .cindex "log" "unknown SMTP command"
39021 .cindex "log" "SMTP syntax error"
39022 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
39023 encountered. An unrecognized command is treated as a syntax error. For an
39024 external connection, the host identity is given; for an internal connection
39025 using &%-bs%& the sender identification (normally the calling user) is given.
39026 .next
39027 .cindex "log" "subject"
39028 .cindex "subject, logging"
39029 &%subject%&: The subject of the message is added to the arrival log line,
39030 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
39031 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
39032 specifies whether characters with values greater than 127 should be logged
39033 unchanged, or whether they should be rendered as escape sequences.
39034 .next
39035 .cindex "log" "certificate verification"
39036 .cindex log DANE
39037 .cindex DANE logging
39038 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
39039 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
39040 verified
39041 using a CA trust anchor,
39042 &`CV=dane`& if using a DNS trust anchor,
39043 and &`CV=no`& if not.
39044 .next
39045 .cindex "log" "TLS cipher"
39046 .cindex "TLS" "logging cipher"
39047 &%tls_cipher%&: When a message is sent or received over an encrypted
39048 connection, the cipher suite used is added to the log line, preceded by X=.
39049 .next
39050 .cindex "log" "TLS peer DN"
39051 .cindex "TLS" "logging peer DN"
39052 &%tls_peerdn%&: When a message is sent or received over an encrypted
39053 connection, and a certificate is supplied by the remote host, the peer DN is
39054 added to the log line, preceded by DN=.
39055 .next
39056 .cindex "log" "TLS resumption"
39057 .cindex "TLS" "logging session resumption"
39058 .new
39059 &%tls_resumption%&: When a message is sent or received over an encrypted
39060 connection and the TLS session resumed one used on a previous TCP connection,
39061 an asterisk is appended to the X= cipher field in the log line.
39062 .wen
39063 .next
39064 .cindex "log" "TLS SNI"
39065 .cindex "TLS" "logging SNI"
39066 .cindex SNI logging
39067 &%tls_sni%&: When a message is received over an encrypted connection, and
39068 the remote host provided the Server Name Indication extension, the SNI is
39069 added to the log line, preceded by SNI=.
39070 .next
39071 .cindex "log" "DNS failure in list"
39072 &%unknown_in_list%&: This setting causes a log entry to be written when the
39073 result of a list match is failure because a DNS lookup failed.
39074 .endlist
39075
39076
39077 .section "Message log" "SECID260"
39078 .cindex "message" "log file for"
39079 .cindex "log" "message log; description of"
39080 .cindex "&_msglog_& directory"
39081 .oindex "&%preserve_message_logs%&"
39082 In addition to the general log files, Exim writes a log file for each message
39083 that it handles. The names of these per-message logs are the message ids, and
39084 they are kept in the &_msglog_& sub-directory of the spool directory. Each
39085 message log contains copies of the log lines that apply to the message. This
39086 makes it easier to inspect the status of an individual message without having
39087 to search the main log. A message log is deleted when processing of the message
39088 is complete, unless &%preserve_message_logs%& is set, but this should be used
39089 only with great care because they can fill up your disk very quickly.
39090
39091 On a heavily loaded system, it may be desirable to disable the use of
39092 per-message logs, in order to reduce disk I/O. This can be done by setting the
39093 &%message_logs%& option false.
39094 .ecindex IIDloggen
39095
39096
39097
39098
39099 . ////////////////////////////////////////////////////////////////////////////
39100 . ////////////////////////////////////////////////////////////////////////////
39101
39102 .chapter "Exim utilities" "CHAPutils"
39103 .scindex IIDutils "utilities"
39104 A number of utility scripts and programs are supplied with Exim and are
39105 described in this chapter. There is also the Exim Monitor, which is covered in
39106 the next chapter. The utilities described here are:
39107
39108 .itable none 0 0 3  7* left  15* left  40* left
39109 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
39110   "list what Exim processes are doing"
39111 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
39112 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
39113 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
39114 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
39115                                                 various criteria"
39116 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
39117 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
39118   "extract statistics from the log"
39119 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
39120   "check address acceptance from given IP"
39121 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
39122 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
39123 .irow &<<SECTdumpdb>>&        &'exim_dumpdb'&   "dump a hints database"
39124 .irow &<<SECTtidydb>>&        &'exim_tidydb'&   "clean up a hints database"
39125 .irow &<<SECTfixdb>>&         &'exim_fixdb'&    "patch a hints database"
39126 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
39127 .endtable
39128
39129 Another utility that might be of use to sites with many MTAs is Tom Kistner's
39130 &'exilog'&. It provides log visualizations across multiple Exim servers. See
39131 &url(https://duncanthrax.net/exilog/) for details.
39132
39133
39134
39135
39136 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
39137 .cindex "&'exiwhat'&"
39138 .cindex "process, querying"
39139 .cindex "SIGUSR1"
39140 On operating systems that can restart a system call after receiving a signal
39141 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
39142 a line describing what it is doing to the file &_exim-process.info_& in the
39143 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
39144 processes it can find, having first emptied the file. It then waits for one
39145 second to allow the Exim processes to react before displaying the results. In
39146 order to run &'exiwhat'& successfully you have to have sufficient privilege to
39147 send the signal to the Exim processes, so it is normally run as root.
39148
39149 &*Warning*&: This is not an efficient process. It is intended for occasional
39150 use by system administrators. It is not sensible, for example, to set up a
39151 script that sends SIGUSR1 signals to Exim processes at short intervals.
39152
39153
39154 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
39155 varies in different operating systems. Not only are different options used,
39156 but the format of the output is different. For this reason, there are some
39157 system configuration options that configure exactly how &'exiwhat'& works. If
39158 it doesn't seem to be working for you, check the following compile-time
39159 options:
39160 .display
39161 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
39162 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
39163 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
39164 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
39165 .endd
39166 An example of typical output from &'exiwhat'& is
39167 .code
39168 164 daemon: -q1h, listening on port 25
39169 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
39170 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
39171   [10.19.42.42] (editor@ref.example)
39172 10592 handling incoming call from [192.168.243.242]
39173 10628 accepting a local non-SMTP message
39174 .endd
39175 The first number in the output line is the process number. The third line has
39176 been split here, in order to fit it on the page.
39177
39178
39179
39180 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
39181 .cindex "&'exiqgrep'&"
39182 .cindex "queue" "grepping"
39183 This utility is a Perl script contributed by Matt Hubbard. It runs
39184 .code
39185 exim -bpu
39186 .endd
39187 or (in case &*-a*& switch is specified)
39188 .code
39189 exim -bp
39190 .endd
39191 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
39192 contain alternate exim configuration the queue management might be using.
39193
39194 to obtain a queue listing, and then greps the output to select messages
39195 that match given criteria. The following selection options are available:
39196
39197 .vlist
39198 .vitem &*-f*&&~<&'regex'&>
39199 Match the sender address using a case-insensitive search. The field that is
39200 tested is enclosed in angle brackets, so you can test for bounce messages with
39201 .code
39202 exiqgrep -f '^<>$'
39203 .endd
39204 .vitem &*-r*&&~<&'regex'&>
39205 Match a recipient address using a case-insensitive search. The field that is
39206 tested is not enclosed in angle brackets.
39207
39208 .vitem &*-s*&&~<&'regex'&>
39209 Match against the size field.
39210
39211 .vitem &*-y*&&~<&'seconds'&>
39212 Match messages that are younger than the given time.
39213
39214 .vitem &*-o*&&~<&'seconds'&>
39215 Match messages that are older than the given time.
39216
39217 .vitem &*-z*&
39218 Match only frozen messages.
39219
39220 .vitem &*-x*&
39221 Match only non-frozen messages.
39222
39223 .vitem &*-G*&&~<&'queuename'&>
39224 Match only messages in the given queue.  Without this, the default queue is searched.
39225 .endlist
39226
39227 The following options control the format of the output:
39228
39229 .vlist
39230 .vitem &*-c*&
39231 Display only the count of matching messages.
39232
39233 .vitem &*-l*&
39234 Long format &-- display the full message information as output by Exim. This is
39235 the default.
39236
39237 .vitem &*-i*&
39238 Display message ids only.
39239
39240 .vitem &*-b*&
39241 Brief format &-- one line per message.
39242
39243 .vitem &*-R*&
39244 Display messages in reverse order.
39245
39246 .vitem &*-a*&
39247 Include delivered recipients in queue listing.
39248 .endlist
39249
39250 There is one more option, &%-h%&, which outputs a list of options.
39251
39252
39253
39254 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
39255 .cindex "&'exiqsumm'&"
39256 .cindex "queue" "summary"
39257 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
39258 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
39259 running a command such as
39260 .code
39261 exim -bp | exiqsumm
39262 .endd
39263 The output consists of one line for each domain that has messages waiting for
39264 it, as in the following example:
39265 .code
39266 3   2322   74m   66m  msn.com.example
39267 .endd
39268 Each line lists the number of pending deliveries for a domain, their total
39269 volume, and the length of time that the oldest and the newest messages have
39270 been waiting. Note that the number of pending deliveries is greater than the
39271 number of messages when messages have more than one recipient.
39272
39273 A summary line is output at the end. By default the output is sorted on the
39274 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
39275 the output to be sorted by oldest message and by count of messages,
39276 respectively. There are also three options that split the messages for each
39277 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
39278 separates frozen messages, and &%-s%& separates messages according to their
39279 sender.
39280
39281 The output of &'exim -bp'& contains the original addresses in the message, so
39282 this also applies to the output from &'exiqsumm'&. No domains from addresses
39283 generated by aliasing or forwarding are included (unless the &%one_time%&
39284 option of the &(redirect)& router has been used to convert them into &"top
39285 level"& addresses).
39286
39287
39288
39289
39290 .section "Extracting specific information from the log (exigrep)" &&&
39291          "SECTextspeinf"
39292 .cindex "&'exigrep'&"
39293 .cindex "log" "extracts; grepping for"
39294 The &'exigrep'& utility is a Perl script that searches one or more main log
39295 files for entries that match a given pattern. When it finds a match, it
39296 extracts all the log entries for the relevant message, not just those that
39297 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
39298 given message, or all mail for a given user, or for a given host, for example.
39299 The input files can be in Exim log format or syslog format.
39300 If a matching log line is not associated with a specific message, it is
39301 included in &'exigrep'&'s output without any additional lines. The usage is:
39302 .display
39303 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
39304 .endd
39305 If no log filenames are given on the command line, the standard input is read.
39306
39307 The &%-t%& argument specifies a number of seconds. It adds an additional
39308 condition for message selection. Messages that are complete are shown only if
39309 they spent more than <&'n'&> seconds in the queue.
39310
39311 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
39312 makes it case-sensitive. This may give a performance improvement when searching
39313 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
39314 option; with &%-I%& they do not. In both cases it is possible to change the
39315 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
39316
39317 The &%-l%& option means &"literal"&, that is, treat all characters in the
39318 pattern as standing for themselves. Otherwise the pattern must be a Perl
39319 regular expression.
39320
39321 The &%-v%& option inverts the matching condition. That is, a line is selected
39322 if it does &'not'& match the pattern.
39323
39324 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
39325 that are generated as a result/response to a message that &'exigrep'& matched
39326 normally.
39327
39328 Example of &%-M%&:
39329 user_a sends a message to user_b, which generates a bounce back to user_b. If
39330 &'exigrep'& is used to search for &"user_a"&, only the first message will be
39331 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
39332 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
39333 when searching for &"user_a"& will show both messages since the bounce is
39334 &"related"& to or a &"result"& of the first message that was found by the
39335 search term.
39336
39337 If the location of a &'zcat'& command is known from the definition of
39338 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
39339 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
39340 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
39341 autodetection of some well known compression extensions.
39342
39343
39344 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
39345 .cindex "&'exipick'&"
39346 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
39347 lists messages from the queue according to a variety of criteria. For details
39348 of &'exipick'&'s facilities, run &'exipick'& with
39349 the &%--help%& option.
39350
39351
39352 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
39353 .cindex "log" "cycling local files"
39354 .cindex "cycling logs"
39355 .cindex "&'exicyclog'&"
39356 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
39357 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
39358 you are using log files with datestamps in their names (see section
39359 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
39360 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
39361 There are two command line options for &'exicyclog'&:
39362 .ilist
39363 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
39364 default that is set when Exim is built. The default default is 10.
39365 .next
39366 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
39367 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
39368 overriding the script's default, which is to find the setting from Exim's
39369 configuration.
39370 .endlist
39371
39372 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
39373 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
39374 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
39375 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
39376 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
39377 logs are handled similarly.
39378
39379 If the limit is greater than 99, the script uses 3-digit numbers such as
39380 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
39381 to one that is greater, or &'vice versa'&, you will have to fix the names of
39382 any existing log files.
39383
39384 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
39385 the end are deleted. All files with numbers greater than 01 are compressed,
39386 using a compression command which is configured by the COMPRESS_COMMAND
39387 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
39388 root &%crontab%& entry of the form
39389 .code
39390 1 0 * * * su exim -c /usr/exim/bin/exicyclog
39391 .endd
39392 assuming you have used the name &"exim"& for the Exim user. You can run
39393 &'exicyclog'& as root if you wish, but there is no need.
39394
39395
39396
39397 .section "Mail statistics (eximstats)" "SECTmailstat"
39398 .cindex "statistics"
39399 .cindex "&'eximstats'&"
39400 A Perl script called &'eximstats'& is provided for extracting statistical
39401 information from log files. The output is either plain text, or HTML.
39402 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
39403 . --- 404 error and everything else points to that.
39404
39405 The &'eximstats'& script has been hacked about quite a bit over time. The
39406 latest version is the result of some extensive revision by Steve Campbell. A
39407 lot of information is given by default, but there are options for suppressing
39408 various parts of it. Following any options, the arguments to the script are a
39409 list of files, which should be main log files. For example:
39410 .code
39411 eximstats -nr /var/spool/exim/log/mainlog.01
39412 .endd
39413 By default, &'eximstats'& extracts information about the number and volume of
39414 messages received from or delivered to various hosts. The information is sorted
39415 both by message count and by volume, and the top fifty hosts in each category
39416 are listed on the standard output. Similar information, based on email
39417 addresses or domains instead of hosts can be requested by means of various
39418 options. For messages delivered and received locally, similar statistics are
39419 also produced per user.
39420
39421 The output also includes total counts and statistics about delivery errors, and
39422 histograms showing the number of messages received and deliveries made in each
39423 hour of the day. A delivery with more than one address in its envelope (for
39424 example, an SMTP transaction with more than one RCPT command) is counted
39425 as a single delivery by &'eximstats'&.
39426
39427 Though normally more deliveries than receipts are reported (as messages may
39428 have multiple recipients), it is possible for &'eximstats'& to report more
39429 messages received than delivered, even though the queue is empty at the start
39430 and end of the period in question. If an incoming message contains no valid
39431 recipients, no deliveries are recorded for it. A bounce message is handled as
39432 an entirely separate message.
39433
39434 &'eximstats'& always outputs a grand total summary giving the volume and number
39435 of messages received and deliveries made, and the number of hosts involved in
39436 each case. It also outputs the number of messages that were delayed (that is,
39437 not completely delivered at the first attempt), and the number that had at
39438 least one address that failed.
39439
39440 The remainder of the output is in sections that can be independently disabled
39441 or modified by various options. It consists of a summary of deliveries by
39442 transport, histograms of messages received and delivered per time interval
39443 (default per hour), information about the time messages spent in the queue,
39444 a list of relayed messages, lists of the top fifty sending hosts, local
39445 senders, destination hosts, and destination local users by count and by volume,
39446 and a list of delivery errors that occurred.
39447
39448 The relay information lists messages that were actually relayed, that is, they
39449 came from a remote host and were directly delivered to some other remote host,
39450 without being processed (for example, for aliasing or forwarding) locally.
39451
39452 There are quite a few options for &'eximstats'& to control exactly what it
39453 outputs. These are documented in the Perl script itself, and can be extracted
39454 by running the command &(perldoc)& on the script. For example:
39455 .code
39456 perldoc /usr/exim/bin/eximstats
39457 .endd
39458
39459 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39460 .cindex "&'exim_checkaccess'&"
39461 .cindex "policy control" "checking access"
39462 .cindex "checking access"
39463 The &%-bh%& command line argument allows you to run a fake SMTP session with
39464 debugging output, in order to check what Exim is doing when it is applying
39465 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39466 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39467 sometimes you just want to answer the question &"Does this address have
39468 access?"& without bothering with any further details.
39469
39470 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39471 two arguments, an IP address and an email address:
39472 .code
39473 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39474 .endd
39475 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39476 given email address would be accepted in a RCPT command in a TCP/IP
39477 connection from the host with the given IP address. The output of the utility
39478 is either the word &"accepted"&, or the SMTP error response, for example:
39479 .code
39480 Rejected:
39481 550 Relay not permitted
39482 .endd
39483 When running this test, the utility uses &`<>`& as the envelope sender address
39484 for the MAIL command, but you can change this by providing additional
39485 options. These are passed directly to the Exim command. For example, to specify
39486 that the test is to be run with the sender address &'himself@there.example'&
39487 you can use:
39488 .code
39489 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39490                  -f himself@there.example
39491 .endd
39492 Note that these additional Exim command line items must be given after the two
39493 mandatory arguments.
39494
39495 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39496 while running its checks. You can run checks that include callouts by using
39497 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39498
39499
39500
39501 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39502 .cindex "DBM" "building dbm files"
39503 .cindex "building DBM files"
39504 .cindex "&'exim_dbmbuild'&"
39505 .cindex "lower casing"
39506 .cindex "binary zero" "in lookup key"
39507 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39508 the format used by the &(lsearch)& lookup (see section
39509 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39510 names as keys and the remainder of the information as data. The lower-casing
39511 can be prevented by calling the program with the &%-nolc%& option.
39512
39513 A terminating zero is included as part of the key string. This is expected by
39514 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39515 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39516 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39517 files.
39518
39519 The program requires two arguments: the name of the input file (which can be a
39520 single hyphen to indicate the standard input), and the name of the output file.
39521 It creates the output under a temporary name, and then renames it if all went
39522 well.
39523
39524 .cindex "USE_DB"
39525 If the native DB interface is in use (USE_DB is set in a compile-time
39526 configuration file &-- this is common in free versions of Unix) the two
39527 filenames must be different, because in this mode the Berkeley DB functions
39528 create a single output file using exactly the name given. For example,
39529 .code
39530 exim_dbmbuild /etc/aliases /etc/aliases.db
39531 .endd
39532 reads the system alias file and creates a DBM version of it in
39533 &_/etc/aliases.db_&.
39534
39535 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39536 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39537 environment, the suffixes are added to the second argument of
39538 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39539 when the Berkeley functions are used in compatibility mode (though this is not
39540 recommended), because in that case it adds a &_.db_& suffix to the filename.
39541
39542 If a duplicate key is encountered, the program outputs a warning, and when it
39543 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39544 option is used. By default, only the first of a set of duplicates is used &--
39545 this makes it compatible with &(lsearch)& lookups. There is an option
39546 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39547 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39548 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39549 return code is 2.
39550
39551
39552
39553
39554 .section "Finding individual retry times (exinext)" "SECTfinindret"
39555 .cindex "retry" "times"
39556 .cindex "&'exinext'&"
39557 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39558 fish specific information out of the retry database. Given a mail domain (or a
39559 complete address), it looks up the hosts for that domain, and outputs any retry
39560 information for the hosts or for the domain. At present, the retry information
39561 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39562 output. For example:
39563 .code
39564 $ exinext piglet@milne.fict.example
39565 kanga.milne.example:192.168.8.1 error 146: Connection refused
39566   first failed: 21-Feb-1996 14:57:34
39567   last tried:   21-Feb-1996 14:57:34
39568   next try at:  21-Feb-1996 15:02:34
39569 roo.milne.example:192.168.8.3 error 146: Connection refused
39570   first failed: 20-Jan-1996 13:12:08
39571   last tried:   21-Feb-1996 11:42:03
39572   next try at:  21-Feb-1996 19:42:03
39573   past final cutoff time
39574 .endd
39575 You can also give &'exinext'& a local part, without a domain, and it
39576 will give any retry information for that local part in your default domain.
39577 A message id can be used to obtain retry information pertaining to a specific
39578 message. This exists only when an attempt to deliver a message to a remote host
39579 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39580 &'exinext'& is not particularly efficient, but then it is not expected to be
39581 run very often.
39582
39583 The &'exinext'& utility calls Exim to find out information such as the location
39584 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39585 passed on to the &'exim'& commands. The first specifies an alternate Exim
39586 configuration file, and the second sets macros for use within the configuration
39587 file. These features are mainly to help in testing, but might also be useful in
39588 environments where more than one configuration file is in use.
39589
39590
39591
39592 .section "Hints database maintenance" "SECThindatmai"
39593 .cindex "hints database" "maintenance"
39594 .cindex "maintaining Exim's hints database"
39595 Three utility programs are provided for maintaining the DBM files that Exim
39596 uses to contain its delivery hint information. Each program requires two
39597 arguments. The first specifies the name of Exim's spool directory, and the
39598 second is the name of the database it is to operate on. These are as follows:
39599
39600 .ilist
39601 &'retry'&: the database of retry information
39602 .next
39603 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39604 for remote hosts
39605 .next
39606 &'callout'&: the callout cache
39607 .next
39608 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39609 .next
39610 .new
39611 &'tls'&: TLS session resumption data
39612 .wen
39613 .next
39614 &'misc'&: other hints data
39615 .endlist
39616
39617 The &'misc'& database is used for
39618
39619 .ilist
39620 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39621 .next
39622 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39623 &(smtp)& transport)
39624 .next
39625 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39626 in a transport)
39627 .endlist
39628
39629
39630
39631 .section "exim_dumpdb" "SECTdumpdb"
39632 .cindex "&'exim_dumpdb'&"
39633 The entire contents of a database are written to the standard output by the
39634 &'exim_dumpdb'& program, which has no options or arguments other than the
39635 spool and database names. For example, to dump the retry database:
39636 .code
39637 exim_dumpdb /var/spool/exim retry
39638 .endd
39639 Two lines of output are produced for each entry:
39640 .code
39641 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39642 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39643 .endd
39644 The first item on the first line is the key of the record. It starts with one
39645 of the letters R, or T, depending on whether it refers to a routing or
39646 transport retry. For a local delivery, the next part is the local address; for
39647 a remote delivery it is the name of the remote host, followed by its failing IP
39648 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39649 transport). If the remote port is not the standard one (port 25), it is added
39650 to the IP address. Then there follows an error code, an additional error code,
39651 and a textual description of the error.
39652
39653 The three times on the second line are the time of first failure, the time of
39654 the last delivery attempt, and the computed time for the next attempt. The line
39655 ends with an asterisk if the cutoff time for the last retry rule has been
39656 exceeded.
39657
39658 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39659 consists of a host name followed by a list of ids for messages that are or were
39660 waiting to be delivered to that host. If there are a very large number for any
39661 one host, continuation records, with a sequence number added to the host name,
39662 may be seen. The data in these records is often out of date, because a message
39663 may be routed to several alternative hosts, and Exim makes no effort to keep
39664 cross-references.
39665
39666
39667
39668 .section "exim_tidydb" "SECTtidydb"
39669 .cindex "&'exim_tidydb'&"
39670 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39671 database. If run with no options, it removes all records that are more than 30
39672 days old. The age is calculated from the date and time that the record was last
39673 updated. Note that, in the case of the retry database, it is &'not'& the time
39674 since the first delivery failure. Information about a host that has been down
39675 for more than 30 days will remain in the database, provided that the record is
39676 updated sufficiently often.
39677
39678 The cutoff date can be altered by means of the &%-t%& option, which must be
39679 followed by a time. For example, to remove all records older than a week from
39680 the retry database:
39681 .code
39682 exim_tidydb -t 7d /var/spool/exim retry
39683 .endd
39684 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39685 message ids. In the former these appear as data in records keyed by host &--
39686 they were messages that were waiting for that host &-- and in the latter they
39687 are the keys for retry information for messages that have suffered certain
39688 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39689 message ids in database records are those of messages that are still on the
39690 queue. Message ids for messages that no longer exist are removed from
39691 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39692 For the &'retry'& database, records whose keys are non-existent message ids are
39693 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39694 whenever it removes information from the database.
39695
39696 Certain records are automatically removed by Exim when they are no longer
39697 needed, but others are not. For example, if all the MX hosts for a domain are
39698 down, a retry record is created for each one. If the primary MX host comes back
39699 first, its record is removed when Exim successfully delivers to it, but the
39700 records for the others remain because Exim has not tried to use those hosts.
39701
39702 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39703 hints databases. You should do this at a quiet time of day, because it requires
39704 a database to be locked (and therefore inaccessible to Exim) while it does its
39705 work. Removing records from a DBM file does not normally make the file smaller,
39706 but all the common DBM libraries are able to re-use the space that is released.
39707 After an initial phase of increasing in size, the databases normally reach a
39708 point at which they no longer get any bigger, as long as they are regularly
39709 tidied.
39710
39711 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39712 databases is likely to keep on increasing.
39713
39714
39715
39716
39717 .section "exim_fixdb" "SECTfixdb"
39718 .cindex "&'exim_fixdb'&"
39719 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39720 Its main use is for testing Exim, but it might also be occasionally useful for
39721 getting round problems in a live system. It has no options, and its interface
39722 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39723 key of a database record can then be entered, and the data for that record is
39724 displayed.
39725
39726 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39727 except the &'retry'& database, that is the only operation that can be carried
39728 out. For the &'retry'& database, each field is output preceded by a number, and
39729 data for individual fields can be changed by typing the field number followed
39730 by new data, for example:
39731 .code
39732 > 4 951102:1000
39733 .endd
39734 resets the time of the next delivery attempt. Time values are given as a
39735 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39736 used as optional separators.
39737
39738
39739
39740
39741 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39742 .cindex "mailbox" "maintenance"
39743 .cindex "&'exim_lock'&"
39744 .cindex "locking mailboxes"
39745 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39746 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39747 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39748 a user agent while investigating a problem. The utility requires the name of
39749 the file as its first argument. If the locking is successful, the second
39750 argument is run as a command (using C's &[system()]& function); if there is no
39751 second argument, the value of the SHELL environment variable is used; if this
39752 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39753 is unlocked and the utility ends. The following options are available:
39754
39755 .vlist
39756 .vitem &%-fcntl%&
39757 Use &[fcntl()]& locking on the open mailbox.
39758
39759 .vitem &%-flock%&
39760 Use &[flock()]& locking on the open mailbox, provided the operating system
39761 supports it.
39762
39763 .vitem &%-interval%&
39764 This must be followed by a number, which is a number of seconds; it sets the
39765 interval to sleep between retries (default 3).
39766
39767 .vitem &%-lockfile%&
39768 Create a lock file before opening the mailbox.
39769
39770 .vitem &%-mbx%&
39771 Lock the mailbox using MBX rules.
39772
39773 .vitem &%-q%&
39774 Suppress verification output.
39775
39776 .vitem &%-retries%&
39777 This must be followed by a number; it sets the number of times to try to get
39778 the lock (default 10).
39779
39780 .vitem &%-restore_time%&
39781 This option causes &%exim_lock%& to restore the modified and read times to the
39782 locked file before exiting. This allows you to access a locked mailbox (for
39783 example, to take a backup copy) without disturbing the times that the user
39784 subsequently sees.
39785
39786 .vitem &%-timeout%&
39787 This must be followed by a number, which is a number of seconds; it sets a
39788 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39789 default), a non-blocking call is used.
39790
39791 .vitem &%-v%&
39792 Generate verbose output.
39793 .endlist
39794
39795 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39796 default is to create a lock file and also to use &[fcntl()]& locking on the
39797 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39798 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39799 requires that the directory containing the file be writeable. Locking by lock
39800 file does not last forever; Exim assumes that a lock file is expired if it is
39801 more than 30 minutes old.
39802
39803 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39804 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39805 to be taken out on the open mailbox, and an exclusive lock on the file
39806 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39807 number of the mailbox file. When the locking is released, if an exclusive lock
39808 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39809
39810 The default output contains verification of the locking that takes place. The
39811 &%-v%& option causes some additional information to be given. The &%-q%& option
39812 suppresses all output except error messages.
39813
39814 A command such as
39815 .code
39816 exim_lock /var/spool/mail/spqr
39817 .endd
39818 runs an interactive shell while the file is locked, whereas
39819 .display
39820 &`exim_lock -q /var/spool/mail/spqr <<End`&
39821 <&'some commands'&>
39822 &`End`&
39823 .endd
39824 runs a specific non-interactive sequence of commands while the file is locked,
39825 suppressing all verification output. A single command can be run by a command
39826 such as
39827 .code
39828 exim_lock -q /var/spool/mail/spqr \
39829   "cp /var/spool/mail/spqr /some/where"
39830 .endd
39831 Note that if a command is supplied, it must be entirely contained within the
39832 second argument &-- hence the quotes.
39833 .ecindex IIDutils
39834
39835
39836 . ////////////////////////////////////////////////////////////////////////////
39837 . ////////////////////////////////////////////////////////////////////////////
39838
39839 .chapter "The Exim monitor" "CHAPeximon"
39840 .scindex IIDeximon "Exim monitor" "description"
39841 .cindex "X-windows"
39842 .cindex "&'eximon'&"
39843 .cindex "Local/eximon.conf"
39844 .cindex "&_exim_monitor/EDITME_&"
39845 The Exim monitor is an application which displays in an X window information
39846 about the state of Exim's queue and what Exim is doing. An admin user can
39847 perform certain operations on messages from this GUI interface; however all
39848 such facilities are also available from the command line, and indeed, the
39849 monitor itself makes use of the command line to perform any actions requested.
39850
39851
39852
39853 .section "Running the monitor" "SECID264"
39854 The monitor is started by running the script called &'eximon'&. This is a shell
39855 script that sets up a number of environment variables, and then runs the
39856 binary called &_eximon.bin_&. The default appearance of the monitor window can
39857 be changed by editing the &_Local/eximon.conf_& file created by editing
39858 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39859 parameters are for.
39860
39861 The parameters that get built into the &'eximon'& script can be overridden for
39862 a particular invocation by setting up environment variables of the same names,
39863 preceded by &`EXIMON_`&. For example, a shell command such as
39864 .code
39865 EXIMON_LOG_DEPTH=400 eximon
39866 .endd
39867 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39868 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39869 overrides the Exim log file configuration. This makes it possible to have
39870 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39871 syslog messages are routed to a file on the local host.
39872
39873 X resources can be used to change the appearance of the window in the normal
39874 way. For example, a resource setting of the form
39875 .code
39876 Eximon*background: gray94
39877 .endd
39878 changes the colour of the background to light grey rather than white. The
39879 stripcharts are drawn with both the data lines and the reference lines in
39880 black. This means that the reference lines are not visible when on top of the
39881 data. However, their colour can be changed by setting a resource called
39882 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39883 For example, if your X server is running Unix, you could set up lighter
39884 reference lines in the stripcharts by obeying
39885 .code
39886 xrdb -merge <<End
39887 Eximon*highlight: gray
39888 End
39889 .endd
39890 .cindex "admin user"
39891 In order to see the contents of messages in the queue, and to operate on them,
39892 &'eximon'& must either be run as root or by an admin user.
39893
39894 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39895 contain X11 resource parameters interpreted by the X11 library.  In addition,
39896 if the first parameter starts with the string "gdb" then it is removed and the
39897 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39898 versioned variants of gdb can be invoked).
39899
39900 The monitor's window is divided into three parts. The first contains one or
39901 more stripcharts and two action buttons, the second contains a &"tail"& of the
39902 main log file, and the third is a display of the queue of messages awaiting
39903 delivery, with two more action buttons. The following sections describe these
39904 different parts of the display.
39905
39906
39907
39908
39909 .section "The stripcharts" "SECID265"
39910 .cindex "stripchart"
39911 The first stripchart is always a count of messages in the queue. Its name can
39912 be configured by setting QUEUE_STRIPCHART_NAME in the
39913 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39914 configuration script by regular expression matches on log file entries, making
39915 it possible to display, for example, counts of messages delivered to certain
39916 hosts or using certain transports. The supplied defaults display counts of
39917 received and delivered messages, and of local and SMTP deliveries. The default
39918 period between stripchart updates is one minute; this can be adjusted by a
39919 parameter in the &_Local/eximon.conf_& file.
39920
39921 The stripchart displays rescale themselves automatically as the value they are
39922 displaying changes. There are always 10 horizontal lines in each chart; the
39923 title string indicates the value of each division when it is greater than one.
39924 For example, &"x2"& means that each division represents a value of 2.
39925
39926 It is also possible to have a stripchart which shows the percentage fullness of
39927 a particular disk partition, which is useful when local deliveries are confined
39928 to a single partition.
39929
39930 .cindex "&%statvfs%& function"
39931 This relies on the availability of the &[statvfs()]& function or equivalent in
39932 the operating system. Most, but not all versions of Unix that support Exim have
39933 this. For this particular stripchart, the top of the chart always represents
39934 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39935 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39936 &_Local/eximon.conf_& file.
39937
39938
39939
39940
39941 .section "Main action buttons" "SECID266"
39942 .cindex "size" "of monitor window"
39943 .cindex "Exim monitor" "window size"
39944 .cindex "window size"
39945 Below the stripcharts there is an action button for quitting the monitor. Next
39946 to this is another button marked &"Size"&. They are placed here so that
39947 shrinking the window to its default minimum size leaves just the queue count
39948 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39949 the window to expand to its maximum size, unless it is already at the maximum,
39950 in which case it is reduced to its minimum.
39951
39952 When expanding to the maximum, if the window cannot be fully seen where it
39953 currently is, it is moved back to where it was the last time it was at full
39954 size. When it is expanding from its minimum size, the old position is
39955 remembered, and next time it is reduced to the minimum it is moved back there.
39956
39957 The idea is that you can keep a reduced window just showing one or two
39958 stripcharts at a convenient place on your screen, easily expand it to show
39959 the full window when required, and just as easily put it back to what it was.
39960 The idea is copied from what the &'twm'& window manager does for its
39961 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39962 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39963
39964 Normally, the monitor starts up with the window at its full size, but it can be
39965 built so that it starts up with the window at its smallest size, by setting
39966 START_SMALL=yes in &_Local/eximon.conf_&.
39967
39968
39969
39970 .section "The log display" "SECID267"
39971 .cindex "log" "tail of; in monitor"
39972 The second section of the window is an area in which a display of the tail of
39973 the main log is maintained.
39974 To save space on the screen, the timestamp on each log line is shortened by
39975 removing the date and, if &%log_timezone%& is set, the timezone.
39976 The log tail is not available when the only destination for logging data is
39977 syslog, unless the syslog lines are routed to a local file whose name is passed
39978 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39979
39980 The log sub-window has a scroll bar at its lefthand side which can be used to
39981 move back to look at earlier text, and the up and down arrow keys also have a
39982 scrolling effect. The amount of log that is kept depends on the setting of
39983 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39984 to use. When this is full, the earlier 50% of data is discarded &-- this is
39985 much more efficient than throwing it away line by line. The sub-window also has
39986 a horizontal scroll bar for accessing the ends of long log lines. This is the
39987 only means of horizontal scrolling; the right and left arrow keys are not
39988 available. Text can be cut from this part of the window using the mouse in the
39989 normal way. The size of this subwindow is controlled by parameters in the
39990 configuration file &_Local/eximon.conf_&.
39991
39992 Searches of the text in the log window can be carried out by means of the ^R
39993 and ^S keystrokes, which default to a reverse and a forward search,
39994 respectively. The search covers only the text that is displayed in the window.
39995 It cannot go further back up the log.
39996
39997 The point from which the search starts is indicated by a caret marker. This is
39998 normally at the end of the text in the window, but can be positioned explicitly
39999 by pointing and clicking with the left mouse button, and is moved automatically
40000 by a successful search. If new text arrives in the window when it is scrolled
40001 back, the caret remains where it is, but if the window is not scrolled back,
40002 the caret is moved to the end of the new text.
40003
40004 Pressing ^R or ^S pops up a window into which the search text can be typed.
40005 There are buttons for selecting forward or reverse searching, for carrying out
40006 the search, and for cancelling. If the &"Search"& button is pressed, the search
40007 happens and the window remains so that further searches can be done. If the
40008 &"Return"& key is pressed, a single search is done and the window is closed. If
40009 ^C is typed the search is cancelled.
40010
40011 The searching facility is implemented using the facilities of the Athena text
40012 widget. By default this pops up a window containing both &"search"& and
40013 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
40014 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
40015 However, the linkers in BSDI and HP-UX seem unable to handle an externally
40016 provided version of &%TextPop%& when the remaining parts of the text widget
40017 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
40018 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
40019 on these systems, at the expense of having unwanted items in the search popup
40020 window.
40021
40022
40023
40024 .section "The queue display" "SECID268"
40025 .cindex "queue" "display in monitor"
40026 The bottom section of the monitor window contains a list of all messages that
40027 are in the queue, which includes those currently being received or delivered,
40028 as well as those awaiting delivery. The size of this subwindow is controlled by
40029 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
40030 at which it is updated is controlled by another parameter in the same file &--
40031 the default is 5 minutes, since queue scans can be quite expensive. However,
40032 there is an &"Update"& action button just above the display which can be used
40033 to force an update of the queue display at any time.
40034
40035 When a host is down for some time, a lot of pending mail can build up for it,
40036 and this can make it hard to deal with other messages in the queue. To help
40037 with this situation there is a button next to &"Update"& called &"Hide"&. If
40038 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
40039 type anything in here and press &"Return"&, the text is added to a chain of
40040 such texts, and if every undelivered address in a message matches at least one
40041 of the texts, the message is not displayed.
40042
40043 If there is an address that does not match any of the texts, all the addresses
40044 are displayed as normal. The matching happens on the ends of addresses so, for
40045 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
40046 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
40047 has been set up, a button called &"Unhide"& is displayed. If pressed, it
40048 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
40049 a hide request is automatically cancelled after one hour.
40050
40051 While the dialogue box is displayed, you can't press any buttons or do anything
40052 else to the monitor window. For this reason, if you want to cut text from the
40053 queue display to use in the dialogue box, you have to do the cutting before
40054 pressing the &"Hide"& button.
40055
40056 The queue display contains, for each unhidden queued message, the length of
40057 time it has been in the queue, the size of the message, the message id, the
40058 message sender, and the first undelivered recipient, all on one line. If it is
40059 a bounce message, the sender is shown as &"<>"&. If there is more than one
40060 recipient to which the message has not yet been delivered, subsequent ones are
40061 listed on additional lines, up to a maximum configured number, following which
40062 an ellipsis is displayed. Recipients that have already received the message are
40063 not shown.
40064
40065 .cindex "frozen messages" "display"
40066 If a message is frozen, an asterisk is displayed at the left-hand side.
40067
40068 The queue display has a vertical scroll bar, and can also be scrolled by means
40069 of the arrow keys. Text can be cut from it using the mouse in the normal way.
40070 The text searching facilities, as described above for the log window, are also
40071 available, but the caret is always moved to the end of the text when the queue
40072 display is updated.
40073
40074
40075
40076 .section "The queue menu" "SECID269"
40077 .cindex "queue" "menu in monitor"
40078 If the &%shift%& key is held down and the left button is clicked when the mouse
40079 pointer is over the text for any message, an action menu pops up, and the first
40080 line of the queue display for the message is highlighted. This does not affect
40081 any selected text.
40082
40083 If you want to use some other event for popping up the menu, you can set the
40084 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
40085 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
40086 value set in this parameter is a standard X event description. For example, to
40087 run eximon using &%ctrl%& rather than &%shift%& you could use
40088 .code
40089 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
40090 .endd
40091 The title of the menu is the message id, and it contains entries which act as
40092 follows:
40093
40094 .ilist
40095 &'message log'&: The contents of the message log for the message are displayed
40096 in a new text window.
40097 .next
40098 &'headers'&: Information from the spool file that contains the envelope
40099 information and headers is displayed in a new text window. See chapter
40100 &<<CHAPspool>>& for a description of the format of spool files.
40101 .next
40102 &'body'&: The contents of the spool file containing the body of the message are
40103 displayed in a new text window. There is a default limit of 20,000 bytes to the
40104 amount of data displayed. This can be changed by setting the BODY_MAX
40105 option at compile time, or the EXIMON_BODY_MAX option at runtime.
40106 .next
40107 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
40108 delivery of the message. This causes an automatic thaw if the message is
40109 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
40110 a new text window. The delivery is run in a separate process, to avoid holding
40111 up the monitor while the delivery proceeds.
40112 .next
40113 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
40114 that the message be frozen.
40115 .next
40116 .cindex "thawing messages"
40117 .cindex "unfreezing messages"
40118 .cindex "frozen messages" "thawing"
40119 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
40120 that the message be thawed.
40121 .next
40122 .cindex "delivery" "forcing failure"
40123 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
40124 that Exim gives up trying to deliver the message. A bounce message is generated
40125 for any remaining undelivered addresses.
40126 .next
40127 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
40128 that the message be deleted from the system without generating a bounce
40129 message.
40130 .next
40131 &'add recipient'&: A dialog box is displayed into which a recipient address can
40132 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40133 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40134 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40135 causes a call to Exim to be made using the &%-Mar%& option to request that an
40136 additional recipient be added to the message, unless the entry box is empty, in
40137 which case no action is taken.
40138 .next
40139 &'mark delivered'&: A dialog box is displayed into which a recipient address
40140 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
40141 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
40142 Otherwise it must be entered as a fully qualified address. Pressing RETURN
40143 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
40144 recipient address as already delivered, unless the entry box is empty, in which
40145 case no action is taken.
40146 .next
40147 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
40148 mark all recipient addresses as already delivered.
40149 .next
40150 &'edit sender'&: A dialog box is displayed initialized with the current
40151 sender's address. Pressing RETURN causes a call to Exim to be made using the
40152 &%-Mes%& option to replace the sender address, unless the entry box is empty,
40153 in which case no action is taken. If you want to set an empty sender (as in
40154 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
40155 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
40156 the address is qualified with that domain.
40157 .endlist
40158
40159 When a delivery is forced, a window showing the &%-v%& output is displayed. In
40160 other cases when a call to Exim is made, if there is any output from Exim (in
40161 particular, if the command fails) a window containing the command and the
40162 output is displayed. Otherwise, the results of the action are normally apparent
40163 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
40164 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
40165 if no output is generated.
40166
40167 The queue display is automatically updated for actions such as freezing and
40168 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
40169 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
40170 force an update of the display after one of these actions.
40171
40172 In any text window that is displayed as result of a menu action, the normal
40173 cut-and-paste facility is available, and searching can be carried out using ^R
40174 and ^S, as described above for the log tail window.
40175 .ecindex IIDeximon
40176
40177
40178
40179
40180
40181 . ////////////////////////////////////////////////////////////////////////////
40182 . ////////////////////////////////////////////////////////////////////////////
40183
40184 .chapter "Security considerations" "CHAPsecurity"
40185 .scindex IIDsecurcon "security" "discussion of"
40186 This chapter discusses a number of issues concerned with security, some of
40187 which are also covered in other parts of this manual.
40188
40189 For reasons that this author does not understand, some people have promoted
40190 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
40191 existence of this chapter in the documentation. However, the intent of the
40192 chapter is simply to describe the way Exim works in relation to certain
40193 security concerns, not to make any specific claims about the effectiveness of
40194 its security as compared with other MTAs.
40195
40196 What follows is a description of the way Exim is supposed to be. Best efforts
40197 have been made to try to ensure that the code agrees with the theory, but an
40198 absence of bugs can never be guaranteed. Any that are reported will get fixed
40199 as soon as possible.
40200
40201
40202 .section "Building a more &""hardened""& Exim" "SECID286"
40203 .cindex "security" "build-time features"
40204 There are a number of build-time options that can be set in &_Local/Makefile_&
40205 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
40206 Exim administrator who does not have the root password, or by someone who has
40207 penetrated the Exim (but not the root) account. These options are as follows:
40208
40209 .ilist
40210 ALT_CONFIG_PREFIX can be set to a string that is required to match the
40211 start of any filenames used with the &%-C%& option. When it is set, these
40212 filenames are also not allowed to contain the sequence &"/../"&. (However, if
40213 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
40214 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
40215 default setting for &%ALT_CONFIG_PREFIX%&.
40216
40217 If the permitted configuration files are confined to a directory to
40218 which only root has access, this guards against someone who has broken
40219 into the Exim account from running a privileged Exim with an arbitrary
40220 configuration file, and using it to break into other accounts.
40221 .next
40222
40223 If a non-trusted configuration file (i.e. not the default configuration file
40224 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
40225 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
40226 the next item), then root privilege is retained only if the caller of Exim is
40227 root. This locks out the possibility of testing a configuration using &%-C%&
40228 right through message reception and delivery, even if the caller is root. The
40229 reception works, but by that time, Exim is running as the Exim user, so when
40230 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
40231 privilege to be lost. However, root can test reception and delivery using two
40232 separate commands.
40233
40234 .next
40235 The WHITELIST_D_MACROS build option declares some macros to be safe to override
40236 with &%-D%& if the real uid is one of root, the Exim run-time user or the
40237 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
40238 requiring the run-time value supplied to &%-D%& to match a regex that errs on
40239 the restrictive side.  Requiring build-time selection of safe macros is onerous
40240 but this option is intended solely as a transition mechanism to permit
40241 previously-working configurations to continue to work after release 4.73.
40242 .next
40243 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
40244 is disabled.
40245 .next
40246 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
40247 never to be used for any deliveries. This is like the &%never_users%& runtime
40248 option, but it cannot be overridden; the runtime option adds additional users
40249 to the list. The default setting is &"root"&; this prevents a non-root user who
40250 is permitted to modify the runtime file from using Exim as a way to get root.
40251 .endlist
40252
40253
40254
40255 .section "Root privilege" "SECID270"
40256 .cindex "setuid"
40257 .cindex "root privilege"
40258 The Exim binary is normally setuid to root, which means that it gains root
40259 privilege (runs as root) when it starts execution. In some special cases (for
40260 example, when the daemon is not in use and there are no local deliveries), it
40261 may be possible to run Exim setuid to some user other than root. This is
40262 discussed in the next section. However, in most installations, root privilege
40263 is required for two things:
40264
40265 .ilist
40266 To set up a socket connected to the standard SMTP port (25) when initialising
40267 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
40268 not required.
40269 .next
40270 To be able to change uid and gid in order to read users' &_.forward_& files and
40271 perform local deliveries as the receiving user or as specified in the
40272 configuration.
40273 .endlist
40274
40275 It is not necessary to be root to do any of the other things Exim does, such as
40276 receiving messages and delivering them externally over SMTP, and it is
40277 obviously more secure if Exim does not run as root except when necessary.
40278 For this reason, a user and group for Exim to use must be defined in
40279 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
40280 group"&. Their values can be changed by the runtime configuration, though this
40281 is not recommended. Often a user called &'exim'& is used, but some sites use
40282 &'mail'& or another user name altogether.
40283
40284 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
40285 abdication; the process cannot regain root afterwards. Prior to release 4.00,
40286 &[seteuid()]& was used in some circumstances, but this is no longer the case.
40287
40288 After a new Exim process has interpreted its command line options, it changes
40289 uid and gid in the following cases:
40290
40291 .ilist
40292 .oindex "&%-C%&"
40293 .oindex "&%-D%&"
40294 If the &%-C%& option is used to specify an alternate configuration file, or if
40295 the &%-D%& option is used to define macro values for the configuration, and the
40296 calling process is not running as root, the uid and gid are changed to those of
40297 the calling process.
40298 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
40299 option may not be used at all.
40300 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
40301 can be supplied if the calling process is running as root, the Exim run-time
40302 user or CONFIGURE_OWNER, if defined.
40303 .next
40304 .oindex "&%-be%&"
40305 .oindex "&%-bf%&"
40306 .oindex "&%-bF%&"
40307 If the expansion test option (&%-be%&) or one of the filter testing options
40308 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
40309 calling process.
40310 .next
40311 If the process is not a daemon process or a queue runner process or a delivery
40312 process or a process for testing address routing (started with &%-bt%&), the
40313 uid and gid are changed to the Exim user and group. This means that Exim always
40314 runs under its own uid and gid when receiving messages. This also applies when
40315 testing address verification
40316 .oindex "&%-bv%&"
40317 .oindex "&%-bh%&"
40318 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
40319 option).
40320 .next
40321 For a daemon, queue runner, delivery, or address testing process, the uid
40322 remains as root at this stage, but the gid is changed to the Exim group.
40323 .endlist
40324
40325 The processes that initially retain root privilege behave as follows:
40326
40327 .ilist
40328 A daemon process changes the gid to the Exim group and the uid to the Exim
40329 user after setting up one or more listening sockets. The &[initgroups()]&
40330 function is called, so that if the Exim user is in any additional groups, they
40331 will be used during message reception.
40332 .next
40333 A queue runner process retains root privilege throughout its execution. Its
40334 job is to fork a controlled sequence of delivery processes.
40335 .next
40336 A delivery process retains root privilege throughout most of its execution,
40337 but any actual deliveries (that is, the transports themselves) are run in
40338 subprocesses which always change to a non-root uid and gid. For local
40339 deliveries this is typically the uid and gid of the owner of the mailbox; for
40340 remote deliveries, the Exim uid and gid are used. Once all the delivery
40341 subprocesses have been run, a delivery process changes to the Exim uid and gid
40342 while doing post-delivery tidying up such as updating the retry database and
40343 generating bounce and warning messages.
40344
40345 While the recipient addresses in a message are being routed, the delivery
40346 process runs as root. However, if a user's filter file has to be processed,
40347 this is done in a subprocess that runs under the individual user's uid and
40348 gid. A system filter is run as root unless &%system_filter_user%& is set.
40349 .next
40350 A process that is testing addresses (the &%-bt%& option) runs as root so that
40351 the routing is done in the same environment as a message delivery.
40352 .endlist
40353
40354
40355
40356
40357 .section "Running Exim without privilege" "SECTrunexiwitpri"
40358 .cindex "privilege, running without"
40359 .cindex "unprivileged running"
40360 .cindex "root privilege" "running without"
40361 Some installations like to run Exim in an unprivileged state for more of its
40362 operation, for added security. Support for this mode of operation is provided
40363 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
40364 gid are changed to the Exim user and group at the start of a delivery process
40365 (and also queue runner and address testing processes). This means that address
40366 routing is no longer run as root, and the deliveries themselves cannot change
40367 to any other uid.
40368
40369 .cindex SIGHUP
40370 .cindex "daemon" "restarting"
40371 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
40372 that the daemon can still be started in the usual way, and it can respond
40373 correctly to SIGHUP because the re-invocation regains root privilege.
40374
40375 An alternative approach is to make Exim setuid to the Exim user and also setgid
40376 to the Exim group. If you do this, the daemon must be started from a root
40377 process. (Calling Exim from a root process makes it behave in the way it does
40378 when it is setuid root.) However, the daemon cannot restart itself after a
40379 SIGHUP signal because it cannot regain privilege.
40380
40381 It is still useful to set &%deliver_drop_privilege%& in this case, because it
40382 stops Exim from trying to re-invoke itself to do a delivery after a message has
40383 been received. Such a re-invocation is a waste of resources because it has no
40384 effect.
40385
40386 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
40387 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
40388 to the Exim user seems a clean approach, but there is one complication:
40389
40390 In this style of operation, Exim is running with the real uid and gid set to
40391 those of the calling process, and the effective uid/gid set to Exim's values.
40392 Ideally, any association with the calling process' uid/gid should be dropped,
40393 that is, the real uid/gid should be reset to the effective values so as to
40394 discard any privileges that the caller may have. While some operating systems
40395 have a function that permits this action for a non-root effective uid, quite a
40396 number of them do not. Because of this lack of standardization, Exim does not
40397 address this problem at this time.
40398
40399 For this reason, the recommended approach for &"mostly unprivileged"& running
40400 is to keep the Exim binary setuid to root, and to set
40401 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
40402 be used in the most straightforward way.
40403
40404 If you configure Exim not to run delivery processes as root, there are a
40405 number of restrictions on what you can do:
40406
40407 .ilist
40408 You can deliver only as the Exim user/group. You should  explicitly use the
40409 &%user%& and &%group%& options to override routers or local transports that
40410 normally deliver as the recipient. This makes sure that configurations that
40411 work in this mode function the same way in normal mode. Any implicit or
40412 explicit specification of another user causes an error.
40413 .next
40414 Use of &_.forward_& files is severely restricted, such that it is usually
40415 not worthwhile to include them in the configuration.
40416 .next
40417 Users who wish to use &_.forward_& would have to make their home directory and
40418 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40419 and their equivalents in Exim filters, cannot be used. While they could be
40420 enabled in the Exim user's name, that would be insecure and not very useful.
40421 .next
40422 Unless the local user mailboxes are all owned by the Exim user (possible in
40423 some POP3 or IMAP-only environments):
40424
40425 .olist
40426 They must be owned by the Exim group and be writeable by that group. This
40427 implies you must set &%mode%& in the appendfile configuration, as well as the
40428 mode of the mailbox files themselves.
40429 .next
40430 You must set &%no_check_owner%&, since most or all of the files will not be
40431 owned by the Exim user.
40432 .next
40433 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40434 on a newly created mailbox when unprivileged. This also implies that new
40435 mailboxes need to be created manually.
40436 .endlist olist
40437 .endlist ilist
40438
40439
40440 These restrictions severely restrict what can be done in local deliveries.
40441 However, there are no restrictions on remote deliveries. If you are running a
40442 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40443 gives more security at essentially no cost.
40444
40445 If you are using the &%mua_wrapper%& facility (see chapter
40446 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40447
40448
40449
40450
40451 .section "Delivering to local files" "SECID271"
40452 Full details of the checks applied by &(appendfile)& before it writes to a file
40453 are given in chapter &<<CHAPappendfile>>&.
40454
40455
40456
40457 .section "Running local commands" "SECTsecconslocalcmds"
40458 .cindex "security" "local commands"
40459 .cindex "security" "command injection attacks"
40460 There are a number of ways in which an administrator can configure Exim to run
40461 commands based upon received, untrustworthy, data. Further, in some
40462 configurations a user who can control a &_.forward_& file can also arrange to
40463 run commands. Configuration to check includes, but is not limited to:
40464
40465 .ilist
40466 Use of &%use_shell%& in the pipe transport: various forms of shell command
40467 injection may be possible with this option present. It is dangerous and should
40468 be used only with considerable caution. Consider constraints which whitelist
40469 allowed characters in a variable which is to be used in a pipe transport that
40470 has &%use_shell%& enabled.
40471 .next
40472 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40473 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40474 &_.forward_& files in a redirect router. If Exim is running on a central mail
40475 hub to which ordinary users do not have shell access, but home directories are
40476 NFS mounted (for instance) then administrators should review the list of these
40477 forbid options available, and should bear in mind that the options that may
40478 need forbidding can change as new features are added between releases.
40479 .next
40480 The &%${run...}%& expansion item does not use a shell by default, but
40481 administrators can configure use of &_/bin/sh_& as part of the command.
40482 Such invocations should be viewed with prejudicial suspicion.
40483 .next
40484 Administrators who use embedded Perl are advised to explore how Perl's
40485 taint checking might apply to their usage.
40486 .next
40487 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40488 administrators are well advised to view its use with suspicion, in case (for
40489 instance) it allows a local-part to contain embedded Exim directives.
40490 .next
40491 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40492 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40493 each can reference arbitrary lists and files, rather than just being a list
40494 of opaque strings.
40495 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40496 real-world security vulnerabilities caused by its use with untrustworthy data
40497 injected in, for SQL injection attacks.
40498 Consider the use of the &%inlisti%& expansion condition instead.
40499 .endlist
40500
40501
40502
40503
40504 .section "Trust in configuration data" "SECTsecconfdata"
40505 .cindex "security" "data sources"
40506 .cindex "security" "regular expressions"
40507 .cindex "regular expressions" "security"
40508 .cindex "PCRE" "security"
40509 If configuration data for Exim can come from untrustworthy sources, there
40510 are some issues to be aware of:
40511
40512 .ilist
40513 Use of &%${expand...}%& may provide a path for shell injection attacks.
40514 .next
40515 Letting untrusted data provide a regular expression is unwise.
40516 .next
40517 Using &%${match...}%& to apply a fixed regular expression against untrusted
40518 data may result in pathological behaviour within PCRE.  Be aware of what
40519 "backtracking" means and consider options for being more strict with a regular
40520 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40521 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40522 possessive quantifiers or just not using regular expressions against untrusted
40523 data.
40524 .next
40525 It can be important to correctly use &%${quote:...}%&,
40526 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40527 items to ensure that data is correctly constructed.
40528 .next
40529 Some lookups might return multiple results, even though normal usage is only
40530 expected to yield one result.
40531 .endlist
40532
40533
40534
40535
40536 .section "IPv4 source routing" "SECID272"
40537 .cindex "source routing" "in IP packets"
40538 .cindex "IP source routing"
40539 Many operating systems suppress IP source-routed packets in the kernel, but
40540 some cannot be made to do this, so Exim does its own check. It logs incoming
40541 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40542 IPv6. No special checking is currently done.
40543
40544
40545
40546 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40547 Support for these SMTP commands is disabled by default. If required, they can
40548 be enabled by defining suitable ACLs.
40549
40550
40551
40552
40553 .section "Privileged users" "SECID274"
40554 .cindex "trusted users"
40555 .cindex "admin user"
40556 .cindex "privileged user"
40557 .cindex "user" "trusted"
40558 .cindex "user" "admin"
40559 Exim recognizes two sets of users with special privileges. Trusted users are
40560 able to submit new messages to Exim locally, but supply their own sender
40561 addresses and information about a sending host. For other users submitting
40562 local messages, Exim sets up the sender address from the uid, and doesn't
40563 permit a remote host to be specified.
40564
40565 .oindex "&%-f%&"
40566 However, an untrusted user is permitted to use the &%-f%& command line option
40567 in the special form &%-f <>%& to indicate that a delivery failure for the
40568 message should not cause an error report. This affects the message's envelope,
40569 but it does not affect the &'Sender:'& header. Untrusted users may also be
40570 permitted to use specific forms of address with the &%-f%& option by setting
40571 the &%untrusted_set_sender%& option.
40572
40573 Trusted users are used to run processes that receive mail messages from some
40574 other mail domain and pass them on to Exim for delivery either locally, or over
40575 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40576 as any user listed in the &%trusted_users%& configuration option, or under any
40577 group listed in the &%trusted_groups%& option.
40578
40579 Admin users are permitted to do things to the messages on Exim's queue. They
40580 can freeze or thaw messages, cause them to be returned to their senders, remove
40581 them entirely, or modify them in various ways. In addition, admin users can run
40582 the Exim monitor and see all the information it is capable of providing, which
40583 includes the contents of files on the spool.
40584
40585 .oindex "&%-M%&"
40586 .oindex "&%-q%&"
40587 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40588 delivery of messages on its queue is restricted to admin users. This
40589 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40590 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40591 queue is also restricted to admin users. This restriction can be relaxed by
40592 setting &%no_queue_list_requires_admin%&.
40593
40594 Exim recognizes an admin user if the calling process is running as root or as
40595 the Exim user or if any of the groups associated with the calling process is
40596 the Exim group. It is not necessary actually to be running under the Exim
40597 group. However, if admin users who are not root or the Exim user are to access
40598 the contents of files on the spool via the Exim monitor (which runs
40599 unprivileged), Exim must be built to allow group read access to its spool
40600 files.
40601
40602 By default, regular users are trusted to perform basic testing and
40603 introspection commands, as themselves.  This setting can be tightened by
40604 setting the &%commandline_checks_require_admin%& option.
40605 This affects most of the checking options,
40606 such as &%-be%& and anything else &%-b*%&.
40607
40608
40609 .section "Spool files" "SECID275"
40610 .cindex "spool directory" "files"
40611 Exim's spool directory and everything it contains is owned by the Exim user and
40612 set to the Exim group. The mode for spool files is defined in the
40613 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40614 any user who is a member of the Exim group can access these files.
40615
40616
40617
40618 .section "Use of argv[0]" "SECID276"
40619 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40620 of specific strings, Exim assumes certain options. For example, calling Exim
40621 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40622 to calling it with the option &%-bS%&. There are no security implications in
40623 this.
40624
40625
40626
40627 .section "Use of %f formatting" "SECID277"
40628 The only use made of &"%f"& by Exim is in formatting load average values. These
40629 are actually stored in integer variables as 1000 times the load average.
40630 Consequently, their range is limited and so therefore is the length of the
40631 converted output.
40632
40633
40634
40635 .section "Embedded Exim path" "SECID278"
40636 Exim uses its own path name, which is embedded in the code, only when it needs
40637 to re-exec in order to regain root privilege. Therefore, it is not root when it
40638 does so. If some bug allowed the path to get overwritten, it would lead to an
40639 arbitrary program's being run as exim, not as root.
40640
40641
40642
40643 .section "Dynamic module directory" "SECTdynmoddir"
40644 Any dynamically loadable modules must be installed into the directory
40645 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40646 loading it.
40647
40648
40649 .section "Use of sprintf()" "SECID279"
40650 .cindex "&[sprintf()]&"
40651 A large number of occurrences of &"sprintf"& in the code are actually calls to
40652 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40653 The intermediate formatting is done into a large fixed buffer by a function
40654 that runs through the format string itself, and checks the length of each
40655 conversion before performing it, thus preventing buffer overruns.
40656
40657 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40658 the output buffer is known to be sufficiently long to contain the converted
40659 string.
40660
40661
40662
40663 .section "Use of debug_printf() and log_write()" "SECID280"
40664 Arbitrary strings are passed to both these functions, but they do their
40665 formatting by calling the function &'string_vformat()'&, which runs through
40666 the format string itself, and checks the length of each conversion.
40667
40668
40669
40670 .section "Use of strcat() and strcpy()" "SECID281"
40671 These are used only in cases where the output buffer is known to be large
40672 enough to hold the result.
40673 .ecindex IIDsecurcon
40674
40675
40676
40677
40678 . ////////////////////////////////////////////////////////////////////////////
40679 . ////////////////////////////////////////////////////////////////////////////
40680
40681 .chapter "Format of spool files" "CHAPspool"
40682 .scindex IIDforspo1 "format" "spool files"
40683 .scindex IIDforspo2 "spool directory" "format of files"
40684 .scindex IIDforspo3 "spool files" "format of"
40685 .cindex "spool files" "editing"
40686 A message on Exim's queue consists of two files, whose names are the message id
40687 followed by -D and -H, respectively. The data portion of the message is kept in
40688 the -D file on its own. The message's envelope, status, and headers are all
40689 kept in the -H file, whose format is described in this chapter. Each of these
40690 two files contains the final component of its own name as its first line. This
40691 is insurance against disk crashes where the directory is lost but the files
40692 themselves are recoverable.
40693
40694 The file formats may be changed, or new formats added, at any release.
40695 Spool files are not intended as an interface to other programs
40696 and should not be used as such.
40697
40698 Some people are tempted into editing -D files in order to modify messages. You
40699 need to be extremely careful if you do this; it is not recommended and you are
40700 on your own if you do it. Here are some of the pitfalls:
40701
40702 .ilist
40703 You must ensure that Exim does not try to deliver the message while you are
40704 fiddling with it. The safest way is to take out a write lock on the -D file,
40705 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40706 place, the lock will be retained. If you write a new file and rename it, the
40707 lock will be lost at the instant of rename.
40708 .next
40709 .vindex "&$body_linecount$&"
40710 If you change the number of lines in the file, the value of
40711 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40712 cause incomplete transmission of messages or undeliverable messages.
40713 .next
40714 If the message is in MIME format, you must take care not to break it.
40715 .next
40716 If the message is cryptographically signed, any change will invalidate the
40717 signature.
40718 .endlist
40719 All in all, modifying -D files is fraught with danger.
40720
40721 Files whose names end with -J may also be seen in the &_input_& directory (or
40722 its subdirectories when &%split_spool_directory%& is set). These are journal
40723 files, used to record addresses to which the message has been delivered during
40724 the course of a delivery attempt. If there are still undelivered recipients at
40725 the end, the -H file is updated, and the -J file is deleted. If, however, there
40726 is some kind of crash (for example, a power outage) before this happens, the -J
40727 file remains in existence. When Exim next processes the message, it notices the
40728 -J file and uses it to update the -H file before starting the next delivery
40729 attempt.
40730
40731 Files whose names end with -K or .eml may also be seen in the spool.
40732 These are temporaries used for DKIM or malware processing, when that is used.
40733 They should be tidied up by normal operations; any old ones are probably
40734 relics of crashes and can be removed.
40735
40736 .section "Format of the -H file" "SECID282"
40737 .cindex "uid (user id)" "in spool file"
40738 .cindex "gid (group id)" "in spool file"
40739 The second line of the -H file contains the login name for the uid of the
40740 process that called Exim to read the message, followed by the numerical uid and
40741 gid. For a locally generated message, this is normally the user who sent the
40742 message. For a message received over TCP/IP via the daemon, it is
40743 normally the Exim user.
40744
40745 The third line of the file contains the address of the message's sender as
40746 transmitted in the envelope, contained in angle brackets. The sender address is
40747 empty for bounce messages. For incoming SMTP mail, the sender address is given
40748 in the MAIL command. For locally generated mail, the sender address is
40749 created by Exim from the login name of the current user and the configured
40750 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40751 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40752 &"<>"& or an address that matches &%untrusted_set_senders%&.
40753
40754 The fourth line contains two numbers. The first is the time that the message
40755 was received, in the conventional Unix form &-- the number of seconds since the
40756 start of the epoch. The second number is a count of the number of messages
40757 warning of delayed delivery that have been sent to the sender.
40758
40759 There follow a number of lines starting with a hyphen. These can appear in any
40760 order, and are omitted when not relevant:
40761
40762 .vlist
40763 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40764 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40765 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40766 recognized, to provide backward compatibility. In the old format, a line of
40767 this form is present for every ACL variable that is not empty. The number
40768 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40769 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40770 the data string for the variable. The string itself starts at the beginning of
40771 the next line, and is followed by a newline character. It may contain internal
40772 newlines.
40773
40774 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40775 A line of this form is present for every ACL connection variable that is
40776 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40777 The length is the length of the data string for the variable. The string itself
40778 starts at the beginning of the next line, and is followed by a newline
40779 character. It may contain internal newlines.
40780
40781 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40782 A line of this form is present for every ACL message variable that is defined.
40783 Note that there is a space between &%-aclm%& and the rest of the name. The
40784 length is the length of the data string for the variable. The string itself
40785 starts at the beginning of the next line, and is followed by a newline
40786 character. It may contain internal newlines.
40787
40788 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40789 This is present if, when the message was received over SMTP, the value of
40790 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40791
40792 .vitem &%-allow_unqualified_recipient%&
40793 This is present if unqualified recipient addresses are permitted in header
40794 lines (to stop such addresses from being qualified if rewriting occurs at
40795 transport time). Local messages that were input using &%-bnq%& and remote
40796 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40797
40798 .vitem &%-allow_unqualified_sender%&
40799 This is present if unqualified sender addresses are permitted in header lines
40800 (to stop such addresses from being qualified if rewriting occurs at transport
40801 time). Local messages that were input using &%-bnq%& and remote messages from
40802 hosts that match &%sender_unqualified_hosts%& set this flag.
40803
40804 .vitem "&%-auth_id%&&~<&'text'&>"
40805 The id information for a message received on an authenticated SMTP connection
40806 &-- the value of the &$authenticated_id$& variable.
40807
40808 .vitem "&%-auth_sender%&&~<&'address'&>"
40809 The address of an authenticated sender &-- the value of the
40810 &$authenticated_sender$& variable.
40811
40812 .vitem "&%-body_linecount%&&~<&'number'&>"
40813 This records the number of lines in the body of the message, and is
40814 present unless &%-spool_file_wireformat%& is.
40815
40816 .vitem "&%-body_zerocount%&&~<&'number'&>"
40817 This records the number of binary zero bytes in the body of the message, and is
40818 present if the number is greater than zero.
40819
40820 .vitem &%-deliver_firsttime%&
40821 This is written when a new message is first added to the spool. When the spool
40822 file is updated after a deferral, it is omitted.
40823
40824 .vitem "&%-frozen%&&~<&'time'&>"
40825 .cindex "frozen messages" "spool data"
40826 The message is frozen, and the freezing happened at <&'time'&>.
40827
40828 .vitem "&%-helo_name%&&~<&'text'&>"
40829 This records the host name as specified by a remote host in a HELO or EHLO
40830 command.
40831
40832 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40833 This records the IP address of the host from which the message was received and
40834 the remote port number that was used. It is omitted for locally generated
40835 messages.
40836
40837 .vitem "&%-host_auth%&&~<&'text'&>"
40838 If the message was received on an authenticated SMTP connection, this records
40839 the name of the authenticator &-- the value of the
40840 &$sender_host_authenticated$& variable.
40841
40842 .vitem &%-host_lookup_failed%&
40843 This is present if an attempt to look up the sending host's name from its IP
40844 address failed. It corresponds to the &$host_lookup_failed$& variable.
40845
40846 .vitem "&%-host_name%&&~<&'text'&>"
40847 .cindex "reverse DNS lookup"
40848 .cindex "DNS" "reverse lookup"
40849 This records the name of the remote host from which the message was received,
40850 if the host name was looked up from the IP address when the message was being
40851 received. It is not present if no reverse lookup was done.
40852
40853 .vitem "&%-ident%&&~<&'text'&>"
40854 For locally submitted messages, this records the login of the originating user,
40855 unless it was a trusted user and the &%-oMt%& option was used to specify an
40856 ident value. For messages received over TCP/IP, this records the ident string
40857 supplied by the remote host, if any.
40858
40859 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40860 This records the IP address of the local interface and the port number through
40861 which a message was received from a remote host. It is omitted for locally
40862 generated messages.
40863
40864 .vitem &%-local%&
40865 The message is from a local sender.
40866
40867 .vitem &%-localerror%&
40868 The message is a locally-generated bounce message.
40869
40870 .vitem "&%-local_scan%&&~<&'string'&>"
40871 This records the data string that was returned by the &[local_scan()]& function
40872 when the message was received &-- the value of the &$local_scan_data$&
40873 variable. It is omitted if no data was returned.
40874
40875 .vitem &%-manual_thaw%&
40876 The message was frozen but has been thawed manually, that is, by an explicit
40877 Exim command rather than via the auto-thaw process.
40878
40879 .vitem &%-N%&
40880 A testing delivery process was started using the &%-N%& option to suppress any
40881 actual deliveries, but delivery was deferred. At any further delivery attempts,
40882 &%-N%& is assumed.
40883
40884 .vitem &%-received_protocol%&
40885 This records the value of the &$received_protocol$& variable, which contains
40886 the name of the protocol by which the message was received.
40887
40888 .vitem &%-sender_set_untrusted%&
40889 The envelope sender of this message was set by an untrusted local caller (used
40890 to ensure that the caller is displayed in queue listings).
40891
40892 .vitem "&%-spam_score_int%&&~<&'number'&>"
40893 If a message was scanned by SpamAssassin, this is present. It records the value
40894 of &$spam_score_int$&.
40895
40896 .vitem &%-spool_file_wireformat%&
40897 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40898 rather than Unix-format.
40899 The line-ending is CRLF rather than newline.
40900 There is still, however, no leading-dot-stuffing.
40901
40902 .vitem &%-tls_certificate_verified%&
40903 A TLS certificate was received from the client that sent this message, and the
40904 certificate was verified by the server.
40905
40906 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40907 When the message was received over an encrypted connection, this records the
40908 name of the cipher suite that was used.
40909
40910 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40911 When the message was received over an encrypted connection, and a certificate
40912 was received from the client, this records the Distinguished Name from that
40913 certificate.
40914 .endlist
40915
40916 Any of the above may have an extra hyphen prepended, to indicate the the
40917 corresponding data is untrusted.
40918
40919 Following the options there is a list of those addresses to which the message
40920 is not to be delivered. This set of addresses is initialized from the command
40921 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40922 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40923 the address is added to this set. The addresses are kept internally as a
40924 balanced binary tree, and it is a representation of that tree which is written
40925 to the spool file. If an address is expanded via an alias or forward file, the
40926 original address is added to the tree when deliveries to all its child
40927 addresses are complete.
40928
40929 If the tree is empty, there is a single line in the spool file containing just
40930 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40931 Y or N, followed by an address. The address is the value for the node of the
40932 tree, and the letters indicate whether the node has a left branch and/or a
40933 right branch attached to it, respectively. If branches exist, they immediately
40934 follow. Here is an example of a three-node tree:
40935 .code
40936 YY darcy@austen.fict.example
40937 NN alice@wonderland.fict.example
40938 NN editor@thesaurus.ref.example
40939 .endd
40940 After the non-recipients tree, there is a list of the message's recipients.
40941 This is a simple list, preceded by a count. It includes all the original
40942 recipients of the message, including those to whom the message has already been
40943 delivered. In the simplest case, the list contains one address per line. For
40944 example:
40945 .code
40946 4
40947 editor@thesaurus.ref.example
40948 darcy@austen.fict.example
40949 rdo@foundation
40950 alice@wonderland.fict.example
40951 .endd
40952 However, when a child address has been added to the top-level addresses as a
40953 result of the use of the &%one_time%& option on a &(redirect)& router, each
40954 line is of the following form:
40955 .display
40956 <&'top-level address'&> <&'errors_to address'&> &&&
40957   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40958 .endd
40959 The 01 flag bit indicates the presence of the three other fields that follow
40960 the top-level address. Other bits may be used in future to support additional
40961 fields. The <&'parent number'&> is the offset in the recipients list of the
40962 original parent of the &"one time"& address. The first two fields are the
40963 envelope sender that is associated with this address and its length. If the
40964 length is zero, there is no special envelope sender (there are then two space
40965 characters in the line). A non-empty field can arise from a &(redirect)& router
40966 that has an &%errors_to%& setting.
40967
40968
40969 A blank line separates the envelope and status information from the headers
40970 which follow. A header may occupy several lines of the file, and to save effort
40971 when reading it in, each header is preceded by a number and an identifying
40972 character. The number is the number of characters in the header, including any
40973 embedded newlines and the terminating newline. The character is one of the
40974 following:
40975
40976 .table2 50pt
40977 .row <&'blank'&>         "header in which Exim has no special interest"
40978 .row &`B`&               "&'Bcc:'& header"
40979 .row &`C`&               "&'Cc:'& header"
40980 .row &`F`&               "&'From:'& header"
40981 .row &`I`&               "&'Message-id:'& header"
40982 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40983 .row &`R`&               "&'Reply-To:'& header"
40984 .row &`S`&               "&'Sender:'& header"
40985 .row &`T`&               "&'To:'& header"
40986 .row &`*`&               "replaced or deleted header"
40987 .endtable
40988
40989 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40990 purposes. They are not transmitted when the message is delivered. Here is a
40991 typical set of headers:
40992 .code
40993 111P Received: by hobbit.fict.example with local (Exim 4.00)
40994 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40995 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40996 038* X-rewrote-sender: bb@hobbit.fict.example
40997 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40998 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40999 099* To: alice@wonderland.fict.example, rdo@foundation,
41000 darcy@austen.fict.example, editor@thesaurus.ref.example
41001 104T To: alice@wonderland.fict.example, rdo@foundation.example,
41002 darcy@austen.fict.example, editor@thesaurus.ref.example
41003 038  Date: Fri, 11 May 2001 10:28:59 +0100
41004 .endd
41005 The asterisked headers indicate that the envelope sender, &'From:'& header, and
41006 &'To:'& header have been rewritten, the last one because routing expanded the
41007 unqualified domain &'foundation'&.
41008 .ecindex IIDforspo1
41009 .ecindex IIDforspo2
41010 .ecindex IIDforspo3
41011
41012 .section "Format of the -D file" "SECID282a"
41013 The data file is traditionally in Unix-standard format: lines are ended with
41014 an ASCII newline character.
41015 However, when the &%spool_wireformat%& main option is used some -D files
41016 can have an alternate format.
41017 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
41018 The -D file lines (not including the first name-component line) are
41019 suitable for direct copying to the wire when transmitting using the
41020 ESMTP CHUNKING option, meaning lower processing overhead.
41021 Lines are terminated with an ASCII CRLF pair.
41022 There is no dot-stuffing (and no dot-termination).
41023
41024 . ////////////////////////////////////////////////////////////////////////////
41025 . ////////////////////////////////////////////////////////////////////////////
41026
41027 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
41028          "DKIM, SPF, SRS and DMARC Support"
41029
41030 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
41031 .cindex "DKIM"
41032
41033 DKIM is a mechanism by which messages sent by some entity can be provably
41034 linked to a domain which that entity controls.  It permits reputation to
41035 be tracked on a per-domain basis, rather than merely upon source IP address.
41036 DKIM is documented in RFC 6376.
41037
41038 As DKIM relies on the message being unchanged in transit, messages handled
41039 by a mailing-list (which traditionally adds to the message) will not match
41040 any original DKIM signature.
41041
41042 DKIM support is compiled into Exim by default if TLS support is present.
41043 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
41044
41045 Exim's DKIM implementation allows for
41046 .olist
41047 Signing outgoing messages: This function is implemented in the SMTP transport.
41048 It can co-exist with all other Exim features
41049 (including transport filters)
41050 except cutthrough delivery.
41051 .next
41052 Verifying signatures in incoming messages: This is implemented by an additional
41053 ACL (acl_smtp_dkim), which can be called several times per message, with
41054 different signature contexts.
41055 .endlist
41056
41057 In typical Exim style, the verification implementation does not include any
41058 default "policy". Instead it enables you to build your own policy using
41059 Exim's standard controls.
41060
41061 Please note that verification of DKIM signatures in incoming mail is turned
41062 on by default for logging (in the <= line) purposes.
41063
41064 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
41065 When set, for each signature in incoming email,
41066 exim will log a line displaying the most important signature details, and the
41067 signature status. Here is an example (with line-breaks added for clarity):
41068 .code
41069 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
41070     d=facebookmail.com s=q1-2009b
41071     c=relaxed/relaxed a=rsa-sha1
41072     i=@facebookmail.com t=1252484542 [verification succeeded]
41073 .endd
41074
41075 You might want to turn off DKIM verification processing entirely for internal
41076 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
41077 control modifier. This should typically be done in the RCPT ACL, at points
41078 where you accept mail from relay sources (internal hosts or authenticated
41079 senders).
41080
41081
41082 .section "Signing outgoing messages" "SECDKIMSIGN"
41083 .cindex "DKIM" "signing"
41084
41085 For signing to be usable you must have published a DKIM record in DNS.
41086 Note that RFC 8301 (which does not cover EC keys) says:
41087 .code
41088 rsa-sha1 MUST NOT be used for signing or verifying.
41089
41090 Signers MUST use RSA keys of at least 1024 bits for all keys.
41091 Signers SHOULD use RSA keys of at least 2048 bits.
41092 .endd
41093
41094 Note also that the key content (the 'p=' field)
41095 in the DNS record is different between RSA and EC keys;
41096 for the former it is the base64 of the ASN.1 for the RSA public key
41097 (equivalent to the private-key .pem with the header/trailer stripped)
41098 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
41099
41100 Signing is enabled by setting private options on the SMTP transport.
41101 These options take (expandable) strings as arguments.
41102
41103 .option dkim_domain smtp "string list&!!" unset
41104 The domain(s) you want to sign with.
41105 After expansion, this can be a list.
41106 Each element in turn,
41107 lowercased,
41108 is put into the &%$dkim_domain%& expansion variable
41109 while expanding the remaining signing options.
41110 If it is empty after expansion, DKIM signing is not done,
41111 and no error will result even if &%dkim_strict%& is set.
41112
41113 .option dkim_selector smtp "string list&!!" unset
41114 This sets the key selector string.
41115 After expansion, which can use &$dkim_domain$&, this can be a list.
41116 Each element in turn is put in the expansion
41117 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
41118 option along with &%$dkim_domain%&.
41119 If the option is empty after expansion, DKIM signing is not done for this domain,
41120 and no error will result even if &%dkim_strict%& is set.
41121
41122 .new
41123 To do, for example, dual-signing with RSA and EC keys
41124 this could be be used:
41125 .code
41126 dkim_selector = ec_sel : rsa_sel
41127 dkim_private_key = KEYS_DIR/$dkim_selector
41128 .endd
41129 .wen
41130
41131 .option dkim_private_key smtp string&!! unset
41132 This sets the private key to use.
41133 You can use the &%$dkim_domain%& and
41134 &%$dkim_selector%& expansion variables to determine the private key to use.
41135 The result can either
41136 .ilist
41137 be a valid RSA private key in ASCII armor (.pem file), including line breaks
41138 .next
41139 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41140 be a valid Ed25519 private key (same format as above)
41141 .next
41142 start with a slash, in which case it is treated as a file that contains
41143 the private key
41144 .next
41145 be "0", "false" or the empty string, in which case the message will not
41146 be signed. This case will not result in an error, even if &%dkim_strict%&
41147 is set.
41148 .endlist
41149
41150 To generate keys under OpenSSL:
41151 .code
41152 openssl genrsa -out dkim_rsa.private 2048
41153 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
41154 .endd
41155 The result file from the first command should be retained, and
41156 this option set to use it.
41157 Take the base-64 lines from the output of the second command, concatenated,
41158 for the DNS TXT record.
41159 See section 3.6 of RFC6376 for the record specification.
41160
41161 Under GnuTLS:
41162 .code
41163 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
41164 certtool --load-privkey=dkim_rsa.private --pubkey-info
41165 .endd
41166
41167 Note that RFC 8301 says:
41168 .code
41169 Signers MUST use RSA keys of at least 1024 bits for all keys.
41170 Signers SHOULD use RSA keys of at least 2048 bits.
41171 .endd
41172
41173 EC keys for DKIM are defined by RFC 8463.
41174 They are considerably smaller than RSA keys for equivalent protection.
41175 As they are a recent development, users should consider dual-signing
41176 (by setting a list of selectors, and an expansion for this option)
41177 for some transition period.
41178 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41179 for EC keys.
41180
41181 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
41182 .code
41183 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
41184 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
41185 .endd
41186
41187 To produce the required public key value for a DNS record:
41188 .code
41189 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
41190 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
41191 .endd
41192
41193 Exim also supports an alternate format
41194 of Ed25519 keys in DNS which was a candidate during development
41195 of the standard, but not adopted.
41196 A future release will probably drop that support.
41197
41198 .option dkim_hash smtp string&!! sha256
41199 Can be set to any one of the supported hash methods, which are:
41200 .ilist
41201 &`sha1`& &-- should not be used, is old and insecure
41202 .next
41203 &`sha256`& &-- the default
41204 .next
41205 &`sha512`& &-- possibly more secure but less well supported
41206 .endlist
41207
41208 Note that RFC 8301 says:
41209 .code
41210 rsa-sha1 MUST NOT be used for signing or verifying.
41211 .endd
41212
41213 .option dkim_identity smtp string&!! unset
41214 If set after expansion, the value is used to set an "i=" tag in
41215 the signing header.  The DKIM standards restrict the permissible
41216 syntax of this optional tag to a mail address, with possibly-empty
41217 local part, an @, and a domain identical to or subdomain of the "d="
41218 tag value.  Note that Exim does not check the value.
41219
41220 .option dkim_canon smtp string&!! unset
41221 This option sets the canonicalization method used when signing a message.
41222 The DKIM RFC currently supports two methods: "simple" and "relaxed".
41223 The option defaults to "relaxed" when unset. Note: the current implementation
41224 only supports signing with the same canonicalization method for both headers and body.
41225
41226 .option dkim_strict smtp string&!! unset
41227 This  option  defines  how  Exim  behaves  when  signing a message that
41228 should be signed fails for some reason.  When the expansion evaluates to
41229 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
41230 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
41231 variables here.
41232
41233 .option dkim_sign_headers smtp string&!! "see below"
41234 If set, this option must expand to a colon-separated
41235 list of header names.
41236 Headers with these names, or the absence or such a header, will be included
41237 in the message signature.
41238 When unspecified, the header names listed in RFC4871 will be used,
41239 whether or not each header is present in the message.
41240 The default list is available for the expansion in the macro
41241 &"_DKIM_SIGN_HEADERS"&
41242 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
41243
41244 If a name is repeated, multiple headers by that name (or the absence thereof)
41245 will be signed.  The textually later headers in the headers part of the
41246 message are signed first, if there are multiples.
41247
41248 A name can be prefixed with either an &"="& or a &"+"& character.
41249 If an &"="& prefix is used, all headers that are present with this name
41250 will be signed.
41251 If a &"+"& prefix if used, all headers that are present with this name
41252 will be signed, and one signature added for a missing header with the
41253 name will be appended.
41254
41255 .option dkim_timestamps smtp integer&!! unset
41256 This option controls the inclusion of timestamp information in the signature.
41257 If not set, no such information will be included.
41258 Otherwise, must be an unsigned number giving an offset in seconds from the current time
41259 for the expiry tag
41260 (eg. 1209600 for two weeks);
41261 both creation (t=) and expiry (x=) tags will be included.
41262
41263 RFC 6376 lists these tags as RECOMMENDED.
41264
41265
41266 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
41267 .cindex "DKIM" "verification"
41268
41269 Verification of DKIM signatures in SMTP incoming email is done for all
41270 messages for which an ACL control &%dkim_disable_verify%& has not been set.
41271 .cindex DKIM "selecting signature algorithms"
41272 Individual classes of signature algorithm can be ignored by changing
41273 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
41274 The &%dkim_verify_minimal%& option can be set to cease verification
41275 processing for a message once the first passing signature is found.
41276
41277 .cindex authentication "expansion item"
41278 Performing verification sets up information used by the
41279 &%authresults%& expansion item.
41280
41281 For most purposes the default option settings suffice and the remainder
41282 of this section can be ignored.
41283
41284 The results of verification are made available to the
41285 &%acl_smtp_dkim%& ACL, which can examine and modify them.
41286 A missing ACL definition defaults to accept.
41287 By default, the ACL is called once for each
41288 syntactically(!) correct signature in the incoming message.
41289 If any ACL call does not accept, the message is not accepted.
41290 If a cutthrough delivery was in progress for the message, that is
41291 summarily dropped (having wasted the transmission effort).
41292
41293 To evaluate the verification result in the ACL
41294 a large number of expansion variables
41295 containing the signature status and its details are set up during the
41296 runtime of the ACL.
41297
41298 Calling the ACL only for existing signatures is not sufficient to build
41299 more advanced policies. For that reason, the main option
41300 &%dkim_verify_signers%&, and an expansion variable
41301 &%$dkim_signers%& exist.
41302
41303 The main option &%dkim_verify_signers%& can be set to a colon-separated
41304 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
41305 called. It is expanded when the message has been received. At this point,
41306 the expansion variable &%$dkim_signers%& already contains a colon-separated
41307 list of signer domains and identities for the message. When
41308 &%dkim_verify_signers%& is not specified in the main configuration,
41309 it defaults as:
41310 .code
41311 dkim_verify_signers = $dkim_signers
41312 .endd
41313 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
41314 DKIM signature in the message. Current DKIM verifiers may want to explicitly
41315 call the ACL for known domains or identities. This would be achieved as follows:
41316 .code
41317 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
41318 .endd
41319 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
41320 and "ebay.com", plus all domains and identities that have signatures in the message.
41321 You can also be more creative in constructing your policy. For example:
41322 .code
41323 dkim_verify_signers = $sender_address_domain:$dkim_signers
41324 .endd
41325
41326 If a domain or identity is listed several times in the (expanded) value of
41327 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
41328
41329 Note that if the option is set using untrustworthy data
41330 (such as the From: header)
41331 care should be taken to force lowercase for domains
41332 and for the domain part if identities.
41333 The default setting can be regarded as trustworthy in this respect.
41334
41335 If multiple signatures match a domain (or identity), the ACL is called once
41336 for each matching signature.
41337
41338
41339 Inside the DKIM ACL, the following expansion variables are
41340 available (from most to least important):
41341
41342
41343 .vlist
41344 .vitem &%$dkim_cur_signer%&
41345 The signer that is being evaluated in this ACL run. This can be a domain or
41346 an identity. This is one of the list items from the expanded main option
41347 &%dkim_verify_signers%& (see above).
41348
41349 .vitem &%$dkim_verify_status%&
41350 Within the DKIM ACL,
41351 a string describing the general status of the signature. One of
41352 .ilist
41353 &%none%&: There is no signature in the message for the current domain or
41354 identity (as reflected by &%$dkim_cur_signer%&).
41355 .next
41356 &%invalid%&: The signature could not be verified due to a processing error.
41357 More detail is available in &%$dkim_verify_reason%&.
41358 .next
41359 &%fail%&: Verification of the signature failed.  More detail is
41360 available in &%$dkim_verify_reason%&.
41361 .next
41362 &%pass%&: The signature passed verification. It is valid.
41363 .endlist
41364
41365 This variable can be overwritten using an ACL 'set' modifier.
41366 This might, for instance, be done to enforce a policy restriction on
41367 hash-method or key-size:
41368 .code
41369   warn condition       = ${if eq {$dkim_verify_status}{pass}}
41370        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
41371        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
41372                                   {< {$dkim_key_length}{1024}}}}
41373        logwrite        = NOTE: forcing DKIM verify fail (was pass)
41374        set dkim_verify_status = fail
41375        set dkim_verify_reason = hash too weak or key too short
41376 .endd
41377
41378 So long as a DKIM ACL is defined (it need do no more than accept),
41379 after all the DKIM ACL runs have completed, the value becomes a
41380 colon-separated list of the values after each run.
41381 This is maintained for the mime, prdr and data ACLs.
41382
41383 .vitem &%$dkim_verify_reason%&
41384 A string giving a little bit more detail when &%$dkim_verify_status%& is either
41385 "fail" or "invalid". One of
41386 .ilist
41387 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
41388 key for the domain could not be retrieved. This may be a temporary problem.
41389 .next
41390 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
41391 record for the domain is syntactically invalid.
41392 .next
41393 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
41394 body hash does not match the one specified in the signature header. This
41395 means that the message body was modified in transit.
41396 .next
41397 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
41398 could not be verified. This may mean that headers were modified,
41399 re-written or otherwise changed in a way which is incompatible with
41400 DKIM verification. It may of course also mean that the signature is forged.
41401 .endlist
41402
41403 This variable can be overwritten, with any value, using an ACL 'set' modifier.
41404
41405 .vitem &%$dkim_domain%&
41406 The signing domain. IMPORTANT: This variable is only populated if there is
41407 an actual signature in the message for the current domain or identity (as
41408 reflected by &%$dkim_cur_signer%&).
41409
41410 .vitem &%$dkim_identity%&
41411 The signing identity, if present. IMPORTANT: This variable is only populated
41412 if there is an actual signature in the message for the current domain or
41413 identity (as reflected by &%$dkim_cur_signer%&).
41414
41415 .vitem &%$dkim_selector%&
41416 The key record selector string.
41417
41418 .vitem &%$dkim_algo%&
41419 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41420 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41421 may also be 'ed25519-sha256'.
41422 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41423 for EC keys.
41424
41425 Note that RFC 8301 says:
41426 .code
41427 rsa-sha1 MUST NOT be used for signing or verifying.
41428
41429 DKIM signatures identified as having been signed with historic
41430 algorithms (currently, rsa-sha1) have permanently failed evaluation
41431 .endd
41432
41433 To enforce this you must either have a DKIM ACL which checks this variable
41434 and overwrites the &$dkim_verify_status$& variable as discussed above,
41435 or have set the main option &%dkim_verify_hashes%& to exclude
41436 processing of such signatures.
41437
41438 .vitem &%$dkim_canon_body%&
41439 The body canonicalization method. One of 'relaxed' or 'simple'.
41440
41441 .vitem &%$dkim_canon_headers%&
41442 The header canonicalization method. One of 'relaxed' or 'simple'.
41443
41444 .vitem &%$dkim_copiedheaders%&
41445 A transcript of headers and their values which are included in the signature
41446 (copied from the 'z=' tag of the signature).
41447 Note that RFC6376 requires that verification fail if the From: header is
41448 not included in the signature.  Exim does not enforce this; sites wishing
41449 strict enforcement should code the check explicitly.
41450
41451 .vitem &%$dkim_bodylength%&
41452 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41453 limit was set by the signer, "9999999999999" is returned. This makes sure
41454 that this variable always expands to an integer value.
41455 &*Note:*& The presence of the signature tag specifying a signing body length
41456 is one possible route to spoofing of valid DKIM signatures.
41457 A paranoid implementation might wish to regard signature where this variable
41458 shows less than the "no limit" return as being invalid.
41459
41460 .vitem &%$dkim_created%&
41461 UNIX timestamp reflecting the date and time when the signature was created.
41462 When this was not specified by the signer, "0" is returned.
41463
41464 .vitem &%$dkim_expires%&
41465 UNIX timestamp reflecting the date and time when the signer wants the
41466 signature to be treated as "expired". When this was not specified by the
41467 signer, "9999999999999" is returned. This makes it possible to do useful
41468 integer size comparisons against this value.
41469 Note that Exim does not check this value.
41470
41471 .vitem &%$dkim_headernames%&
41472 A colon-separated list of names of headers included in the signature.
41473
41474 .vitem &%$dkim_key_testing%&
41475 "1" if the key record has the "testing" flag set, "0" if not.
41476
41477 .vitem &%$dkim_key_nosubdomains%&
41478 "1" if the key record forbids subdomaining, "0" otherwise.
41479
41480 .vitem &%$dkim_key_srvtype%&
41481 Service type (tag s=) from the key record. Defaults to "*" if not specified
41482 in the key record.
41483
41484 .vitem &%$dkim_key_granularity%&
41485 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41486 in the key record.
41487
41488 .vitem &%$dkim_key_notes%&
41489 Notes from the key record (tag n=).
41490
41491 .vitem &%$dkim_key_length%&
41492 Number of bits in the key.
41493 Valid only once the key is loaded, which is at the time the header signature
41494 is verified, which is after the body hash is.
41495
41496 Note that RFC 8301 says:
41497 .code
41498 Verifiers MUST NOT consider signatures using RSA keys of
41499 less than 1024 bits as valid signatures.
41500 .endd
41501
41502 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41503 option.
41504
41505 .endlist
41506
41507 In addition, two ACL conditions are provided:
41508
41509 .vlist
41510 .vitem &%dkim_signers%&
41511 ACL condition that checks a colon-separated list of domains or identities
41512 for a match against the domain or identity that the ACL is currently verifying
41513 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41514 verb to a group of domains or identities. For example:
41515
41516 .code
41517 # Warn when Mail purportedly from GMail has no gmail signature
41518 warn sender_domains = gmail.com
41519      dkim_signers = gmail.com
41520      dkim_status = none
41521      log_message = GMail sender without gmail.com DKIM signature
41522 .endd
41523
41524 Note that the above does not check for a total lack of DKIM signing;
41525 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41526
41527 .vitem &%dkim_status%&
41528 ACL condition that checks a colon-separated list of possible DKIM verification
41529 results against the actual result of verification. This is typically used
41530 to restrict an ACL verb to a list of verification outcomes, for example:
41531
41532 .code
41533 deny sender_domains = paypal.com:paypal.de
41534      dkim_signers = paypal.com:paypal.de
41535      dkim_status = none:invalid:fail
41536      message = Mail from Paypal with invalid/missing signature
41537 .endd
41538
41539 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41540 see the documentation of the &%$dkim_verify_status%& expansion variable above
41541 for more information of what they mean.
41542 .endlist
41543
41544
41545
41546
41547 .section "SPF (Sender Policy Framework)" SECSPF
41548 .cindex SPF verification
41549
41550 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41551 messages with its domain in the envelope from, documented by RFC 7208.
41552 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41553 the &url(http://openspf.org).
41554 . --- 2019-10-28: still not https, open-spf.org is told to be a
41555 . --- web-archive copy of the now dead openspf.org site
41556 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41557 . --- discussion.
41558
41559 Messages sent by a system not authorised will fail checking of such assertions.
41560 This includes retransmissions done by traditional forwarders.
41561
41562 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41563 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41564 &url(https://www.libspf2.org/).
41565 There is no Exim involvement in the transmission of messages;
41566 publishing certain DNS records is all that is required.
41567
41568 For verification, an ACL condition and an expansion lookup are provided.
41569 .cindex authentication "expansion item"
41570 Performing verification sets up information used by the
41571 &%authresults%& expansion item.
41572
41573
41574 .cindex SPF "ACL condition"
41575 .cindex ACL "spf condition"
41576 The ACL condition "spf" can be used at or after the MAIL ACL.
41577 It takes as an argument a list of strings giving the outcome of the SPF check,
41578 and will succeed for any matching outcome.
41579 Valid strings are:
41580 .vlist
41581 .vitem &%pass%&
41582 The SPF check passed, the sending host is positively verified by SPF.
41583
41584 .vitem &%fail%&
41585 The SPF check failed, the sending host is NOT allowed to send mail for the
41586 domain in the envelope-from address.
41587
41588 .vitem &%softfail%&
41589 The SPF check failed, but the queried domain can't absolutely confirm that this
41590 is a forgery.
41591
41592 .vitem &%none%&
41593 The queried domain does not publish SPF records.
41594
41595 .vitem &%neutral%&
41596 The SPF check returned a "neutral" state.  This means the queried domain has
41597 published a SPF record, but wants to allow outside servers to send mail under
41598 its domain as well.  This should be treated like "none".
41599
41600 .vitem &%permerror%&
41601 This indicates a syntax error in the SPF record of the queried domain.
41602 You may deny messages when this occurs.
41603
41604 .vitem &%temperror%&
41605 This indicates a temporary error during all processing, including Exim's
41606 SPF processing.  You may defer messages when this occurs.
41607 .endlist
41608
41609 You can prefix each string with an exclamation mark to  invert
41610 its meaning,  for example  "!fail" will  match all  results but
41611 "fail".  The  string  list is  evaluated  left-to-right,  in a
41612 short-circuit fashion.
41613
41614 Example:
41615 .code
41616 deny spf = fail
41617      message = $sender_host_address is not allowed to send mail from \
41618                ${if def:sender_address_domain \
41619                     {$sender_address_domain}{$sender_helo_name}}.  \
41620                Please see http://www.open-spf.org/Why;\
41621                identity=${if def:sender_address_domain \
41622                              {$sender_address}{$sender_helo_name}};\
41623                ip=$sender_host_address
41624 .endd
41625
41626 Note: The above mentioned URL may not be as helpful as expected. You are
41627 encouraged to replace the link with a link to a site with more
41628 explanations.
41629
41630 When the spf condition has run, it sets up several expansion
41631 variables:
41632
41633 .cindex SPF "verification variables"
41634 .vlist
41635 .vitem &$spf_header_comment$&
41636 .vindex &$spf_header_comment$&
41637   This contains a human-readable string describing the outcome
41638   of the SPF check. You can add it to a custom header or use
41639   it for logging purposes.
41640
41641 .vitem &$spf_received$&
41642 .vindex &$spf_received$&
41643   This contains a complete Received-SPF: header that can be
41644   added to the message. Please note that according to the SPF
41645   draft, this header must be added at the top of the header
41646   list. Please see section 10 on how you can do this.
41647
41648   Note: in case of "Best-guess" (see below), the convention is
41649   to put this string in a header called X-SPF-Guess: instead.
41650
41651 .vitem &$spf_result$&
41652 .vindex &$spf_result$&
41653   This contains the outcome of the SPF check in string form,
41654   one of pass, fail, softfail, none, neutral, permerror or
41655   temperror.
41656
41657 .vitem &$spf_result_guessed$&
41658 .vindex &$spf_result_guessed$&
41659   This boolean is true only if a best-guess operation was used
41660   and required in order to obtain a result.
41661
41662 .vitem &$spf_smtp_comment$&
41663 .vindex &$spf_smtp_comment$&
41664 .vindex &%spf_smtp_comment_template%&
41665   This contains a string that can be used in a SMTP response
41666   to the calling party. Useful for "fail".
41667   The string is generated by the SPF library from the template configured in the main config
41668   option &%spf_smtp_comment_template%&.
41669 .endlist
41670
41671
41672 .cindex SPF "ACL condition"
41673 .cindex ACL "spf_guess condition"
41674 .cindex SPF "best guess"
41675 In addition to SPF, you can also perform checks for so-called
41676 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41677 SPF, but it is supported by the same framework that enables SPF
41678 capability.
41679 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41680 for a description of what it means.
41681 . --- 2019-10-28: still not https:
41682
41683 To access this feature, simply use the spf_guess condition in place
41684 of the spf one.  For example:
41685
41686 .code
41687 deny spf_guess = fail
41688      message = $sender_host_address doesn't look trustworthy to me
41689 .endd
41690
41691 In case you decide to reject messages based on this check, you
41692 should note that although it uses the same framework, "Best-guess"
41693 is not SPF, and therefore you should not mention SPF at all in your
41694 reject message.
41695
41696 When the spf_guess condition has run, it sets up the same expansion
41697 variables as when spf condition is run, described above.
41698
41699 Additionally, since Best-guess is not standardized, you may redefine
41700 what "Best-guess" means to you by redefining the main configuration
41701 &%spf_guess%& option.
41702 For example, the following:
41703
41704 .code
41705 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41706 .endd
41707
41708 would relax host matching rules to a broader network range.
41709
41710
41711 .cindex SPF "lookup expansion"
41712 .cindex lookup spf
41713 A lookup expansion is also available. It takes an email
41714 address as the key and an IP address
41715 (v4 or v6)
41716 as the database:
41717
41718 .code
41719   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41720 .endd
41721
41722 The lookup will return the same result strings as can appear in
41723 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41724
41725
41726
41727
41728
41729 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41730 .cindex SRS "sender rewriting scheme"
41731
41732 .new
41733 SRS can be used to modify sender addresses when forwarding so that
41734 SPF verification does not object to them.
41735 It operates by encoding the original envelope sender in a new
41736 sender local part and using a domain run by the forwarding site
41737 as the new domain for the sender.  Any DSN message should be returned
41738 to this new sender at the forwarding site, which can extract the
41739 original sender from the coded local part and forward the DSN to
41740 the originator.
41741
41742 This is a way of avoiding the breakage that SPF does to forwarding.
41743 The constructed local-part will be longer than the original,
41744 leading to possible problems with very long addresses.
41745 The changing of the sender address also hinders the tracing of mail
41746 problems.
41747
41748 Exim can be built to include native SRS support.  To do this
41749 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41750 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41751 will be defined.
41752 The support is limited to SRS0-encoding; SRS1 is not supported.
41753
41754 .cindex SRS excoding
41755 To encode an address use this expansion item:
41756 .vlist
41757 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41758 .cindex "&%srs_encode%& expansion item"
41759 .cindex SRS "expansion item"
41760 The first argument should be a secret known and used by all systems
41761 handling the recipient domain for the original message.
41762 There is no need to periodically change this key; a timestamp is also
41763 encoded.
41764 The second argument should be given as the envelope sender address before this
41765 encoding operation.
41766 The third argument should be the recipient domain of the message when
41767 it arrived at this system.
41768 .endlist
41769
41770 .cindex SRS decoding
41771 To decode an address use this expansion condition:
41772 .vlist
41773 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41774 The first argument should be the recipient local prt as is was received.
41775 The second argument is the site secret.
41776
41777 If the messages is not for an SRS-encoded recipient the condition will
41778 return false.  If it is, the condition will return true and the variable
41779 &$srs_recipient$& will be set to the decoded (original) value.
41780 .endlist
41781
41782 Example usage:
41783 .code
41784   #macro
41785   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41786
41787   #routers
41788
41789   outbound:
41790     driver =    dnslookup
41791     # if outbound, and forwarding has been done, use an alternate transport
41792     domains =   ! +my_domains
41793     transport = ${if eq {$local_part@$domain} \
41794                         {$original_local_part@$original_domain} \
41795                      {remote_smtp} {remote_forwarded_smtp}}
41796
41797   inbound_srs:
41798     driver =    redirect
41799     senders =   :
41800     domains =   +my_domains
41801     # detect inbound bounces which are SRS'd, and decode them
41802     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41803     data =      $srs_recipient
41804
41805   inbound_srs_failure:
41806     driver =    redirect
41807     senders =   :
41808     domains =   +my_domains
41809     # detect inbound bounces which look SRS'd but are invalid
41810     condition = ${if inbound_srs {$local_part} {}}
41811     allow_fail
41812     data =      :fail: Invalid SRS recipient address
41813
41814   #... further routers here
41815
41816
41817   # transport; should look like the non-forward outbound
41818   # one, plus the max_rcpt and return_path options
41819   remote_forwarded_smtp:
41820     driver =              smtp
41821     # modify the envelope from, for mails that we forward
41822     max_rcpt =            1
41823     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41824 .endd
41825
41826
41827 .wen
41828
41829
41830
41831 .section DMARC SECDMARC
41832 .cindex DMARC verification
41833
41834 DMARC combines feedback from SPF, DKIM, and header From: in order
41835 to attempt to provide better indicators of the authenticity of an
41836 email.  This document does not explain the fundamentals; you
41837 should read and understand how it works by visiting the website at
41838 &url(http://www.dmarc.org/).
41839
41840 If Exim is built with DMARC support,
41841 the libopendmarc library is used.
41842
41843 For building Exim yourself, obtain the library from
41844 &url(http://sourceforge.net/projects/opendmarc/)
41845 to obtain a copy, or find it in your favorite package
41846 repository.  You will need to attend to the local/Makefile feature
41847 SUPPORT_DMARC and the associated LDFLAGS addition.
41848 This description assumes
41849 that headers will be in /usr/local/include, and that the libraries
41850 are in /usr/local/lib.
41851
41852 . subsection
41853
41854 There are three main-configuration options:
41855 .cindex DMARC "configuration options"
41856
41857 The &%dmarc_tld_file%& option
41858 .oindex &%dmarc_tld_file%&
41859 defines the location of a text file of valid
41860 top level domains the opendmarc library uses
41861 during domain parsing. Maintained by Mozilla,
41862 the most current version can be downloaded
41863 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41864 See also the util/renew-opendmarc-tlds.sh script.
41865 The default for the option is unset.
41866 If not set, DMARC processing is disabled.
41867
41868
41869 The &%dmarc_history_file%& option, if set
41870 .oindex &%dmarc_history_file%&
41871 defines the location of a file to log results
41872 of dmarc verification on inbound emails. The
41873 contents are importable by the opendmarc tools
41874 which will manage the data, send out DMARC
41875 reports, and expire the data. Make sure the
41876 directory of this file is writable by the user
41877 exim runs as.
41878 The default is unset.
41879
41880 The &%dmarc_forensic_sender%& option
41881 .oindex &%dmarc_forensic_sender%&
41882 defines an alternate email address to use when sending a
41883 forensic report detailing alignment failures
41884 if a sender domain's dmarc record specifies it
41885 and you have configured Exim to send them.
41886 If set, this is expanded and used for the
41887 From: header line; the address is extracted
41888 from it and used for the envelope from.
41889 If not set (the default), the From: header is expanded from
41890 the dsn_from option, and <> is used for the
41891 envelope from.
41892
41893 . I wish we had subsections...
41894
41895 .cindex DMARC controls
41896 By default, the DMARC processing will run for any remote,
41897 non-authenticated user.  It makes sense to only verify DMARC
41898 status of messages coming from remote, untrusted sources.  You can
41899 use standard conditions such as hosts, senders, etc, to decide that
41900 DMARC verification should *not* be performed for them and disable
41901 DMARC with an ACL control modifier:
41902 .code
41903   control = dmarc_disable_verify
41904 .endd
41905 A DMARC record can also specify a "forensic address", which gives
41906 exim an email address to submit reports about failed alignment.
41907 Exim does not do this by default because in certain conditions it
41908 results in unintended information leakage (what lists a user might
41909 be subscribed to, etc).  You must configure exim to submit forensic
41910 reports to the owner of the domain.  If the DMARC record contains a
41911 forensic address and you specify the control statement below, then
41912 exim will send these forensic emails.  It is also advised that you
41913 configure a &%dmarc_forensic_sender%& because the default sender address
41914 construction might be inadequate.
41915 .code
41916   control = dmarc_enable_forensic
41917 .endd
41918 (AGAIN: You can choose not to send these forensic reports by simply
41919 not putting the dmarc_enable_forensic control line at any point in
41920 your exim config.  If you don't tell exim to send them, it will not
41921 send them.)
41922
41923 There are no options to either control.  Both must appear before
41924 the DATA acl.
41925
41926 . subsection
41927
41928 DMARC checks cam be run on incoming SMTP  messages by using the
41929 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41930 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41931 condition.  Putting this condition in the ACLs is required in order
41932 for a DMARC check to actually occur.  All of the variables are set
41933 up before the DATA ACL, but there is no actual DMARC check that
41934 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41935
41936 The &"dmarc_status"& condition takes a list of strings on its
41937 right-hand side.  These strings describe recommended action based
41938 on the DMARC check.  To understand what the policy recommendations
41939 mean, refer to the DMARC website above.  Valid strings are:
41940 .display
41941 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41942 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41943 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41944 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41945 &'norecord    '& No policy section in the DMARC record for this RFC5322.From field
41946 &'nofrom      '& Unable to determine the domain of the sender.
41947 &'temperror   '& Library error or dns error.
41948 &'off         '& The DMARC check was disabled for this email.
41949 .endd
41950 You can prefix each string with an exclamation mark to invert its
41951 meaning, for example "!accept" will match all results but
41952 "accept".  The string list is evaluated left-to-right in a
41953 short-circuit fashion.  When a string matches the outcome of the
41954 DMARC check, the condition succeeds.  If none of the listed
41955 strings matches the outcome of the DMARC check, the condition
41956 fails.
41957
41958 Of course, you can also use any other lookup method that Exim
41959 supports, including LDAP, Postgres, MySQL, etc, as long as the
41960 result is a list of colon-separated strings.
41961
41962 Performing the check sets up information used by the
41963 &%authresults%& expansion item.
41964
41965 Several expansion variables are set before the DATA ACL is
41966 processed, and you can use them in this ACL.  The following
41967 expansion variables are available:
41968
41969 .vlist
41970 .vitem &$dmarc_status$&
41971 .vindex &$dmarc_status$&
41972 .cindex DMARC result
41973 A one word status indicating what the DMARC library
41974 thinks of the email.  It is a combination of the results of
41975 DMARC record lookup and the SPF/DKIM/DMARC processing results
41976 (if a DMARC record was found).  The actual policy declared
41977 in the DMARC record is in a separate expansion variable.
41978
41979 .vitem &$dmarc_status_text$&
41980 .vindex &$dmarc_status_text$&
41981 Slightly longer, human readable status.
41982
41983 .vitem &$dmarc_used_domain$&
41984 .vindex &$dmarc_used_domain$&
41985 The domain which DMARC used to look up the DMARC policy record.
41986
41987 .vitem &$dmarc_domain_policy$&
41988 .vindex &$dmarc_domain_policy$&
41989 The policy declared in the DMARC record.  Valid values
41990 are "none", "reject" and "quarantine".  It is blank when there
41991 is any error, including no DMARC record.
41992 .endlist
41993
41994 . subsection
41995
41996 By default, Exim's DMARC configuration is intended to be
41997 non-intrusive and conservative.  To facilitate this, Exim will not
41998 create any type of logging files without explicit configuration by
41999 you, the admin.  Nor will Exim send out any emails/reports about
42000 DMARC issues without explicit configuration by you, the admin (other
42001 than typical bounce messages that may come about due to ACL
42002 processing or failure delivery issues).
42003
42004 In order to log statistics suitable to be imported by the opendmarc
42005 tools, you need to:
42006 .ilist
42007 Configure the global option &%dmarc_history_file%&
42008 .next
42009 Configure cron jobs to call the appropriate opendmarc history
42010 import scripts and truncating the dmarc_history_file
42011 .endlist
42012
42013 In order to send forensic reports, you need to:
42014 .ilist
42015 Configure the global option &%dmarc_forensic_sender%&
42016 .next
42017 Configure, somewhere before the DATA ACL, the control option to
42018 enable sending DMARC forensic reports
42019 .endlist
42020
42021 . subsection
42022
42023 Example usage:
42024 .code
42025 (RCPT ACL)
42026   warn    domains        = +local_domains
42027           hosts          = +local_hosts
42028           control        = dmarc_disable_verify
42029
42030   warn    !domains       = +screwed_up_dmarc_records
42031           control        = dmarc_enable_forensic
42032
42033   warn    condition      = (lookup if destined to mailing list)
42034           set acl_m_mailing_list = 1
42035
42036 (DATA ACL)
42037   warn    dmarc_status   = accept : none : off
42038           !authenticated = *
42039           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
42040
42041   warn    dmarc_status   = !accept
42042           !authenticated = *
42043           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
42044
42045   warn    dmarc_status   = quarantine
42046           !authenticated = *
42047           set $acl_m_quarantine = 1
42048           # Do something in a transport with this flag variable
42049
42050   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
42051           condition      = ${if eq{$acl_m_mailing_list}{1}}
42052           message        = Messages from $dmarc_used_domain break mailing lists
42053
42054   deny    dmarc_status   = reject
42055           !authenticated = *
42056           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
42057
42058   warn    add_header     = :at_start:${authresults {$primary_hostname}}
42059 .endd
42060
42061
42062
42063
42064
42065 . ////////////////////////////////////////////////////////////////////////////
42066 . ////////////////////////////////////////////////////////////////////////////
42067
42068 .chapter "Proxies" "CHAPproxies" &&&
42069          "Proxy support"
42070 .cindex "proxy support"
42071 .cindex "proxy" "access via"
42072
42073 A proxy is an intermediate system through which communication is passed.
42074 Proxies may provide a security, availability or load-distribution function.
42075
42076
42077 .section "Inbound proxies" SECTproxyInbound
42078 .cindex proxy inbound
42079 .cindex proxy "server side"
42080 .cindex proxy "Proxy protocol"
42081 .cindex "Proxy protocol" proxy
42082
42083 Exim has support for receiving inbound SMTP connections via a proxy
42084 that uses &"Proxy Protocol"& to speak to it.
42085 To include this support, include &"SUPPORT_PROXY=yes"&
42086 in Local/Makefile.
42087
42088 It was built on the HAProxy specification, found at
42089 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
42090
42091 The purpose of this facility is so that an application load balancer,
42092 such as HAProxy, can sit in front of several Exim servers
42093 to distribute load.
42094 Exim uses the local protocol communication with the proxy to obtain
42095 the remote SMTP system IP address and port information.
42096 There is no logging if a host passes or
42097 fails Proxy Protocol negotiation, but it can easily be determined and
42098 recorded in an ACL (example is below).
42099
42100 Use of a proxy is enabled by setting the &%hosts_proxy%&
42101 main configuration option to a hostlist; connections from these
42102 hosts will use Proxy Protocol.
42103 Exim supports both version 1 and version 2 of the Proxy Protocol and
42104 automatically determines which version is in use.
42105
42106 The Proxy Protocol header is the first data received on a TCP connection
42107 and is inserted before any TLS-on-connect handshake from the client; Exim
42108 negotiates TLS between Exim-as-server and the remote client, not between
42109 Exim and the proxy server. The Proxy Protocol header must be received
42110 within &%proxy_protocol_timeout%&, which defaults to 3s.
42111
42112 The following expansion variables are usable
42113 (&"internal"& and &"external"& here refer to the interfaces
42114 of the proxy):
42115 .display
42116 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
42117 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
42118 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
42119 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
42120 &'proxy_session            '& boolean: SMTP connection via proxy
42121 .endd
42122 If &$proxy_session$& is set but &$proxy_external_address$& is empty
42123 there was a protocol error.
42124 The variables &$sender_host_address$& and &$sender_host_port$&
42125 will have values for the actual client system, not the proxy.
42126
42127 Since the real connections are all coming from the proxy, and the
42128 per host connection tracking is done before Proxy Protocol is
42129 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
42130 handle all of the parallel volume you expect per inbound proxy.
42131 With the option set so high, you lose the ability
42132 to protect your server from many connections from one IP.
42133 In order to prevent your server from overload, you
42134 need to add a per connection ratelimit to your connect ACL.
42135 A possible solution is:
42136 .display
42137   # Set max number of connections per host
42138   LIMIT   = 5
42139   # Or do some kind of IP lookup in a flat file or database
42140   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
42141
42142   defer   ratelimit      = LIMIT / 5s / per_conn / strict
42143           message        = Too many connections from this IP right now
42144 .endd
42145
42146
42147
42148 .section "Outbound proxies" SECTproxySOCKS
42149 .cindex proxy outbound
42150 .cindex proxy "client side"
42151 .cindex proxy SOCKS
42152 .cindex SOCKS proxy
42153 Exim has support for sending outbound SMTP via a proxy
42154 using a protocol called SOCKS5 (defined by RFC1928).
42155 The support can be optionally included by defining SUPPORT_SOCKS=yes in
42156 Local/Makefile.
42157
42158 Use of a proxy is enabled by setting the &%socks_proxy%& option
42159 on an smtp transport.
42160 The option value is expanded and should then be a list
42161 (colon-separated by default) of proxy specifiers.
42162 Each proxy specifier is a list
42163 (space-separated by default) where the initial element
42164 is an IP address and any subsequent elements are options.
42165
42166 Options are a string <name>=<value>.
42167 The list of options is in the following table:
42168 .display
42169 &'auth   '& authentication method
42170 &'name   '& authentication username
42171 &'pass   '& authentication password
42172 &'port   '& tcp port
42173 &'tmo    '& connection timeout
42174 &'pri    '& priority
42175 &'weight '& selection bias
42176 .endd
42177
42178 More details on each of these options follows:
42179
42180 .ilist
42181 .cindex authentication "to proxy"
42182 .cindex proxy authentication
42183 &%auth%&: Either &"none"& (default) or &"name"&.
42184 Using &"name"& selects username/password authentication per RFC 1929
42185 for access to the proxy.
42186 Default is &"none"&.
42187 .next
42188 &%name%&: sets the username for the &"name"& authentication method.
42189 Default is empty.
42190 .next
42191 &%pass%&: sets the password for the &"name"& authentication method.
42192 Default is empty.
42193 .next
42194 &%port%&: the TCP port number to use for the connection to the proxy.
42195 Default is 1080.
42196 .next
42197 &%tmo%&: sets a connection timeout in seconds for this proxy.
42198 Default is 5.
42199 .next
42200 &%pri%&: specifies a priority for the proxy within the list,
42201 higher values being tried first.
42202 The default priority is 1.
42203 .next
42204 &%weight%&: specifies a selection bias.
42205 Within a priority set servers are queried in a random fashion,
42206 weighted by this value.
42207 The default value for selection bias is 1.
42208 .endlist
42209
42210 Proxies from the list are tried according to their priority
42211 and weight settings until one responds.  The timeout for the
42212 overall connection applies to the set of proxied attempts.
42213
42214 .section Logging SECTproxyLog
42215 To log the (local) IP of a proxy in the incoming or delivery logline,
42216 add &"+proxy"& to the &%log_selector%& option.
42217 This will add a component tagged with &"PRX="& to the line.
42218
42219 . ////////////////////////////////////////////////////////////////////////////
42220 . ////////////////////////////////////////////////////////////////////////////
42221
42222 .chapter "Internationalisation" "CHAPi18n" &&&
42223          "Internationalisation""
42224 .cindex internationalisation "email address"
42225 .cindex EAI
42226 .cindex i18n
42227 .cindex utf8 "mail name handling"
42228
42229 Exim has support for Internationalised mail names.
42230 To include this it must be built with SUPPORT_I18N and the libidn library.
42231 Standards supported are RFCs 2060, 5890, 6530 and 6533.
42232
42233 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
42234 instead of it) then IDNA2008 is supported; this adds an extra library
42235 requirement, upon libidn2.
42236
42237 .section "MTA operations" SECTi18nMTA
42238 .cindex SMTPUTF8 "ESMTP option"
42239 .cindex "ESMTP extensions" SMTPUTF8
42240 The main configuration option &%smtputf8_advertise_hosts%& specifies
42241 a host list.  If this matches the sending host and
42242 accept_8bitmime is true (the default) then the ESMTP option
42243 SMTPUTF8 will be advertised.
42244
42245 If the sender specifies the SMTPUTF8 option on a MAIL command
42246 international handling for the message is enabled and
42247 the expansion variable &$message_smtputf8$& will have value TRUE.
42248
42249 The option &%allow_utf8_domains%& is set to true for this
42250 message. All DNS lookups are converted to a-label form
42251 whatever the setting of &%allow_utf8_domains%&
42252 when Exim is built with SUPPORT_I18N.
42253
42254 Both localparts and domain are maintained as the original
42255 UTF-8 form internally; any comparison or regular-expression use will
42256 require appropriate care.  Filenames created, eg. by
42257 the appendfile transport, will have UTF-8 names.
42258
42259 HELO names sent by the smtp transport will have any UTF-8
42260 components expanded to a-label form,
42261 and any certificate name checks will be done using the a-label
42262 form of the name.
42263
42264 .cindex log protocol
42265 .cindex SMTPUTF8 logging
42266 .cindex i18n logging
42267 Log lines and Received-by: header lines will acquire a "utf8"
42268 prefix on the protocol element, eg. utf8esmtp.
42269
42270 The following expansion operators can be used:
42271 .code
42272 ${utf8_domain_to_alabel:str}
42273 ${utf8_domain_from_alabel:str}
42274 ${utf8_localpart_to_alabel:str}
42275 ${utf8_localpart_from_alabel:str}
42276 .endd
42277
42278 .cindex utf8 "address downconversion"
42279 .cindex i18n "utf8 address downconversion"
42280 The RCPT ACL
42281 may use the following modifier:
42282 .display
42283 control = utf8_downconvert
42284 control = utf8_downconvert/<value>
42285 .endd
42286 This sets a flag requiring that envelope addresses are converted to
42287 a-label form before smtp delivery.
42288 This is usually for use in a Message Submission Agent context,
42289 but could be used for any message.
42290
42291 If a value is appended it may be:
42292 .display
42293 &`1  `& mandatory downconversion
42294 &`0  `& no downconversion
42295 &`-1 `& if SMTPUTF8 not supported by destination host
42296 .endd
42297 If no value is given, 1 is used.
42298
42299 If mua_wrapper is set, the utf8_downconvert control
42300 is initially set to -1.
42301
42302 The smtp transport has an option &%utf8_downconvert%&.
42303 If set it must expand to one of the three values described above,
42304 or an empty string.
42305 If non-empty it overrides value previously set
42306 (due to mua_wrapper or by an ACL control).
42307
42308
42309 There is no explicit support for VRFY and EXPN.
42310 Configurations supporting these should inspect
42311 &$smtp_command_argument$& for an SMTPUTF8 argument.
42312
42313 There is no support for LMTP on Unix sockets.
42314 Using the "lmtp" protocol option on an smtp transport,
42315 for LMTP over TCP, should work as expected.
42316
42317 There is no support for DSN unitext handling,
42318 and no provision for converting logging from or to UTF-8.
42319
42320
42321
42322 .section "MDA operations" SECTi18nMDA
42323 To aid in constructing names suitable for IMAP folders
42324 the following expansion operator can be used:
42325 .code
42326 ${imapfolder {<string>} {<sep>} {<specials>}}
42327 .endd
42328
42329 The string is converted from the charset specified by
42330 the "headers charset" command (in a filter file)
42331 or &%headers_charset%& main configuration option (otherwise),
42332 to the
42333 modified UTF-7 encoding specified by RFC 2060,
42334 with the following exception: All occurrences of <sep>
42335 (which has to be a single character)
42336 are replaced with periods ("."), and all periods and slashes that are not
42337 <sep> and are not in the <specials> string are BASE64 encoded.
42338
42339 The third argument can be omitted, defaulting to an empty string.
42340 The second argument can be omitted, defaulting to "/".
42341
42342 This is the encoding used by Courier for Maildir names on disk, and followed
42343 by many other IMAP servers.
42344
42345 Examples:
42346 .display
42347 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
42348 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
42349 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
42350 .endd
42351
42352 Note that the source charset setting is vital, and also that characters
42353 must be representable in UTF-16.
42354
42355
42356 . ////////////////////////////////////////////////////////////////////////////
42357 . ////////////////////////////////////////////////////////////////////////////
42358
42359 .chapter "Events" "CHAPevents" &&&
42360          "Events"
42361 .cindex events
42362
42363 The events mechanism in Exim can be used to intercept processing at a number
42364 of points.  It was originally invented to give a way to do customised logging
42365 actions (for example, to a database) but can also be used to modify some
42366 processing actions.
42367
42368 Most installations will never need to use Events.
42369 The support can be left out of a build by defining DISABLE_EVENT=yes
42370 in &_Local/Makefile_&.
42371
42372 There are two major classes of events: main and transport.
42373 The main configuration option &%event_action%& controls reception events;
42374 a transport option &%event_action%& controls delivery events.
42375
42376 Both options are a string which is expanded when the event fires.
42377 An example might look like:
42378 .cindex logging custom
42379 .code
42380 event_action = ${if eq {msg:delivery}{$event_name} \
42381 {${lookup pgsql {SELECT * FROM record_Delivery( \
42382     '${quote_pgsql:$sender_address_domain}',\
42383     '${quote_pgsql:${lc:$sender_address_local_part}}', \
42384     '${quote_pgsql:$domain}', \
42385     '${quote_pgsql:${lc:$local_part}}', \
42386     '${quote_pgsql:$host_address}', \
42387     '${quote_pgsql:${lc:$host}}', \
42388     '${quote_pgsql:$message_exim_id}')}} \
42389 } {}}
42390 .endd
42391
42392 Events have names which correspond to the point in process at which they fire.
42393 The name is placed in the variable &$event_name$& and the event action
42394 expansion must check this, as it will be called for every possible event type.
42395
42396 The current list of events is:
42397 .display
42398 &`dane:fail              after    transport  `& per connection
42399 &`msg:complete           after    main       `& per message
42400 &`msg:defer              after    transport  `& per message per delivery try
42401 &`msg:delivery           after    transport  `& per recipient
42402 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
42403 &`msg:rcpt:defer         after    transport  `& per recipient
42404 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
42405 &`msg:fail:delivery      after    transport  `& per recipient
42406 &`msg:fail:internal      after    main       `& per recipient
42407 &`tcp:connect            before   transport  `& per connection
42408 &`tcp:close              after    transport  `& per connection
42409 &`tls:cert               before   both       `& per certificate in verification chain
42410 &`smtp:connect           after    transport  `& per connection
42411 &`smtp:ehlo              after    transport  `& per connection
42412 .endd
42413 New event types may be added in future.
42414
42415 The event name is a colon-separated list, defining the type of
42416 event in a tree of possibilities.  It may be used as a list
42417 or just matched on as a whole.  There will be no spaces in the name.
42418
42419 The second column in the table above describes whether the event fires
42420 before or after the action is associates with.  Those which fire before
42421 can be used to affect that action (more on this below).
42422
42423 The third column in the table above says what section of the configuration
42424 should define the event action.
42425
42426 An additional variable, &$event_data$&, is filled with information varying
42427 with the event type:
42428 .display
42429 &`dane:fail            `& failure reason
42430 &`msg:defer            `& error string
42431 &`msg:delivery         `& smtp confirmation message
42432 &`msg:fail:internal    `& failure reason
42433 &`msg:fail:delivery    `& smtp error message
42434 &`msg:host:defer       `& error string
42435 &`msg:rcpt:host:defer  `& error string
42436 &`msg:rcpt:defer       `& error string
42437 &`tls:cert             `& verification chain depth
42438 &`smtp:connect         `& smtp banner
42439 &`smtp:ehlo            `& smtp ehlo response
42440 .endd
42441
42442 The :defer events populate one extra variable: &$event_defer_errno$&.
42443
42444 For complex operations an ACL expansion can be used in &%event_action%&
42445 however due to the multiple contexts that Exim operates in during
42446 the course of its processing:
42447 .ilist
42448 variables set in transport events will not be visible outside that
42449 transport call
42450 .next
42451 acl_m variables in a server context are lost on a new connection,
42452 and after smtp helo/ehlo/mail/starttls/rset commands
42453 .endlist
42454 Using an ACL expansion with the logwrite modifier can be
42455 a useful way of writing to the main log.
42456
42457 The expansion of the event_action option should normally
42458 return an empty string.  Should it return anything else the
42459 following will be forced:
42460 .display
42461 &`tcp:connect      `&  do not connect
42462 &`tls:cert         `&  refuse verification
42463 &`smtp:connect     `&  close connection
42464 .endd
42465 All other message types ignore the result string, and
42466 no other use is made of it.
42467
42468 For a tcp:connect event, if the connection is being made to a proxy
42469 then the address and port variables will be that of the proxy and not
42470 the target system.
42471
42472 For tls:cert events, if GnuTLS is in use this will trigger only per
42473 chain element received on the connection.
42474 For OpenSSL it will trigger for every chain element including those
42475 loaded locally.
42476
42477 . ////////////////////////////////////////////////////////////////////////////
42478 . ////////////////////////////////////////////////////////////////////////////
42479
42480 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42481          "Adding drivers or lookups"
42482 .cindex "adding drivers"
42483 .cindex "new drivers, adding"
42484 .cindex "drivers" "adding new"
42485 The following actions have to be taken in order to add a new router, transport,
42486 authenticator, or lookup type to Exim:
42487
42488 .olist
42489 Choose a name for the driver or lookup type that does not conflict with any
42490 existing name; I will use &"newdriver"& in what follows.
42491 .next
42492 Add to &_src/EDITME_& the line:
42493 .display
42494 <&'type'&>&`_NEWDRIVER=yes`&
42495 .endd
42496 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42497 code is not to be included in the binary by default, comment this line out. You
42498 should also add any relevant comments about the driver or lookup type.
42499 .next
42500 Add to &_src/config.h.defaults_& the line:
42501 .code
42502 #define <type>_NEWDRIVER
42503 .endd
42504 .next
42505 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42506 and create a table entry as is done for all the other drivers and lookup types.
42507 .next
42508 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42509 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42510 Add your &`NEWDRIVER`& to that list.
42511 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42512 simple form that most lookups have.
42513 .next
42514 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42515 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42516 driver or lookup type and add it to the definition of OBJ.
42517 .next
42518 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42519 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42520 .next
42521 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42522 &_src_&.
42523 .next
42524 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42525 as for other drivers and lookups.
42526 .endlist
42527
42528 Then all you need to do is write the code! A good way to start is to make a
42529 proforma by copying an existing module of the same type, globally changing all
42530 occurrences of the name, and cutting out most of the code. Note that any
42531 options you create must be listed in alphabetical order, because the tables are
42532 searched using a binary chop procedure.
42533
42534 There is a &_README_& file in each of the sub-directories of &_src_& describing
42535 the interface that is expected.
42536
42537
42538
42539
42540 . ////////////////////////////////////////////////////////////////////////////
42541 . ////////////////////////////////////////////////////////////////////////////
42542
42543 . /////////////////////////////////////////////////////////////////////////////
42544 . These lines are processing instructions for the Simple DocBook Processor that
42545 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42546 . PDFs than using xmlto and fop. They will be ignored by all other XML
42547 . processors.
42548 . /////////////////////////////////////////////////////////////////////////////
42549
42550 .literal xml
42551 <?sdop
42552   format="newpage"
42553   foot_right_recto="&chaptertitle;"
42554   foot_right_verso="&chaptertitle;"
42555 ?>
42556 .literal off
42557
42558 .makeindex "Options index"   "option"
42559 .makeindex "Variables index" "variable"
42560 .makeindex "Concept index"   "concept"
42561
42562
42563 . /////////////////////////////////////////////////////////////////////////////
42564 . /////////////////////////////////////////////////////////////////////////////